git.iko.soy/distributed-process
on master help sign in
49 files changed+2471−1306
since splitsnapshots
unifiedsplit
.travis.yml+31−21 ChangeLog+100 REPOS−5 benchmarks/Channels.hs+6−4 benchmarks/Latency.hs+7−4 benchmarks/ProcessRing.hs+3−2 benchmarks/Spawns.hs+6−4 benchmarks/Throughput.hs+6−4 distributed-process-tests/REPOS−5 distributed-process-tests/Setup.hs+2 distributed-process-tests/distributed-process-tests.cabal+47−32 distributed-process-tests/src/Control/Distributed/Process/Tests/CH.hs+538−257 distributed-process-tests/src/Control/Distributed/Process/Tests/Closure.hs+89−48 distributed-process-tests/src/Control/Distributed/Process/Tests/Internal/Utils.hs+16−5 distributed-process-tests/src/Control/Distributed/Process/Tests/Mx.hs+385−129 distributed-process-tests/src/Control/Distributed/Process/Tests/Receive.hs+8−12 distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hs+11−7 distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hs+113−8 distributed-process-tests/tests/runInMemory.hs−1 distributed-process-tests/tests/runTCP.hs+10−3 distributed-process.cabal+51−37 src/Control/Distributed/Process.hs+42−12 src/Control/Distributed/Process/Debug.hs+10−14 src/Control/Distributed/Process/Internal/BiMultiMap.hs+135 src/Control/Distributed/Process/Internal/CQueue.hs+31−2 src/Control/Distributed/Process/Internal/Closure/Explicit.hs+1−2 src/Control/Distributed/Process/Internal/Closure/TH.hs+15−7 src/Control/Distributed/Process/Internal/Messaging.hs+2−2 src/Control/Distributed/Process/Internal/Primitives.hs+187−102 src/Control/Distributed/Process/Internal/Spawn.hs+3−3 src/Control/Distributed/Process/Internal/StrictMVar.hs+8−4 src/Control/Distributed/Process/Internal/Types.hs+52−4 src/Control/Distributed/Process/Internal/WeakTQueue.hs+7−2 src/Control/Distributed/Process/Management.hs+41−83 src/Control/Distributed/Process/Management/Internal/Agent.hs+2−1 src/Control/Distributed/Process/Management/Internal/Table.hs−222 src/Control/Distributed/Process/Management/Internal/Trace/Primitives.hs+10−3 src/Control/Distributed/Process/Management/Internal/Trace/Tracer.hs+7−4 src/Control/Distributed/Process/Management/Internal/Trace/Types.hs−10 src/Control/Distributed/Process/Management/Internal/Types.hs+9−19 src/Control/Distributed/Process/Node.hs+232−175 src/Control/Distributed/Process/Serializable.hs+6−18 src/Control/Distributed/Process/UnsafePrimitives.hs+109−29 stack-ghc-7.10.3.yaml+21 stack-ghc-8.0.2.yaml+23 stack-ghc-8.2.2.yaml+21 stack-ghc-8.4.4.yaml+20 stack-nightly.yaml+26 stack.yaml+22
.travis.yml+31−21
@@ -4,30 +4,40 @@ sudo: false
44
55matrix:
66 include:
7− - env: CABALVER=1.22 GHCVER=7.4.1
8− addons: {apt: {packages: [cabal-install-1.22,ghc-7.4.1], sources: [hvr-ghc]}}
9− - env: CABALVER=1.22 GHCVER=7.6.3
10− addons: {apt: {packages: [cabal-install-1.22,ghc-7.6.3], sources: [hvr-ghc]}}
11− - env: CABALVER=1.22 GHCVER=7.8.4
12− addons: {apt: {packages: [cabal-install-1.22,ghc-7.8.4], sources: [hvr-ghc]}}
13− - env: CABALVER=1.22 GHCVER=7.10.2
14− addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.2],sources: [hvr-ghc]}}
7+ - env: ARGS="--stack-yaml stack-ghc-7.10.3.yaml"
8+ addons: {apt: {packages: [libgmp-dev]}}
9+ - env: ARGS="--stack-yaml stack-ghc-8.2.2.yaml"
10+ addons: {apt: {packages: [libgmp-dev]}}
11+ - env: ARGS="--stack-yaml stack-ghc-8.4.4.yaml"
12+ addons: {apt: {packages: [libgmp-dev]}}
13+ - env: ARGS="--stack-yaml stack-nightly.yaml --resolver nightly"
14+ addons: {apt: {packages: [libgmp-dev]}}
15+
16+cache:
17+ directories:
18+ - $HOME/.stack
1519
1620before_install:
17− - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:~/.cabal/bin:$PATH
18− - ghc --version
19− - cabal --version
20− - cabal update
21− # workaround for https://ghc.haskell.org/trac/ghc/ticket/9221
22− # taken from https://github.com/hvr/multi-ghc-travis/blob/0fa68f78c2b1b059f904c9abc85510a3bb4f57e2/README.md
23− - sed -i 's/^jobs:/-- jobs:/' $HOME/.cabal/config
24− - cabal sandbox init
25− - for i in `cat REPOS`; do git clone http://github.com/haskell-distributed/$i; done
26− - for i in `cat REPOS`; do cabal sandbox add-source $i; done
21+- export PATH=$HOME/.local/bin:$PATH;
22+ mkdir -p ~/.local/bin;
23+ travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack';
24+ stack --version
2725
2826install:
29− - cabal install --only-dependencies --jobs=2
27+- stack $ARGS setup --no-terminal;
28+ stack $ARGS build --no-terminal --only-snapshot --test --no-run-tests;
3029
3130script:
32− - cabal configure
33− - cabal build --jobs=2
31+- export ARG='--test-arguments'
32+ export TEST_PACKAGE="distributed-process-tests:"
33+- stack ${ARGS} test $ARG='--plain -t "!Flaky"' ${TEST_PACKAGE}TestCHInMemory
34+- stack ${ARGS} test $ARG='--plain -t "!Flaky"' ${TEST_PACKAGE}TestCHInTCP
35+- stack ${ARGS} test $ARG='--plain -t "!SpawnReconnect"' ${TEST_PACKAGE}TestClosure
36+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestStats
37+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestMxInMemory
38+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestMxInTCP
39+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestTracingInMemory
40+
41+notifications:
42+ slack:
43+ secure: LbqbNjK1KiHNiQo/i/Za4vkMD9l9mhmN+PWYFBQkNvGFWffSRayRKFrTqt4znV2p7h4dY1XZFoC7T5RemBVQLq2ppZAUWxkITeu1OUlnmVLDfJLeVYGTR/fn90nP6Y5ITE7T3A07nKmWaRbKpIgFBAOjzgqaM0csscDx3z0WW18=
ChangeLog+100
@@ -1,3 +1,103 @@
1+[Unrealeased]
2+
3+*
4+
5+2018-06-12 Facundo Domínguez <facundo.dominguez@tweag.io> 0.7.4
6+
7+* Added support for exceptions >= 0.10
8+
9+2017-08-31 Facundo Domínguez <facundo.dominguez@tweag.io> 0.7.3
10+
11+* Drop support for ghc-7.8.* and earlier.
12+
13+2017-08-31 Facundo Domínguez <facundo.dominguez@tweag.io> 0.7.2
14+
15+* Fixed build errors with ghc-8.2.1.
16+
17+2017-08-22 Facundo Domínguez <facundo.dominguez@tweag.io> 0.7.1
18+
19+* Relax upper bounds in dependencies to build with ghc-8.2.1.
20+
21+2017-08-21 Facundo Domínguez <facundo.dominguez@tweag.io> 0.7.0
22+
23+* Change type of message sent by `say` from a 3-tuple to a proper
24+type (`SayMessage`) with a proper `UTCTime`. (#291)
25+* Expose the MonitorRef in the withMonitor call.
26+* Have unmonitor remove the monitor message in the inbox. (#268)
27+* Remove Mx Data Tables. This API isn't used, is easy to replace with various
28+other packages. (#276)
29+* Add Ord instance to SpawnRef.
30+
31+2016-10-13 Facundo Domínguez <facundo.dominguez@tweag.io> 0.6.6
32+
33+* Remove monitors from remote nodes when a process dies. (#295)
34+
35+2016-10-12 Facundo Domínguez <facundo.dominguez@tweag.io> 0.6.5
36+
37+* Use only one connection to communicate between NCs. (#296, #297)
38+* Improve documentation of CQueue.
39+* Implement bidirectional multimaps for links and monitors. (#293, #294)
40+* Fix various warnings. (#292)
41+* Fix some of the intermittent failures in tests.
42+* Improve error messages when node controllers receive invalid requests.
43+(#290)
44+
45+2016-06-09 Facundo Domínguez <facundo.dominguez@tweag.io> 0.6.4
46+
47+* Fixup build errors.
48+
49+2016-06-09 Facundo Domínguez <facundo.dominguez@tweag.io> 0.6.3
50+
51+* Relax template-haskell upper bound.
52+
53+2016-06-09 Facundo Domínguez <facundo.dominguez@tweag.io> 0.6.2
54+
55+* Provide compatibility with ghc-8.0.1
56+* Remove dependency on ghc-prim.
57+* Don't throw exceptions asynchronously.
58+* Bump upper bounds of dependencies.
59+* Fix exception handling in callLocal.
60+* Have spawnLocal inherit the masking state of the caller.
61+* Have nsend send unencoded messages to local processes.
62+
63+2016-03-03 Facundo Domínguez <facundo.dominguez@tweag.io> 0.6.1
64+
65+* Implement MonadCatch, MonadThrow, MonadMask for Process.
66+
67+2016-02-18 Facundo Domínguez <facundo.dominguez@tweag.io> 0.6.0
68+
69+* Have nsendRemote skip the transport for local communication.
70+* Unsafe primitives for usend and nsendRemote.
71+* Stop using the transport for local communication.
72+* Skip the transport for whereisRemoteAsync and registerRemoteAsync.
73+* Have nsendRemote skip the transport for local communication.
74+* Have runProcess forward exceptions.
75+* Reimport distributed-process-tests. d-p and d-p-test now can be kept in
76+sync.
77+* Add a stack.yaml file for building tests and d-p all at once conveniently.
78+* Implement unreliable forward (uforward).
79+* Add Functor instance for Match data type
80+* Have `spawnAsync` not use the transport in the local case.
81+* Fix monitor race in 'call'.
82+* Add compatibility with ghc-7.10: support new typeable, loosen deps, write
83+proper NFData instances, support new TH.
84+* Kill processes on a local node upon closeLocalNode.
85+* Fix getNodeStats function, see DP-97
86+* Return size of the queue in ProcessInfo.
87+* Implement unreliable send (usend).
88+* Implement MonadFix instance for Process.
89+* Introduce callLocal primitive.
90+* Prevent message loss due to timeouts in CQueue.
91+* More informative ProcessRegistrationException. Now includes the identifier
92+of the process that owns the name, if any.
93+* Avoid message loop between threads when tracing received messages.
94+
95+2015-06-15 Facundo Domínguez <facundo.dominguez@tweag.io> 0.5.5
96+
97+* Fix dependencies.
98+* Add compatibility with GHC-7.10.
99+* Fix various race conditions (DP-99, DP-103).
100+
11012014-12-09 Tim Watson <watson.timothy@gmail.com> 0.5.2
2102
3103* Fix docstring for `register`
REPOSdeleted−5
@@ -1,5 +0,0 @@
1−distributed-process-tests
2−distributed-static
3−network-transport
4−network-transport-tcp
5−rank1dynamic
benchmarks/Channels.hs+6−4
@@ -4,7 +4,7 @@ import Control.Monad
44import Control.Applicative
55import Control.Distributed.Process
66import Control.Distributed.Process.Node
7−import Network.Transport.TCP (createTransport, defaultTCPParameters)
7+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
88import Data.Binary (encode, decode)
99import qualified Data.ByteString.Lazy as BSL
1010
@@ -36,6 +36,8 @@ initialProcess "CLIENT" = do
3636main :: IO ()
3737main = do
3838 [role, host, port] <- getArgs
39− Right transport <- createTransport host port defaultTCPParameters
40− node <- newLocalNode transport initRemoteTable
41− runProcess node $ initialProcess role
39+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
40+ case trans of
41+ Right transport -> do node <- newLocalNode transport initRemoteTable
42+ runProcess node $ initialProcess role
43+ Left other -> error $ show other
benchmarks/Latency.hs+7−4
@@ -3,7 +3,7 @@ import Control.Monad
33import Control.Applicative
44import Control.Distributed.Process
55import Control.Distributed.Process.Node
6−import Network.Transport.TCP (createTransport, defaultTCPParameters)
6+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
77import Data.Binary (encode, decode)
88import qualified Data.ByteString.Lazy as BSL
99
@@ -31,6 +31,9 @@ initialProcess "CLIENT" = do
3131main :: IO ()
3232main = do
3333 [role, host, port] <- getArgs
34− Right transport <- createTransport host port defaultTCPParameters
35− node <- newLocalNode transport initRemoteTable
36− runProcess node $ initialProcess role
34+ trans <- createTransport
35+ (defaultTCPAddr host port) defaultTCPParameters
36+ case trans of
37+ Right transport -> do node <- newLocalNode transport initRemoteTable
38+ runProcess node $ initialProcess role
39+ Left other -> error $ show other
benchmarks/ProcessRing.hs+3−2
@@ -12,7 +12,7 @@ import Control.Monad
1212import Control.Distributed.Process hiding (catch)
1313import Control.Distributed.Process.Node
1414import Control.Exception (catch, SomeException)
15−import Network.Transport.TCP (createTransport, defaultTCPParameters)
15+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
1616import System.Environment
1717import System.Console.GetOpt
1818
@@ -110,7 +110,8 @@ main = do
110110 argv <- getArgs
111111 (opt, _) <- parseArgv argv
112112 putStrLn $ "options: " ++ (show opt)
113− Right transport <- createTransport "127.0.0.1" "8090" defaultTCPParameters
113+ Right transport <- createTransport
114+ (defaultTCPAddr "127.0.0.1" "8090" ) defaultTCPParameters
114115 node <- newLocalNode transport initRemoteTable
115116 catch (void $ runProcess node $ initialProcess opt)
116117 (\(e :: SomeException) -> putStrLn $ "ERROR: " ++ (show e))
benchmarks/Spawns.hs+6−4
@@ -7,7 +7,7 @@ import Control.Monad
77import Control.Applicative
88import Control.Distributed.Process
99import Control.Distributed.Process.Node
10−import Network.Transport.TCP (createTransport, defaultTCPParameters)
10+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
1111import Data.Binary (encode, decode)
1212import qualified Data.ByteString.Lazy as BSL
1313
@@ -42,6 +42,8 @@ initialProcess "CLIENT" = do
4242main :: IO ()
4343main = do
4444 [role, host, port] <- getArgs
45− Right transport <- createTransport host port defaultTCPParameters
46− node <- newLocalNode transport initRemoteTable
47− runProcess node $ initialProcess role
45+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
46+ case trans of
47+ Right transport -> do node <- newLocalNode transport initRemoteTable
48+ runProcess node $ initialProcess role
49+ Left other -> error $ show other
benchmarks/Throughput.hs+6−4
@@ -6,7 +6,7 @@ import Control.Monad
66import Control.Applicative
77import Control.Distributed.Process
88import Control.Distributed.Process.Node
9−import Network.Transport.TCP (createTransport, defaultTCPParameters)
9+import Network.Transport.TCP (createTransport, defaultTCPParameters, defaultTCPAddr)
1010import Data.Binary
1111import qualified Data.ByteString.Lazy as BSL
1212import Data.Typeable
@@ -67,6 +67,8 @@ initialProcess "CLIENT" = do
6767main :: IO ()
6868main = do
6969 [role, host, port] <- getArgs
70− Right transport <- createTransport host port defaultTCPParameters
71− node <- newLocalNode transport initRemoteTable
72− runProcess node $ initialProcess role
70+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
71+ case trans of
72+ Right transport -> do node <- newLocalNode transport initRemoteTable
73+ runProcess node $ initialProcess role
74+ Left other -> error $ show other
distributed-process-tests/REPOSdeleted−5
@@ -1,5 +0,0 @@
1−rank1dynamic
2−distributed-static
3−network-transport
4−network-transport-tcp
5−distributed-process
distributed-process-tests/Setup.hsnew file+2
@@ -0,0 +1,2 @@
1+import Distribution.Simple
2+main = defaultMain
distributed-process-tests/distributed-process-tests.cabal+47−32
@@ -1,11 +1,12 @@
11name: distributed-process-tests
2−version: 0.4.2
2+version: 0.4.11
33synopsis: Tests and test support tools for distributed-process.
4−homepage: http://github.com/haskell-distributed/distributed-process-tests
4+homepage: http://github.com/haskell-distributed/distributed-process/tree/master/distributed-process-tests
5+description: Tests and test suite for Cloud Haskell libraries.
56license: BSD3
67license-file: LICENSE
78Author: Duncan Coutts, Nicolas Wu, Edsko de Vries
8−Maintainer: watson.timothy@gmail.com, edsko@well-typed.com, duncan@well-typed.com
9+Maintainer: Tim Watson <watson.timothy@gmail.com>
910copyright: Well-Typed LLP
1011category: Control, Cloud Haskell
1112build-type: Simple
@@ -25,16 +26,18 @@ library
2526 Control.Distributed.Process.Tests.Tracing
2627 Control.Distributed.Process.Tests.Internal.Utils
2728 Build-Depends: base >= 4.4 && < 5,
28− ansi-terminal >= 0.5 && < 0.7,
29− binary >= 0.5 && < 0.8,
30− bytestring >= 0.9 && < 0.11,
31− distributed-process >= 0.5.3 && < 0.6,
29+ ansi-terminal >= 0.5,
30+ binary >= 0.5 && < 0.9,
31+ bytestring >= 0.9 && < 0.12,
32+ distributed-process >= 0.6.0 && < 0.8,
3233 distributed-static,
33− HUnit >= 1.2 && < 1.4,
34− network-transport >= 0.4.1.0 && < 0.5,
35− network >= 2.5 && < 2.7,
34+ exceptions >= 0.5,
35+ HUnit >= 1.2 && < 1.7,
36+ network-transport >= 0.4.1.0 && < 0.6,
37+ network >= 2.5 && < 2.9,
3638 random >= 1.0 && < 1.2,
3739 rematch >= 0.1.2.1,
40+ setenv >= 0.1.1.3,
3841 test-framework >= 0.6 && < 0.9,
3942 test-framework-hunit >= 0.2.0 && < 0.4,
4043 stm
@@ -46,7 +49,6 @@ library
4649 DeriveDataTypeable,
4750 DeriveGeneric,
4851 GeneralizedNewtypeDeriving,
49− OverlappingInstances,
5052 RankNTypes,
5153 RecordWildCards,
5254 ScopedTypeVariables
@@ -59,12 +61,12 @@ Test-Suite TestCHInMemory
5961 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.CH
6062 Build-Depends: base >= 4.4 && < 5,
6163 distributed-process-tests,
62− network >= 2.3 && < 2.7,
63− network-transport >= 0.4.1.0 && < 0.5,
64+ network >= 2.3 && < 2.9,
65+ network-transport >= 0.4.1.0 && < 0.6,
6466 network-transport-inmemory >= 0.5,
6567 test-framework >= 0.6 && < 0.9
6668 Extensions: CPP
67− ghc-options: -Wall -threaded -debug -eventlog -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
69+ ghc-options: -Wall -threaded -eventlog -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
6870 HS-Source-Dirs: tests
6971
7072Test-Suite TestCHInTCP
@@ -74,14 +76,14 @@ Test-Suite TestCHInTCP
7476 if flag(tcp)
7577 Build-Depends: base >= 4.4 && < 5,
7678 distributed-process-tests,
77− network >= 2.3 && < 2.7,
78− network-transport >= 0.4.1.0 && < 0.5,
79− network-transport-tcp >= 0.3 && < 0.5,
79+ network >= 2.3 && < 2.9,
80+ network-transport >= 0.4.1.0 && < 0.6,
81+ network-transport-tcp >= 0.5 && < 0.7,
8082 test-framework >= 0.6 && < 0.9
8183 else
8284 Buildable: False
8385 Extensions: CPP
84− ghc-options: -Wall -threaded -debug -eventlog -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
86+ ghc-options: -Wall -threaded -eventlog -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
8587 HS-Source-Dirs: tests
8688
8789
@@ -91,8 +93,8 @@ Test-Suite TestClosure
9193 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Closure
9294 Build-Depends: base >= 4.4 && < 5,
9395 distributed-process-tests,
94− network >= 2.3 && < 2.7,
95− network-transport >= 0.4.1.0 && < 0.5,
96+ network >= 2.3 && < 2.9,
97+ network-transport >= 0.4.1.0 && < 0.6,
9698 network-transport-inmemory >= 0.5,
9799 test-framework >= 0.6 && < 0.9
98100 Extensions: CPP
@@ -105,39 +107,52 @@ Test-Suite TestStats
105107 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Stats
106108 Build-Depends: base >= 4.4 && < 5,
107109 distributed-process-tests,
108− network >= 2.3 && < 2.7,
109− network-transport >= 0.4.1.0 && < 0.5,
110+ network >= 2.3 && < 2.9,
111+ network-transport >= 0.4.1.0 && < 0.6,
110112 network-transport-inmemory >= 0.5,
111113 test-framework >= 0.6 && < 0.9
112114 Extensions: CPP
113− ghc-options: -Wall -debug -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
115+ ghc-options: -Wall -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
114116 HS-Source-Dirs: tests
115117
116−
117−Test-Suite TestMx
118+Test-Suite TestMxInMemory
118119 Type: exitcode-stdio-1.0
119120 Main-Is: runInMemory.hs
120121 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Mx
121122 Build-Depends: base >= 4.4 && < 5,
122123 distributed-process-tests,
123− network >= 2.3 && < 2.7,
124− network-transport >= 0.4.1.0 && < 0.5,
124+ network >= 2.3 && < 2.9,
125+ network-transport >= 0.4.1.0 && < 0.6,
125126 network-transport-inmemory >= 0.5,
126127 test-framework >= 0.6 && < 0.9
127128 Extensions: CPP
128− ghc-options: -Wall -debug -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
129+ ghc-options: -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
129130 HS-Source-Dirs: tests
130131
131−Test-Suite TestTracing
132+Test-Suite TestTracingInMemory
132133 Type: exitcode-stdio-1.0
133134 Main-Is: runInMemory.hs
134135 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Tracing
135136 Build-Depends: base >= 4.4 && < 5,
136137 distributed-process-tests,
137− network >= 2.3 && < 2.7,
138− network-transport >= 0.4.1.0 && < 0.5,
138+ network >= 2.3 && < 2.9,
139+ network-transport >= 0.4.1.0 && < 0.6,
140+ network-transport-inmemory >= 0.5,
141+ test-framework >= 0.6 && < 0.9
142+ Extensions: CPP
143+ ghc-options: -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
144+ HS-Source-Dirs: tests
145+
146+Test-Suite TestMxInTCP
147+ Type: exitcode-stdio-1.0
148+ Main-Is: runInMemory.hs
149+ CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Mx
150+ Build-Depends: base >= 4.4 && < 5,
151+ distributed-process-tests,
152+ network >= 2.3 && < 2.9,
153+ network-transport >= 0.4.1.0 && < 0.6,
139154 network-transport-inmemory >= 0.5,
140155 test-framework >= 0.6 && < 0.9
141156 Extensions: CPP
142− ghc-options: -Wall -debug -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
157+ ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
143158 HS-Source-Dirs: tests
distributed-process-tests/src/Control/Distributed/Process/Tests/CH.hs+538−257
@@ -9,6 +9,7 @@ import Network.Transport.Test (TestTransport(..))
99import Data.Binary (Binary(..))
1010import Data.Typeable (Typeable)
1111import Data.Foldable (forM_)
12+import Data.Function (fix)
1213import Data.IORef
1314 ( readIORef
1415 , writeIORef
@@ -24,24 +25,32 @@ import Control.Concurrent.MVar
2425 )
2526import Control.Monad (replicateM_, replicateM, forever, void, unless, join)
2627import Control.Exception (SomeException, throwIO, ErrorCall(..))
27−import qualified Control.Exception as Ex (catch)
28−import Control.Applicative ((<$>), (<*>), pure, (<|>))
28+import Control.Monad.Catch (try, catch, finally, mask, onException)
29+import Control.Applicative ((<|>))
2930import qualified Network.Transport as NT (closeEndPoint, EndPointAddress)
30−import Control.Distributed.Process
31+import Control.Distributed.Process hiding
32+ ( try
33+ , catch
34+ , finally
35+ , mask
36+ , onException
37+ )
3138import Control.Distributed.Process.Internal.Types
32− ( NodeId(nodeAddress)
33− , LocalNode(localEndPoint)
39+ ( LocalNode(localEndPoint)
3440 , ProcessExitException(..)
3541 , nullProcessId
3642 , createUnencodedMessage
3743 )
3844import Control.Distributed.Process.Node
45+import Control.Distributed.Process.Debug
46+import Control.Distributed.Process.Management.Internal.Types
47+import Control.Distributed.Process.Tests.Internal.Utils (shouldBe, pause)
3948import Control.Distributed.Process.Serializable (Serializable)
40−
41−import Test.HUnit (Assertion, assertFailure)
49+import Data.Maybe (isNothing, isJust)
50+import Test.HUnit (Assertion, assertBool, assertFailure)
4251import Test.Framework (Test, testGroup)
4352import Test.Framework.Providers.HUnit (testCase)
44−import Control.Rematch hiding (match)
53+import Control.Rematch hiding (match, isNothing, isJust)
4554import Control.Rematch.Run (Match(..))
4655
4756newtype Ping = Ping ProcessId
@@ -64,7 +73,7 @@ expectThat a matcher = case res of
6473forkTry :: IO () -> IO ThreadId
6574forkTry p = do
6675 tid <- myThreadId
67− forkIO $ Ex.catch p (\e -> throwTo tid (e :: SomeException))
76+ forkIO $ catch p (\e -> throwTo tid (e :: SomeException))
6877
6978-- | The ping server from the paper
7079ping :: Process ()
@@ -74,12 +83,46 @@ ping = do
7483 send partner (Ping self)
7584 ping
7685
86+verifyClient :: String -> MVar Bool -> IO ()
87+verifyClient s b = takeMVar b >>= assertBool s
88+
89+expectPing :: MVar Bool -> Process ()
90+expectPing mv = expect >>= liftIO . putMVar mv . checkPing
91+ where
92+ checkPing (Ping _) = True
93+
7794-- | Quick and dirty synchronous version of whereisRemoteAsync
7895whereisRemote :: NodeId -> String -> Process (Maybe ProcessId)
7996whereisRemote nid string = do
8097 whereisRemoteAsync nid string
81− WhereIsReply _ mPid <- expect
82− return mPid
98+ receiveWait [
99+ match (\(WhereIsReply _ mPid) -> return mPid)
100+ ]
101+
102+verifyWhereIsRemote :: NodeId -> String -> Process ProcessId
103+verifyWhereIsRemote n s = whereisRemote n s >>= maybe (die "remote name not found") return
104+
105+waitForExit :: ProcessId -> Process DiedReason
106+waitForExit pid = monitor pid >>= waitForDown
107+
108+waitForDown :: MonitorRef -> Process DiedReason
109+waitForDown ref =
110+ receiveWait [ matchIf (\(ProcessMonitorNotification ref' _ _) -> ref == ref')
111+ (\(ProcessMonitorNotification _ _ dr) -> return dr) ]
112+
113+syncBreakConnection :: (NT.EndPointAddress -> NT.EndPointAddress -> IO ()) -> LocalNode -> LocalNode -> IO ()
114+syncBreakConnection breakConnection nid0 nid1 = do
115+ m <- newEmptyMVar
116+ _ <- forkProcess nid1 $ getSelfPid >>= liftIO . putMVar m
117+ runProcess nid0 $ do
118+ them <- liftIO $ takeMVar m
119+ pinger <- spawnLocal $ forever $ send them ()
120+ _ <- monitorNode (localNodeId nid1)
121+ liftIO $ breakConnection (nodeAddress $ localNodeId nid0)
122+ (nodeAddress $ localNodeId nid1)
123+ NodeMonitorNotification _ _ _ <- expect
124+ kill pinger "finished"
125+ return ()
83126
84127data Add = Add ProcessId Double Double deriving (Typeable)
85128data Divide = Divide ProcessId Double Double deriving (Typeable)
@@ -154,12 +197,18 @@ monitorTestProcess theirAddr mOrL un reason monitorSetup done =
154197 unmonitor ref
155198 liftIO $ putMVar done ()
156199 (False, ref) -> do
157− ProcessMonitorNotification ref' pid reason' <- expect
158− True <- return $ Just ref' == ref && pid == theirAddr && mOrL && reason == reason'
159− liftIO $ putMVar done ()
200+ receiveWait [
201+ match (\(ProcessMonitorNotification ref' pid reason') -> do
202+ liftIO $ do
203+ assertBool "Bad Monitor Signal"
204+ (Just ref' == ref && pid == theirAddr &&
205+ mOrL && reason == reason')
206+ putMVar done ())
207+ ]
160208 )
161209 (\(ProcessLinkException pid reason') -> do
162− True <- return $ pid == theirAddr && not mOrL && not un && reason == reason'
210+ (liftIO $ assertBool "link exception unmatched" $
211+ pid == theirAddr && not mOrL && not un && reason == reason')
163212 liftIO $ putMVar done ()
164213 )
165214
@@ -190,8 +239,10 @@ testPing TestTransport{..} = do
190239 pid <- getSelfPid
191240 replicateM_ numPings $ do
192241 send pingServer (Pong pid)
193− Ping _ <- expect
194− return ()
242+ p <- expectTimeout 3000000
243+ case p of
244+ Just (Ping _) -> return ()
245+ Nothing -> die "Failed to receive Ping"
195246
196247 putMVar clientDone ()
197248
@@ -278,7 +329,7 @@ testMonitorLocalDeadProcess TestTransport{..} mOrL un = do
278329 runProcess localNode $ do
279330 monitor theirAddr
280331 -- wait for the process to die
281− ProcessMonitorNotification _ _ _ <- expect
332+ expect :: Process ProcessMonitorNotification
282333 monitorTestProcess theirAddr mOrL un DiedUnknownId Nothing done
283334
284335 takeMVar done
@@ -352,14 +403,17 @@ testMath TestTransport{..} = do
352403 runProcess localNode $ do
353404 pid <- getSelfPid
354405 send mathServer (Add pid 1 2)
355− 3 <- expect :: Process Double
406+ three <- expect :: Process Double
356407 send mathServer (Divide pid 8 2)
357− 4 <- expect :: Process Double
408+ four <- expect :: Process Double
358409 send mathServer (Divide pid 8 0)
359− DivByZero <- expect
360− liftIO $ putMVar clientDone ()
410+ divByZ <- expect
411+ liftIO $ putMVar clientDone (three, four, divByZ)
361412
362− takeMVar clientDone
413+ res <- takeMVar clientDone
414+ case res of
415+ (3, 4, DivByZero) -> return ()
416+ _ -> error $ "Something went horribly wrong"
363417
364418-- | Send first message (i.e. connect) to an already terminated process
365419-- (without monitoring); then send another message to a second process on
@@ -387,11 +441,9 @@ testSendToTerminated TestTransport{..} = do
387441 pid <- getSelfPid
388442 send server1 "Hi"
389443 send server2 (Pong pid)
390− Ping pid' <- expect
391− True <- return $ pid' == server2
392− liftIO $ putMVar clientDone ()
444+ expectPing clientDone
393445
394− takeMVar clientDone
446+ verifyClient "Expected Ping from server" clientDone
395447
396448-- | Test (non-zero) timeout
397449testTimeout :: TestTransport -> Assertion
@@ -400,26 +452,24 @@ testTimeout TestTransport{..} = do
400452 done <- newEmptyMVar
401453
402454 runProcess localNode $ do
403− Nothing <- receiveTimeout 1000000 [match (\(Add _ _ _) -> return ())]
404− liftIO $ putMVar done ()
455+ res <- receiveTimeout 1000000 [match (\Add{} -> return ())]
456+ liftIO $ putMVar done $ res == Nothing
405457
406− takeMVar done
458+ verifyClient "Expected receiveTimeout to timeout..." done
407459
408460-- | Test zero timeout
409461testTimeout0 :: TestTransport -> Assertion
410462testTimeout0 TestTransport{..} = do
411463 serverAddr <- newEmptyMVar
412464 clientDone <- newEmptyMVar
413− messagesSent <- newEmptyMVar
414465
415466 forkIO $ do
416467 localNode <- newLocalNode testTransport initRemoteTable
417468 addr <- forkProcess localNode $ do
418− liftIO $ readMVar messagesSent >> threadDelay 1000000
419469 -- Variation on the venerable ping server which uses a zero timeout
420− -- Since we wait for all messages to be sent before doing this receive,
421− -- we should nevertheless find the right message immediately
422− Just partner <- receiveTimeout 0 [match (\(Pong partner) -> return partner)]
470+ partner <- fix $ \loop ->
471+ receiveTimeout 0 [match (\(Pong partner) -> return partner)]
472+ >>= maybe (liftIO (threadDelay 100000) >> loop) return
423473 self <- getSelfPid
424474 send partner (Ping self)
425475 putMVar serverAddr addr
@@ -433,11 +483,9 @@ testTimeout0 TestTransport{..} = do
433483 -- is not interested in, and then a single message that it wants
434484 replicateM_ 10000 $ send server "Irrelevant message"
435485 send server (Pong pid)
436− liftIO $ putMVar messagesSent ()
437− Ping _ <- expect
438− liftIO $ putMVar clientDone ()
486+ expectPing clientDone
439487
440− takeMVar clientDone
488+ verifyClient "Expected Ping from server" clientDone
441489
442490-- | Test typed channels
443491testTypedChannels :: TestTransport -> Assertion
@@ -460,10 +508,10 @@ testTypedChannels TestTransport{..} = do
460508 runProcess localNode $ do
461509 (clientSendPort, rport) <- newChan
462510 sendChan serverSendPort (clientSendPort, 5)
463− False <- receiveChan rport
464− liftIO $ putMVar clientDone ()
511+ ch <- receiveChan rport
512+ liftIO $ putMVar clientDone $ ch == False
465513
466− takeMVar clientDone
514+ verifyClient "Expected channel to send 'False'" clientDone
467515
468516-- | Test merging receive ports
469517testMergeChannels :: TestTransport -> Assertion
@@ -486,9 +534,8 @@ testMergeChannels TestTransport{..} = do
486534 rs <- mapM charChannel "abc"
487535 m <- mergePorts biased rs
488536 xs <- replicateM 9 $ receiveChan m
489− True <- return $ xs == expected
490− liftIO $ putMVar done ()
491− takeMVar done
537+ liftIO $ putMVar done $ xs == expected
538+ verifyClient "Expected single layer merge to match expected ordering" done
492539
493540 -- Two layers of merging
494541 testNested :: LocalNode -> Bool -> Bool -> String -> IO ()
@@ -499,9 +546,8 @@ testMergeChannels TestTransport{..} = do
499546 ms <- mapM (mergePorts biasedInner) rss
500547 m <- mergePorts biasedOuter ms
501548 xs <- replicateM (9 * 3) $ receiveChan m
502− True <- return $ xs == expected
503− liftIO $ putMVar done ()
504− takeMVar done
549+ liftIO $ putMVar done $ xs == expected
550+ verifyClient "Expected nested channels to match expeted ordering" done
505551
506552 -- Test that if no messages are (immediately) available, the scheduler makes no difference
507553 testBlocked :: LocalNode -> Bool -> IO ()
@@ -510,43 +556,45 @@ testMergeChannels TestTransport{..} = do
510556 done <- newEmptyMVar
511557
512558 forkProcess localNode $ do
513− [sa, sb, sc] <- liftIO $ mapM readMVar vs
514− mapM_ ((>> liftIO (threadDelay 10000)) . uncurry sendChan)
515− [ -- a, b, c
516− (sa, 'a')
517− , (sb, 'b')
518− , (sc, 'c')
519− -- a, c, b
520− , (sa, 'a')
521− , (sc, 'c')
522− , (sb, 'b')
523− -- b, a, c
524− , (sb, 'b')
525− , (sa, 'a')
526− , (sc, 'c')
527− -- b, c, a
528− , (sb, 'b')
529− , (sc, 'c')
530− , (sa, 'a')
531− -- c, a, b
532− , (sc, 'c')
533− , (sa, 'a')
534− , (sb, 'b')
535− -- c, b, a
536− , (sc, 'c')
537− , (sb, 'b')
538− , (sa, 'a')
539− ]
559+ ss <- liftIO $ mapM readMVar vs
560+ case ss of
561+ [sa, sb, sc] ->
562+ mapM_ ((>> pause 10000) . uncurry sendChan)
563+ [ -- a, b, c
564+ (sa, 'a')
565+ , (sb, 'b')
566+ , (sc, 'c')
567+ -- a, c, b
568+ , (sa, 'a')
569+ , (sc, 'c')
570+ , (sb, 'b')
571+ -- b, a, c
572+ , (sb, 'b')
573+ , (sa, 'a')
574+ , (sc, 'c')
575+ -- b, c, a
576+ , (sb, 'b')
577+ , (sc, 'c')
578+ , (sa, 'a')
579+ -- c, a, b
580+ , (sc, 'c')
581+ , (sa, 'a')
582+ , (sb, 'b')
583+ -- c, b, a
584+ , (sc, 'c')
585+ , (sb, 'b')
586+ , (sa, 'a')
587+ ]
588+ _ -> die "Something went horribly wrong"
540589
541590 forkProcess localNode $ do
542591 (ss, rs) <- unzip <$> replicateM 3 newChan
543592 liftIO $ mapM_ (uncurry putMVar) $ zip vs ss
544593 m <- mergePorts biased rs
545594 xs <- replicateM (6 * 3) $ receiveChan m
546− True <- return $ xs == "abcacbbacbcacabcba"
547− liftIO $ putMVar done ()
595+ liftIO $ putMVar done $ xs == "abcacbbacbcacabcba"
548596
549− takeMVar done
597+ verifyClient "Expected merged ports to match expected ordering" done
550598
551599 mergePorts :: Serializable a => Bool -> [ReceivePort a] -> Process (ReceivePort a)
552600 mergePorts True = mergePortsBiased
@@ -562,19 +610,11 @@ testMergeChannels TestTransport{..} = do
562610testTerminate :: TestTransport -> Assertion
563611testTerminate TestTransport{..} = do
564612 localNode <- newLocalNode testTransport initRemoteTable
565− done <- newEmptyMVar
566−
567− pid <- forkProcess localNode $ do
568− liftIO $ threadDelay 100000
569− terminate
570−
571613 runProcess localNode $ do
572− ref <- monitor pid
573− ProcessMonitorNotification ref' pid' (DiedException ex) <- expect
574− True <- return $ ref == ref' && pid == pid' && ex == show ProcessTerminationException
575− liftIO $ putMVar done ()
576−
577− takeMVar done
614+ e <- try terminate :: Process (Either ProcessTerminationException ())
615+ if either show show e == show ProcessTerminationException
616+ then return ()
617+ else die "Unexpected result from terminate"
578618
579619testMonitorNode :: TestTransport -> Assertion
580620testMonitorNode TestTransport{..} = do
@@ -585,11 +625,12 @@ testMonitorNode TestTransport{..} = do
585625
586626 runProcess node2 $ do
587627 ref <- monitorNode (localNodeId node1)
588− NodeMonitorNotification ref' nid DiedDisconnect <- expect
589− True <- return $ ref == ref' && nid == localNodeId node1
590− liftIO $ putMVar done ()
628+ receiveWait [
629+ match (\(NodeMonitorNotification ref' nid DiedDisconnect) ->
630+ return $ ref == ref' && nid == localNodeId node1)
631+ ] >>= liftIO . putMVar done
591632
592− takeMVar done
633+ verifyClient "Expected NodeMonitorNotification with matching ref & nodeId" done
593634
594635testMonitorLiveNode :: TestTransport -> Assertion
595636testMonitorLiveNode TestTransport{..} = do
@@ -604,15 +645,16 @@ testMonitorLiveNode TestTransport{..} = do
604645 liftIO $ putMVar ready ()
605646 liftIO $ takeMVar readyr
606647 send p ()
607− NodeMonitorNotification ref' nid _ <- expect
608− True <- return $ ref == ref' && nid == localNodeId node1
609− liftIO $ putMVar done ()
648+ receiveWait [
649+ match (\(NodeMonitorNotification ref' nid _) ->
650+ (return $ ref == ref' && nid == localNodeId node1))
651+ ] >>= liftIO . putMVar done
610652
611653 takeMVar ready
612654 closeLocalNode node1
613655 putMVar readyr ()
614656
615− takeMVar done
657+ verifyClient "Expected NodeMonitorNotification for LIVE node" done
616658
617659testMonitorChannel :: TestTransport -> Assertion
618660testMonitorChannel TestTransport{..} = do
@@ -622,18 +664,20 @@ testMonitorChannel TestTransport{..} = do
622664 pid <- forkProcess node1 $ do
623665 sport <- expect :: Process (SendPort ())
624666 ref <- monitorPort sport
625− PortMonitorNotification ref' port' reason <- expect
626− -- reason might be DiedUnknownId if the receive port is GCed before the
627− -- monitor is established (TODO: not sure that this is reasonable)
628− return $ ref' == ref && port' == sendPortId sport && (reason == DiedNormal || reason == DiedUnknownId)
629− liftIO $ putMVar gotNotification ()
667+ receiveWait [
668+ -- reason might be DiedUnknownId if the receive port is GCed before the
669+ -- monitor is established (TODO: not sure that this is reasonable)
670+ match (\(PortMonitorNotification ref' port' reason) ->
671+ return $ ref' == ref && port' == sendPortId sport &&
672+ (reason == DiedNormal || reason == DiedUnknownId))
673+ ] >>= liftIO . putMVar gotNotification
630674
631675 runProcess node2 $ do
632676 (sport, _) <- newChan :: Process (SendPort (), ReceivePort ())
633677 send pid sport
634678 liftIO $ threadDelay 100000
635679
636− takeMVar gotNotification
680+ verifyClient "Expected PortMonitorNotification" gotNotification
637681
638682testRegistry :: TestTransport -> Assertion
639683testRegistry TestTransport{..} = do
@@ -645,20 +689,28 @@ testRegistry TestTransport{..} = do
645689
646690 runProcess node $ do
647691 register "ping" pingServer
648− Just pid <- whereis "ping"
649− True <- return $ pingServer == pid
692+ whereis "ping" >>= liftIO . assertBool "Unexpected ping" . (== Just pingServer)
650693 us <- getSelfPid
651694 nsend "ping" (Pong us)
652− Ping pid' <- expect
653− True <- return $ pingServer == pid'
654− Left (ProcessRegistrationException "dead" Nothing) <- try $ register "dead" deadProcess
655− Left (ProcessRegistrationException "ping" (Just x)) <- try $ register "ping" deadProcess
656− True <- return $ x == pingServer
657− Left (ProcessRegistrationException "dead" Nothing) <- try $ unregister "dead"
695+ receiveWait [
696+ matchIf (\(Ping pid') -> pingServer == pid') (const $ return ())
697+ ]
698+ checkRegException "dead" Nothing deadProcess
699+ checkRegException "ping" (Just pingServer) deadProcess
700+ try (unregister "dead") >>= checkReg "dead" Nothing
658701 liftIO $ putMVar done ()
659702
660703 takeMVar done
661704
705+ where
706+ checkRegException name pid dead =
707+ try (register name dead) >>= checkReg name pid
708+
709+ checkReg name pid res =
710+ case res of
711+ Left (ProcessRegistrationException name pid) -> return ()
712+ _ -> die $ "Unexpected Registration" ++ show res
713+
662714testRegistryRemoteProcess :: TestTransport -> Assertion
663715testRegistryRemoteProcess TestTransport{..} = do
664716 node1 <- newLocalNode testTransport initRemoteTable
@@ -669,13 +721,13 @@ testRegistryRemoteProcess TestTransport{..} = do
669721
670722 runProcess node2 $ do
671723 register "ping" pingServer
672− Just pid <- whereis "ping"
673− True <- return $ pingServer == pid
724+ whereis "ping" >>= liftIO . assertBool "Unexpected ping" . (== Just pingServer)
674725 us <- getSelfPid
675726 nsend "ping" (Pong us)
676− Ping pid' <- expect
677− True <- return $ pingServer == pid'
678− liftIO $ putMVar done ()
727+ receiveWait [
728+ matchIf (\(Ping pid') -> pingServer == pid')
729+ (const $ liftIO $ putMVar done ())
730+ ]
679731
680732 takeMVar done
681733
@@ -683,7 +735,6 @@ testRemoteRegistry :: TestTransport -> Assertion
683735testRemoteRegistry TestTransport{..} = do
684736 node1 <- newLocalNode testTransport initRemoteTable
685737 node2 <- newLocalNode testTransport initRemoteTable
686− done <- newEmptyMVar
687738
688739 pingServer <- forkProcess node1 ping
689740 deadProcess <- forkProcess node1 (return ())
@@ -696,32 +747,34 @@ testRemoteRegistry TestTransport{..} = do
696747 "ping" == label' && pid == pingServer)
697748 (\(RegisterReply _ _ _) -> return ()) ]
698749
699− Just pid <- whereisRemote nid1 "ping"
700− True <- return $ pingServer == pid
750+ pid <- verifyWhereIsRemote nid1 "ping"
751+ liftIO $ assertBool "Expected pindServer to match pid" $ pingServer == pid
752+
701753 us <- getSelfPid
702754 nsendRemote nid1 "ping" (Pong us)
703− Ping pid' <- expect
704− True <- return $ pingServer == pid'
755+ receiveWait [
756+ match (\(Ping pid') -> return $ pingServer == pid')
757+ ] >>= liftIO . assertBool "Expected Ping with ping server's ProcessId"
705758
706759 -- test that if process was not registered Nothing is returned
707760 -- in owner field.
708761 registerRemoteAsync nid1 "dead" deadProcess
709− receiveWait [
710− matchIf (\(RegisterReply label' False Nothing) -> "dead" == label')
711− (\(RegisterReply _ _ _) -> return ()) ]
762+ receiveWait [ matchIf (\(RegisterReply label' f mPid) -> "dead" == label')
763+ (\(RegisterReply _ f mPid) -> return (not f && isNothing mPid))
764+ ] >>= liftIO . assertBool "Expected False Nothing in RegisterReply"
765+
712766 registerRemoteAsync nid1 "ping" deadProcess
713767 receiveWait [
714− matchIf (\(RegisterReply label' False (Just pid)) ->
715− "ping" == label' && pid == pingServer)
716− (\(RegisterReply _ _ _) -> return ()) ]
768+ matchIf (\(RegisterReply label' False mPid) ->
769+ "ping" == label' && isJust mPid)
770+ (\(RegisterReply _ f (Just pid'')) -> return (not f && pid'' == pingServer))
771+ ] >>= liftIO . assertBool "Expected False and (Just alreadyRegisteredPid) in RegisterReply"
772+
717773 unregisterRemoteAsync nid1 "dead"
718774 receiveWait [
719− matchIf (\(RegisterReply label' False Nothing) ->
720− "dead" == label' && pid == pingServer)
721− (\(RegisterReply _ _ _) -> return ()) ]
722− liftIO $ putMVar done ()
723−
724− takeMVar done
775+ matchIf (\(RegisterReply label' _ _) -> "dead" == label')
776+ (\(RegisterReply _ f mPid) -> return (not f && isNothing mPid))
777+ ] >>= liftIO . assertBool "Expected False and Nothing in RegisterReply"
725778
726779testRemoteRegistryRemoteProcess :: TestTransport -> Assertion
727780testRemoteRegistryRemoteProcess TestTransport{..} = do
@@ -737,15 +790,15 @@ testRemoteRegistryRemoteProcess TestTransport{..} = do
737790 receiveWait [
738791 matchIf (\(RegisterReply label' _ _) -> "ping" == label')
739792 (\(RegisterReply _ _ _) -> return ()) ]
740− Just pid <- whereisRemote nid1 "ping"
741− True <- return $ pingServer == pid
793+ pid <- verifyWhereIsRemote nid1 "ping"
794+ liftIO $ assertBool "Expected pingServer to match remote name" $ pingServer == pid
742795 us <- getSelfPid
743796 nsendRemote nid1 "ping" (Pong us)
744− Ping pid' <- expect
745− True <- return $ pingServer == pid'
746− liftIO $ putMVar done ()
797+ receiveWait [
798+ match (\(Ping pid') -> return $ pingServer == pid')
799+ ] >>= liftIO . putMVar done
747800
748− takeMVar done
801+ verifyClient "Expected Ping with ping server's ProcessId" done
749802
750803testSpawnLocal :: TestTransport -> Assertion
751804testSpawnLocal TestTransport{..} = do
@@ -759,15 +812,14 @@ testSpawnLocal TestTransport{..} = do
759812 sport <- expect
760813 sendChan sport (1234 :: Int)
761814
762− sport <- spawnChannelLocal $ \rport -> do
763− (1234 :: Int) <- receiveChan rport
764− send us ()
815+ sport <- spawnChannelLocal $
816+ \rport -> (receiveChan rport :: Process Int) >>= send us
765817
766818 send pid sport
767− () <- expect
768− liftIO $ putMVar done ()
819+ expect >>= liftIO . putMVar done
769820
770− takeMVar done
821+ res <- takeMVar done
822+ assertBool "Expected 1234 :: Int" $ res == (1234 :: Int)
771823
772824testSpawnAsyncStrictness :: TestTransport -> Assertion
773825testSpawnAsyncStrictness TestTransport{..} = do
@@ -796,8 +848,9 @@ testReconnect TestTransport{..} = do
796848 liftIO $ putMVar processA us
797849 msg1 <- expect
798850 msg2 <- expect
799− True <- return $ msg1 == "message 1" && msg2 == "message 3"
800− liftIO $ putMVar sendTestOk ()
851+ liftIO $ do
852+ assertBool "messages did not match" $ msg1 == "message 1" && msg2 == "message 3"
853+ putMVar sendTestOk ()
801854
802855 forkProcess node2 $ do
803856 {-
@@ -830,7 +883,7 @@ testReconnect TestTransport{..} = do
830883 matchIf (\(RegisterReply label' _ _) -> "a" == label')
831884 (\(RegisterReply _ _ _) -> return ()) ]
832885
833− Just _ <- whereisRemote nid1 "a"
886+ _ <- whereisRemote nid1 "a"
834887
835888
836889 -- Simulate network failure
@@ -849,9 +902,10 @@ testReconnect TestTransport{..} = do
849902 (\(RegisterReply _ _ _) -> return ()) ]
850903
851904 -- Check
852− Nothing <- whereisRemote nid1 "a" -- this will fail because the name is removed when the node is disconnected
853− Just _ <- whereisRemote nid1 "b" -- this will suceed because the value is set after thereconnect
854− Just _ <- whereisRemote nid1 "c"
905+ mPid <- whereisRemote nid1 "a" -- this will fail because the name is removed when the node is disconnected
906+ liftIO $ assertBool "Expected remote name to be lost" $ mPid == Nothing
907+ verifyWhereIsRemote nid1 "b" -- this will suceed because the value is set after thereconnect
908+ verifyWhereIsRemote nid1 "c"
855909
856910 liftIO $ putMVar registerTestOk ()
857911
@@ -892,19 +946,19 @@ testUSend usendPrim TestTransport{..} numMessages = do
892946 isSorted _ = True
893947 -- The list can't be null since there are no failures after sending
894948 -- the last message.
895− True <- return $ isSorted msgs && not (null msgs)
896− liftIO $ putMVar usendTestOk ()
949+ liftIO $ putMVar usendTestOk $ isSorted msgs && not (null msgs)
897950
898951 forkProcess node2 $ do
899952 them <- liftIO $ readMVar processA
900953 getSelfPid >>= send them
901− () <- expect
954+ expect :: Process ()
902955 forM_ [1..numMessages] $ \i -> do
903956 liftIO $ testBreakConnection (nodeAddress nid1) (nodeAddress nid2)
904957 usendPrim them i
905958 liftIO (threadDelay 30000)
906959
907− takeMVar usendTestOk
960+ res <- takeMVar usendTestOk
961+ assertBool "Unexpected failure after sending last msg" res
908962
909963-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
910964-- in between
@@ -930,14 +984,17 @@ testMatchAny TestTransport{..} = do
930984 runProcess localNode $ do
931985 pid <- getSelfPid
932986 send mathServer (Add pid 1 2)
933− 3 <- expect :: Process Double
987+ three <- expect :: Process Double
934988 send mathServer (Divide pid 8 2)
935− 4 <- expect :: Process Double
989+ four <- expect :: Process Double
936990 send mathServer (Divide pid 8 0)
937− DivByZero <- expect
938− liftIO $ putMVar clientDone ()
991+ divByZ <- expect
992+ liftIO $ putMVar clientDone (three, four, divByZ)
939993
940− takeMVar clientDone
994+ res <- takeMVar clientDone
995+ case res of
996+ (3, 4, DivByZero) -> return ()
997+ _ -> error "Unexpected result"
941998
942999-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
9431000-- in between, however we block 'Divide' requests ....
@@ -964,12 +1021,13 @@ testMatchAnyHandle TestTransport{..} = do
9641021 runProcess localNode $ do
9651022 pid <- getSelfPid
9661023 send mathServer (Add pid 1 2)
967− 3 <- expect :: Process Double
1024+ three <- expect :: Process Double
9681025 send mathServer (Divide pid 8 2)
969− Nothing <- (expectTimeout 100000) :: Process (Maybe Double)
970− liftIO $ putMVar clientDone ()
1026+ res <- (expectTimeout 100000) :: Process (Maybe Double)
1027+ liftIO $ putMVar clientDone $ three == 3 && res == Nothing
1028+
1029+ verifyClient "Expected Nothing (i.e. timeout)" clientDone
9711030
972− takeMVar clientDone
9731031 where maybeForward :: ProcessId -> Message -> Process (Maybe ())
9741032 maybeForward s msg =
9751033 handleMessage msg (\m@(Add _ _ _) -> send s m)
@@ -997,8 +1055,10 @@ testMatchAnyNoHandle TestTransport{..} = do
9971055 Just _ -> die "NONSENSE")
9981056 ]
9991057 -- we *must* have removed the message from our mailbox though!!!
1000− Nothing <- receiveTimeout 100000 [ match (\(Add _ _ _) -> return ()) ]
1001− liftIO $ putMVar serverDone ()
1058+ res <- receiveTimeout 100000 [ match (\(Add _ _ _) -> return ()) ]
1059+ liftIO $ do
1060+ assertBool "Expected timeout!" $ res == Nothing
1061+ putMVar serverDone ()
10021062 putMVar addr server
10031063
10041064 -- Client
@@ -1041,14 +1101,21 @@ testMatchAnyIf TestTransport{..} = do
10411101 runProcess localNode $ do
10421102 pid <- getSelfPid
10431103 send server (pid, "foo")
1044− "foo" <- expect
1045− send server (pid, "baz")
1046− "baz" <- expect
1104+ foo <- expect
1105+ -- provoking what would be the wrong ordering is informative here...
1106+
10471107 send server (pid, "bar")
1048− Nothing <- (expectTimeout 100000) :: Process (Maybe Double)
1049− liftIO $ putMVar clientDone ()
1108+ bar <- (expectTimeout 100000) :: Process (Maybe String) -- was Double o_O !?
1109+
1110+ send server (pid, "baz")
1111+ baz <- expect
1112+
1113+ liftIO $ putMVar clientDone (foo, bar, baz)
1114+
1115+ res <- takeMVar clientDone
1116+ let res' = res == ("foo", Nothing, "baz")
1117+ assertBool "Expected timeout due to type mismatch" res'
10501118
1051− takeMVar clientDone
10521119 where tryHandleMessage :: Message -> Process (Maybe ())
10531120 tryHandleMessage msg =
10541121 handleMessage msg (\(pid :: ProcessId, (m :: String))
@@ -1081,17 +1148,19 @@ testMatchMessageWithUnwrap TestTransport{..} = do
10811148 runProcess localNode $ do
10821149 pid <- getSelfPid
10831150 send server (pid, wrapMessage ("foo" :: String))
1084− "foo" <- expect
1151+ foo <- expect
10851152 send server (pid, wrapMessage ("baz" :: String))
1086− "baz" <- expect
1087− liftIO $ putMVar clientDone ()
1153+ baz <- expect
1154+ liftIO $ putMVar clientDone (foo, baz)
10881155
1089− takeMVar clientDone
1156+ res <- takeMVar clientDone
1157+ assertBool "Unexpected unwrapped results" $ res == ("foo", "baz")
10901158
10911159-- Test 'receiveChanTimeout'
10921160testReceiveChanTimeout :: TestTransport -> Assertion
10931161testReceiveChanTimeout TestTransport{..} = do
10941162 done <- newEmptyMVar
1163+ mvSender <- newEmptyMVar
10951164 sendPort <- newEmptyMVar
10961165
10971166 forkTry $ do
@@ -1101,18 +1170,32 @@ testReceiveChanTimeout TestTransport{..} = do
11011170 (sp, rp) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
11021171 liftIO $ putMVar sendPort sp
11031172
1104− -- Wait for a message with a delay. No message arrives, we should get Nothing after 1 second
1105− Nothing <- receiveChanTimeout 1000000 rp
1173+ -- Wait for a message with a delay. No message arrives, we should get
1174+ -- Nothing after the delay.
1175+ receiveChanTimeout 100000 rp >>= maybe (return ()) (const $ die "Expected Timeout")
1176+
1177+ -- Let the sender know that it can send a message.
1178+ liftIO $ putMVar mvSender ()
1179+
1180+ -- Wait for a message with a delay again. Now a message arrives after
1181+ -- 0.1 seconds
1182+ res <- receiveChanTimeout 20000000 rp >>= maybe (die "Timeout") return
1183+ liftIO $ assertBool "Expected result to be 'True'" res
11061184
1107− -- Wait for a message with a delay again. Now a message arrives after 0.5 seconds
1108− Just True <- receiveChanTimeout 1000000 rp
1185+ -- Wait for a message with zero timeout: non-blocking check. No message is
1186+ -- available, we get Nothing
1187+ receiveChanTimeout 0 rp >>= maybe (return ()) (const $ die "Expected Timeout")
11091188
1110− -- Wait for a message with zero timeout: non-blocking check. No message is available, we get Nothing
1111− Nothing <- receiveChanTimeout 0 rp
1189+ -- Let the sender know that it can send a message.
1190+ liftIO $ putMVar mvSender ()
11121191
11131192 -- Again, but now there is a message available
1114− liftIO $ threadDelay 1000000
1115− Just False <- receiveChanTimeout 0 rp
1193+ fix $ \loop -> do
1194+ liftIO $ threadDelay 100000
1195+ mb <- receiveChanTimeout 0 rp
1196+ case mb of
1197+ Just b -> do liftIO $ assertBool "Unexpected Message" $ not b
1198+ _ -> loop
11161199
11171200 liftIO $ putMVar done ()
11181201
@@ -1121,10 +1204,11 @@ testReceiveChanTimeout TestTransport{..} = do
11211204 runProcess localNode $ do
11221205 sp <- liftIO $ readMVar sendPort
11231206
1124− liftIO $ threadDelay 1500000
1207+ liftIO $ takeMVar mvSender
1208+ liftIO $ threadDelay 100000
11251209 sendChan sp True
11261210
1127− liftIO $ threadDelay 500000
1211+ liftIO $ takeMVar mvSender
11281212 sendChan sp False
11291213
11301214 takeMVar done
@@ -1147,8 +1231,8 @@ testReceiveChanFeatures TestTransport{..} = do
11471231
11481232 rp1 <- mergePortsBiased [even <$> rpInt, rpBool]
11491233
1150− True <- receiveChan rp1
1151− False <- receiveChan rp1
1234+ receiveChan rp1 >>= liftIO . assertBool "Expected True"
1235+ receiveChan rp1 >>= liftIO . assertBool "Expected False" . not
11521236
11531237 -- Test Applicative instance
11541238
@@ -1157,7 +1241,7 @@ testReceiveChanFeatures TestTransport{..} = do
11571241
11581242 let rp2 = pure (+) <*> rpInt <*> rpInt
11591243
1160− 7 <- receiveChan rp2
1244+ receiveChan rp2 >>= liftIO . assertBool "Expected 7" . (== 7)
11611245
11621246 -- Test Alternative instance
11631247
@@ -1166,8 +1250,8 @@ testReceiveChanFeatures TestTransport{..} = do
11661250
11671251 let rp3 = (even <$> rpInt) <|> rpBool
11681252
1169− False <- receiveChan rp3
1170− True <- receiveChan rp3
1253+ receiveChan rp3 >>= liftIO . assertBool "Expected False" . not
1254+ receiveChan rp3 >>= liftIO . assertBool "Expected True"
11711255
11721256 -- Test Monad instance
11731257
@@ -1181,17 +1265,86 @@ testReceiveChanFeatures TestTransport{..} = do
11811265 then rpInt
11821266 else return 7
11831267
1184− 5 <- receiveChan rp4
1185− 7 <- receiveChan rp4
1268+ receiveChan rp4 >>= liftIO . assertBool "Expected 5" . (== 5)
1269+ receiveChan rp4 >>= liftIO . assertBool "Expected 7" . (== 7)
11861270
11871271 liftIO $ putMVar done ()
11881272
11891273 takeMVar done
11901274
1275+testChanLifecycle :: TestTransport -> Assertion
1276+testChanLifecycle TestTransport{..} = let delay = 3000000 in do
1277+ result <- newEmptyMVar
1278+ tchMV <- newEmptyMVar
1279+ localNode <- newLocalNode testTransport initRemoteTable
1280+ runProcess localNode $ do
1281+
1282+ pid <- spawnLocal $ do tCh <- newChan :: Process (SendPort (), ReceivePort ())
1283+ liftIO $ putMVar tchMV tCh
1284+ expect :: Process ()
1285+ let (sp, _) = tCh
1286+ sendChan sp ()
1287+ expect :: Process ()
1288+
1289+ mRefPid <- monitor pid
1290+
1291+ cPid <- spawnLocal $ do
1292+ (sp', rp) <- liftIO $ takeMVar tchMV
1293+ -- say "picked up our test channel"
1294+ send pid ()
1295+ -- say "told pid to continue"
1296+ res <- receiveChanTimeout delay rp
1297+ case res of
1298+ Nothing -> say "initial chan () missing!" >> (liftIO $ putMVar result False)
1299+ Just () -> do mr <- monitor pid
1300+ pause 10000
1301+ -- say "sending pid a second () will cause it to exit"
1302+ send pid ()
1303+
1304+ -- say "make sure we see a DOWN notification for pid having stopped"
1305+ receiveWait [ match (\(_ :: ProcessMonitorNotification) -> return ()) ]
1306+
1307+ -- now that pid has died, the send port should be useless...
1308+ liftIO $ putMVar tchMV (sp', rp)
1309+
1310+ -- let's verify that we do not see the message from our
1311+ -- parent process on the channel, once pid has died...
1312+ recv <- receiveChanTimeout delay rp
1313+ -- say $ "finished waiting for second (), writing result" ++ (show recv)
1314+ liftIO $ putMVar result $ isNothing recv
1315+
1316+ mRefCPid <- monitor cPid
1317+
1318+ receiveWait
1319+ [ matchIf (\(ProcessMonitorNotification r _ _) -> r == mRefPid)
1320+ (\_ -> return ())
1321+ ]
1322+
1323+ -- say "seen first pid die..."
1324+
1325+ (sendPort, _) <- liftIO $ takeMVar tchMV
1326+ sendChan sendPort ()
1327+ -- say "sent () after owning pid died"
1328+
1329+ -- let cPid know we've written to the channel...
1330+ send cPid ()
1331+
1332+ receiveWait
1333+ [ matchIf (\(ProcessMonitorNotification r _ _) -> r == mRefCPid)
1334+ (\_ -> return ())
1335+ ]
1336+
1337+ -- say "seen both pids die now..."
1338+
1339+ -- and wait on the result back in IO land...
1340+ testRes <- takeMVar result
1341+ -- runProcess localNode $ say "got result..."
1342+ assertBool "Expected sending on the channel to fail, but received data!" testRes
1343+
1344+
11911345testKillLocal :: TestTransport -> Assertion
11921346testKillLocal TestTransport{..} = do
11931347 localNode <- newLocalNode testTransport initRemoteTable
1194− done <- newEmptyMVar
11951348
11961349 pid <- forkProcess localNode $ do
11971350 liftIO $ threadDelay 1000000
@@ -1200,17 +1353,18 @@ testKillLocal TestTransport{..} = do
12001353 ref <- monitor pid
12011354 us <- getSelfPid
12021355 kill pid "TestKill"
1203− ProcessMonitorNotification ref' pid' (DiedException ex) <- expect
1204− True <- return $ ref == ref' && pid == pid' && ex == "killed-by=" ++ show us ++ ",reason=TestKill"
1205− liftIO $ putMVar done ()
1206−
1207− takeMVar done
1356+ mn <- expect
1357+ case mn of
1358+ ProcessMonitorNotification ref' pid' (DiedException ex) ->
1359+ case ref == ref' && pid == pid' && ex == "killed-by=" ++ show us ++ ",reason=TestKill" of
1360+ True -> return ()
1361+ False -> die "Invalid ProcessMonitorNotification received"
1362+ _ -> die "Something went horribly wrong"
12081363
12091364testKillRemote :: TestTransport -> Assertion
12101365testKillRemote TestTransport{..} = do
12111366 node1 <- newLocalNode testTransport initRemoteTable
12121367 node2 <- newLocalNode testTransport initRemoteTable
1213− done <- newEmptyMVar
12141368
12151369 pid <- forkProcess node1 $ do
12161370 liftIO $ threadDelay 1000000
@@ -1219,11 +1373,17 @@ testKillRemote TestTransport{..} = do
12191373 ref <- monitor pid
12201374 us <- getSelfPid
12211375 kill pid "TestKill"
1222− ProcessMonitorNotification ref' pid' (DiedException reason) <- expect
1223− True <- return $ ref == ref' && pid == pid' && reason == "killed-by=" ++ show us ++ ",reason=TestKill"
1224− liftIO $ putMVar done ()
1225−
1226− takeMVar done
1376+ mn <- expect
1377+ case mn of
1378+ ProcessMonitorNotification ref' pid' (DiedException reason) ->
1379+ case (ref == ref', pid == pid', reason == "killed-by=" ++ show us ++ ",reason=TestKill") of
1380+ (True, True, True) -> return ()
1381+ (a, b, c) -> do
1382+ let a' = if a then "" else "Invalid ref"
1383+ let b' = if b then "" else "Invalid pid"
1384+ let c' = if c then "" else "Invalid message"
1385+ die $ unwords [a', b', c']
1386+ _ -> die "Received unexpected message"
12271387
12281388testCatchesExit :: TestTransport -> Assertion
12291389testCatchesExit TestTransport{..} = do
@@ -1249,7 +1409,10 @@ testHandleMessageIf TestTransport{..} = do
12491409 self <- getSelfPid
12501410 send self (5 :: Integer, 10 :: Integer)
12511411 msg <- receiveWait [ matchMessage return ]
1252− Nothing <- handleMessageIf msg (\() -> True) (\() -> die $ "whoops")
1412+ handleMessageIf msg
1413+ (\() -> True)
1414+ (\() -> die "whoops") >>= maybe (return ())
1415+ (const $ die "Expected Mismatch")
12531416 handleMessageIf msg (\(x :: Integer, y :: Integer) -> x == 5 && y == 10)
12541417 (\input -> liftIO $ putMVar done input)
12551418 return ()
@@ -1294,8 +1457,11 @@ testDie TestTransport{..} = do
12941457 (die ("foobar", 123 :: Int))
12951458 `catchExit` \_from reason -> do
12961459 -- TODO: should verify that 'from' has the right value
1297− True <- return $ reason == ("foobar", 123 :: Int)
1460+ let res = reason == ("foobar", 123 :: Int)
12981461 liftIO $ putMVar done ()
1462+ if res
1463+ then return ()
1464+ else die "Something went horribly wrong"
12991465
13001466 takeMVar done
13011467
@@ -1309,8 +1475,11 @@ testPrettyExit TestTransport{..} = do
13091475 `catch` \ex@(ProcessExitException from _) ->
13101476 let expected = "exit-from=" ++ (show from)
13111477 in do
1312− True <- return $ (show ex) == expected
1478+ let res = (show ex) == expected
13131479 liftIO $ putMVar done ()
1480+ if res
1481+ then return ()
1482+ else die "Something went horribly wrong"
13141483
13151484 takeMVar done
13161485
@@ -1326,17 +1495,26 @@ testExitLocal TestTransport{..} = do
13261495 pid <- forkProcess localNode $ do
13271496 (liftIO (putMVar handlerSetUp ()) >> expect) `catchExit` \_from reason -> do
13281497 -- TODO: should verify that 'from' has the right value
1329− True <- return $ reason == "TestExit"
1498+ res <- return $ reason == "TestExit"
13301499 liftIO $ putMVar supervisedDone ()
1500+ if res
1501+ then return ()
1502+ else die "Something went horribly wrong"
13311503
13321504 runProcess localNode $ do
13331505 liftIO $ takeMVar handlerSetUp
13341506 ref <- monitor pid
13351507 exit pid "TestExit"
13361508 -- This time the client catches the exception, so it dies normally
1337− ProcessMonitorNotification ref' pid' DiedNormal <- expect
1338− True <- return $ ref == ref' && pid == pid'
1339− liftIO $ putMVar supervisorDone ()
1509+ mn <- expect
1510+ case mn of
1511+ ProcessMonitorNotification ref' pid' DiedNormal -> do
1512+ let res = ref == ref' && pid == pid'
1513+ liftIO $ putMVar supervisorDone ()
1514+ if res
1515+ then return ()
1516+ else die "Something went horribly wrong"
1517+ _ -> die "Something went horribly wrong"
13401518
13411519 takeMVar supervisedDone
13421520 takeMVar supervisorDone
@@ -1352,19 +1530,98 @@ testExitRemote TestTransport{..} = do
13521530 (receiveWait [] :: Process ()) -- block forever
13531531 `catchExit` \_from reason -> do
13541532 -- TODO: should verify that 'from' has the right value
1355− True <- return $ reason == "TestExit"
1533+ res <- return $ reason == "TestExit"
13561534 liftIO $ putMVar supervisedDone ()
1535+ if res
1536+ then return ()
1537+ else die "Something went horribly wrong"
13571538
13581539 runProcess node2 $ do
13591540 ref <- monitor pid
13601541 exit pid "TestExit"
1361− ProcessMonitorNotification ref' pid' DiedNormal <- expect
1362− True <- return $ ref == ref' && pid == pid'
1363− liftIO $ putMVar supervisorDone ()
1542+ mn <- expect
1543+ case mn of
1544+ ProcessMonitorNotification ref' pid' DiedNormal -> do
1545+ res' <- return $ ref == ref' && pid == pid'
1546+ liftIO $ putMVar supervisorDone ()
1547+ if res'
1548+ then return ()
1549+ else die "Something went horribly wrong"
1550+ _ -> die "Something went horribly wrong"
13641551
13651552 takeMVar supervisedDone
13661553 takeMVar supervisorDone
13671554
1555+testRegistryMonitoring :: TestTransport -> Assertion
1556+testRegistryMonitoring TestTransport{..} = do
1557+ node1 <- newLocalNode testTransport initRemoteTable
1558+ node2 <- newLocalNode testTransport initRemoteTable
1559+
1560+ let nid = localNodeId node2
1561+ pid <- forkProcess node1 $ do
1562+ self <- getSelfPid
1563+ runUntilRegistered nid self
1564+ say $ (show self) ++ " registered as " ++ regName
1565+ expect :: Process ()
1566+ say $ (show self) ++ " exiting normally"
1567+
1568+ runProcess node2 $ do
1569+ register regName pid
1570+ say $ regName ++ " registered to " ++ show pid
1571+ res <- whereis regName
1572+ send pid ()
1573+ say $ " sent finish signal to " ++ show pid
1574+ us <- getSelfPid
1575+ liftIO $ assertBool "expected (Just pid)" $ res == (Just pid)
1576+
1577+
1578+ -- This delay isn't essential!
1579+ -- The test case passes perfectly fine without it (feel free to comment out
1580+ -- and see), however waiting a few seconds here, makes it much more likely
1581+ -- that in delayUntilMaybeUnregistered we will hit the match case right
1582+ -- away, and thus not be subjected to a 20 second delay. The value of 4
1583+ -- seconds appears to work optimally on osx and across several linux distros
1584+ -- running in virtual machines (which is essentially what we do in CI)
1585+ void $ receiveTimeout 4000000 [ matchAny return ]
1586+
1587+ -- This delay doesn't serve much purpose in the happy path, however if some
1588+ -- future patch breaks the cooperative behaviour of node controllers viz
1589+ -- remote process registration and notification taking place via ncEffectDied,
1590+ -- there would be the possibility of a race in the test case should we attempt
1591+ -- to evaluate `whereis regName` on node2 right away. In case the name is still
1592+ -- erroneously registered, observing the 20 second delay (or lack of), could at
1593+ -- least give a hint that something is wrong, and we give up our time slice
1594+ -- so that there's a higher change the registrations have been cleaned up
1595+ -- in either case.
1596+ runProcess node2 $ delayUntilMaybeUnregistered nid pid
1597+
1598+ regHere <- newEmptyMVar
1599+ runProcess node2 $ whereis regName >>= liftIO . putMVar regHere
1600+ res <- takeMVar regHere
1601+ case res of
1602+ Nothing -> return ()
1603+ Just pid -> assertBool ("expected Nothing, but got " ++ show pid) False
1604+
1605+ where
1606+ runUntilRegistered nid us = do
1607+ whereisRemoteAsync nid regName
1608+ receiveWait [
1609+ matchIf (\(WhereIsReply n (Just p)) -> n == regName && p == us)
1610+ (const $ return ())
1611+ ]
1612+
1613+ delayUntilMaybeUnregistered nid p = do
1614+ whereisRemoteAsync nid regName
1615+ res <- receiveTimeout 20000000 {- 20 sec delay -} [
1616+ matchIf (\(WhereIsReply n p) -> n == regName && isNothing p)
1617+ (const $ return ())
1618+ ]
1619+ case res of
1620+ Just () -> return ()
1621+ Nothing -> delayUntilMaybeUnregistered nid p
1622+
1623+ regName = "testRegisterRemote"
1624+
13681625testUnsafeSend :: TestTransport -> Assertion
13691626testUnsafeSend TestTransport{..} = do
13701627 serverAddr <- newEmptyMVar
@@ -1380,8 +1637,26 @@ testUnsafeSend TestTransport{..} = do
13801637 void $ forkProcess localNode $ do
13811638 serverPid <- liftIO $ takeMVar serverAddr
13821639 getSelfPid >>= unsafeSend serverPid
1383− () <- expect
1384− liftIO $ putMVar clientDone ()
1640+ expect >>= liftIO . putMVar clientDone
1641+
1642+ takeMVar clientDone
1643+
1644+testUnsafeUSend :: TestTransport -> Assertion
1645+testUnsafeUSend TestTransport{..} = do
1646+ serverAddr <- newEmptyMVar
1647+ clientDone <- newEmptyMVar
1648+
1649+ localNode <- newLocalNode testTransport initRemoteTable
1650+ void $ forkProcess localNode $ do
1651+ self <- getSelfPid
1652+ liftIO $ putMVar serverAddr self
1653+ clientAddr <- expect
1654+ unsafeUSend clientAddr ()
1655+
1656+ void $ forkProcess localNode $ do
1657+ serverPid <- liftIO $ takeMVar serverAddr
1658+ getSelfPid >>= unsafeUSend serverPid
1659+ expect >>= liftIO . putMVar clientDone
13851660
13861661 takeMVar clientDone
13871662
@@ -1392,8 +1667,7 @@ testUnsafeNSend TestTransport{..} = do
13921667 localNode <- newLocalNode testTransport initRemoteTable
13931668
13941669 pid <- forkProcess localNode $ do
1395− () <- expect
1396− liftIO $ putMVar clientDone ()
1670+ expect >>= liftIO . putMVar clientDone
13971671
13981672 void $ runProcess localNode $ do
13991673 register "foobar" pid
@@ -1401,6 +1675,24 @@ testUnsafeNSend TestTransport{..} = do
14011675
14021676 takeMVar clientDone
14031677
1678+testUnsafeNSendRemote :: TestTransport -> Assertion
1679+testUnsafeNSendRemote TestTransport{..} = do
1680+ clientDone <- newEmptyMVar
1681+
1682+ localNode1 <- newLocalNode testTransport initRemoteTable
1683+ localNode2 <- newLocalNode testTransport initRemoteTable
1684+
1685+ _ <- forkProcess localNode1 $ do
1686+ getSelfPid >>= register "foobar"
1687+ liftIO $ putMVar clientDone ()
1688+ expect >>= liftIO . putMVar clientDone
1689+
1690+ takeMVar clientDone
1691+ void $ runProcess localNode2 $ do
1692+ unsafeNSendRemote (localNodeId localNode1) "foobar" ()
1693+
1694+ takeMVar clientDone
1695+
14041696testUnsafeSendChan :: TestTransport -> Assertion
14051697testUnsafeSendChan TestTransport{..} = do
14061698 serverAddr <- newEmptyMVar
@@ -1417,7 +1709,7 @@ testUnsafeSendChan TestTransport{..} = do
14171709 serverPid <- liftIO $ takeMVar serverAddr
14181710 (sp, rp) <- newChan
14191711 unsafeSend serverPid sp
1420− () <- receiveChan rp
1712+ receiveChan rp :: Process ()
14211713 liftIO $ putMVar clientDone ()
14221714
14231715 takeMVar clientDone
@@ -1431,8 +1723,8 @@ testCallLocal TestTransport{..} = do
14311723 runProcess node $ do
14321724 r <- (/=) <$> getSelfPid <*> callLocal getSelfPid
14331725 liftIO $ putMVar result r
1434− True <- takeMVar result
1435− return ()
1726+
1727+ takeMVar result >>= assertBool "Expected 'True'"
14361728
14371729 -- Testing that when callLocal is interrupted, the worker is interrupted.
14381730 ibox <- newIORef False
@@ -1449,10 +1741,9 @@ testCallLocal TestTransport{..} = do
14491741 (send keeper ())
14501742 caller <- expect
14511743 exit caller "test"
1452− () <- expect
1453− return ()
1454− True <- readIORef ibox
1455− return ()
1744+ expect :: Process ()
1745+
1746+ readIORef ibox >>= assertBool "Expected 'True'"
14561747
14571748 -- Testing that when the worker raises an exception, the exception is propagated to the parent.
14581749 ibox2 <- newIORef False
@@ -1461,8 +1752,8 @@ testCallLocal TestTransport{..} = do
14611752 liftIO $ writeIORef ibox2 $ case r of
14621753 Left (ErrorCall "e") -> True
14631754 _ -> False
1464− True <- readIORef ibox
1465− return ()
1755+
1756+ readIORef ibox >>= assertBool "Expected 'True'"
14661757
14671758 -- Test that caller waits for the worker in correct situation
14681759 ibox3 <- newIORef False
@@ -1479,8 +1770,8 @@ testCallLocal TestTransport{..} = do
14791770 liftIO $ putMVar result3 =<< readIORef ibox3
14801771 worker <- expect
14811772 send worker ()
1482− True <- takeMVar result3
1483− return ()
1773+
1774+ takeMVar result3 >>= assertBool "Expected 'True'"
14841775
14851776 -- Test that caller waits for the worker in case when caller gets an exception
14861777 ibox4 <- newIORef False
@@ -1496,13 +1787,9 @@ testCallLocal TestTransport{..} = do
14961787 `finally` (liftIO $ putMVar result4 =<< readIORef ibox4)
14971788 caller <- expect
14981789 exit caller "hi!"
1499− True <- takeMVar result4
1500− return ()
1501− -- XXX: Testing that when mask_ $ callLocal p runs p in masked state.
1502−
1503−
1504−
15051790
1791+ takeMVar result4 >>= assertBool "Expected 'True'"
1792+ -- XXX: Testing that when mask_ $ callLocal p runs p in masked state.
15061793
15071794tests :: TestTransport -> IO [Test]
15081795tests testtrans = return [
@@ -1513,9 +1800,7 @@ tests testtrans = return [
15131800 , testCase "Timeout0" (testTimeout0 testtrans)
15141801 , testCase "SendToTerminated" (testSendToTerminated testtrans)
15151802 , testCase "TypedChannnels" (testTypedChannels testtrans)
1516− , testCase "MergeChannels" (testMergeChannels testtrans)
15171803 , testCase "Terminate" (testTerminate testtrans)
1518− , testCase "Registry" (testRegistry testtrans)
15191804 , testCase "RegistryRemoteProcess" (testRegistryRemoteProcess testtrans)
15201805 , testCase "RemoteRegistry" (testRemoteRegistry testtrans)
15211806 , testCase "RemoteRegistryRemoteProcess" (testRemoteRegistryRemoteProcess testtrans)
@@ -1529,6 +1814,7 @@ tests testtrans = return [
15291814 , testCase "MatchMessageUnwrap" (testMatchMessageWithUnwrap testtrans)
15301815 , testCase "ReceiveChanTimeout" (testReceiveChanTimeout testtrans)
15311816 , testCase "ReceiveChanFeatures" (testReceiveChanFeatures testtrans)
1817+ , testCase "ChanLifecycle" (testChanLifecycle testtrans)
15321818 , testCase "KillLocal" (testKillLocal testtrans)
15331819 , testCase "KillRemote" (testKillRemote testtrans)
15341820 , testCase "Die" (testDie testtrans)
@@ -1538,10 +1824,13 @@ tests testtrans = return [
15381824 , testCase "MaskRestoreScope" (testMaskRestoreScope testtrans)
15391825 , testCase "ExitLocal" (testExitLocal testtrans)
15401826 , testCase "ExitRemote" (testExitRemote testtrans)
1827+ , testCase "RegistryMonitoring" (testRegistryMonitoring testtrans)
15411828 , testCase "TextCallLocal" (testCallLocal testtrans)
15421829 -- Unsafe Primitives
15431830 , testCase "TestUnsafeSend" (testUnsafeSend testtrans)
1831+ , testCase "TestUnsafeUSend" (testUnsafeUSend testtrans)
15441832 , testCase "TestUnsafeNSend" (testUnsafeNSend testtrans)
1833+ , testCase "TestUnsafeNSendRemote" (testUnsafeNSendRemote testtrans)
15451834 , testCase "TestUnsafeSendChan" (testUnsafeSendChan testtrans)
15461835 -- usend
15471836 , testCase "USend" (testUSend usend testtrans 50)
@@ -1556,8 +1845,7 @@ tests testtrans = return [
15561845 -- The "missing" combinations in the list below don't make much sense, as
15571846 -- we cannot guarantee that the monitor reply or link exception will not
15581847 -- happen before the unmonitor or unlink
1559− testCase "MonitorUnreachable" (testMonitorUnreachable testtrans True False)
1560− , testCase "MonitorNormalTermination" (testMonitorNormalTermination testtrans True False)
1848+ testCase "MonitorNormalTermination" (testMonitorNormalTermination testtrans True False)
15611849 , testCase "MonitorAbnormalTermination" (testMonitorAbnormalTermination testtrans True False)
15621850 , testCase "MonitorLocalDeadProcess" (testMonitorLocalDeadProcess testtrans True False)
15631851 , testCase "MonitorRemoteDeadProcess" (testMonitorRemoteDeadProcess testtrans True False)
@@ -1579,20 +1867,13 @@ tests testtrans = return [
15791867 , testCase "MonitorLiveNode" (testMonitorLiveNode testtrans)
15801868 , testCase "MonitorChannel" (testMonitorChannel testtrans)
15811869 -- Reconnect
1582− , testCase "Reconnect" (testReconnect testtrans)
15831870 ]
1584− ]
15851871
1586−syncBreakConnection :: (NT.EndPointAddress -> NT.EndPointAddress -> IO ()) -> LocalNode -> LocalNode -> IO ()
1587−syncBreakConnection breakConnection nid0 nid1 = do
1588− m <- newEmptyMVar
1589− _ <- forkProcess nid1 $ getSelfPid >>= liftIO . putMVar m
1590− runProcess nid0 $ do
1591− them <- liftIO $ takeMVar m
1592− pinger <- spawnLocal $ forever $ send them ()
1593− _ <- monitorNode (localNodeId nid1)
1594− liftIO $ breakConnection (nodeAddress $ localNodeId nid0)
1595− (nodeAddress $ localNodeId nid1)
1596− NodeMonitorNotification _ _ _ <- expect
1597− kill pinger "finished"
1598− return ()
1872+ -- Tests that fail occasionally and should be revised
1873+ , testGroup "Flaky" [
1874+ testCase "Reconnect" (testReconnect testtrans)
1875+ , testCase "Registry" (testRegistry testtrans)
1876+ , testCase "MergeChannels" (testMergeChannels testtrans)
1877+ , testCase "MonitorUnreachable" (testMonitorUnreachable testtrans True False)
1878+ ]
1879+ ]
distributed-process-tests/src/Control/Distributed/Process/Tests/Closure.hs+89−48
@@ -169,8 +169,11 @@ testUnclosure TestTransport{..} rtable = do
169169 node <- newLocalNode testTransport rtable
170170 done <- newEmptyMVar
171171 forkProcess node $ do
172− 120 <- join . unClosure $ factorialClosure 5
172+ i <- join . unClosure $ factorialClosure 5
173173 liftIO $ putMVar done ()
174+ if i == 720
175+ then return ()
176+ else error "Something went horribly wrong"
174177 takeMVar done
175178
176179testBind :: TestTransport -> RemoteTable -> Assertion
@@ -180,8 +183,11 @@ testBind TestTransport{..} rtable = do
180183 runProcess node $ do
181184 us <- getSelfPid
182185 join . unClosure $ sendFac 6 us
183− (720 :: Int) <- expect
186+ (i :: Int) <- expect
184187 liftIO $ putMVar done ()
188+ if i == 720
189+ then return ()
190+ else error "Something went horribly wrong"
185191 takeMVar done
186192
187193testSendPureClosure :: TestTransport -> RemoteTable -> Assertion
@@ -194,7 +200,7 @@ testSendPureClosure TestTransport{..} rtable = do
194200 addr <- forkProcess node $ do
195201 cl <- expect
196202 fn <- unClosure cl :: Process (Int -> Int)
197− 13 <- return $ fn 6
203+ (_ :: Int) <- return $ fn 6
198204 liftIO $ putMVar serverDone ()
199205 putMVar serverAddr addr
200206
@@ -218,8 +224,11 @@ testSendIOClosure TestTransport{..} rtable = do
218224 liftIO $ do
219225 someMVar <- newEmptyMVar
220226 io someMVar
221− 5 <- readMVar someMVar
227+ i <- readMVar someMVar
222228 putMVar serverDone ()
229+ if i == 5
230+ then return ()
231+ else error "Something went horribly wrong"
223232 putMVar serverAddr addr
224233
225234 forkIO $ do
@@ -248,8 +257,10 @@ testSendProcClosure TestTransport{..} rtable = do
248257 runProcess node $ do
249258 pid <- getSelfPid
250259 send theirAddr (cpSend $(mkStatic 'sdictInt) pid)
251− 5 <- expect :: Process Int
252− liftIO $ putMVar clientDone ()
260+ i <- expect :: Process Int
261+ if i == 5
262+ then liftIO $ putMVar clientDone ()
263+ else error "Something went horribly wrong"
253264
254265 takeMVar clientDone
255266
@@ -269,8 +280,9 @@ testSpawn TestTransport{..} rtable = do
269280 pid <- getSelfPid
270281 pid' <- spawn nid (sendPidClosure pid)
271282 pid'' <- expect
272− True <- return $ pid' == pid''
273− liftIO $ putMVar clientDone ()
283+ if pid' == pid''
284+ then liftIO $ putMVar clientDone ()
285+ else error "Something went horribly wrong"
274286
275287 takeMVar clientDone
276288
@@ -294,8 +306,9 @@ testSpawnRace TestTransport{..} rtable = do
294306 spawnLocal $ spawn (localNodeId node2) (sendPidClosure pid) >>= send pid
295307 pid' <- expect :: Process ProcessId
296308 pid'' <- expect :: Process ProcessId
297− True <- return $ pid' == pid''
298− return ()
309+ if pid' == pid''
310+ then return ()
311+ else error "Something went horribly wrong"
299312
300313 where
301314
@@ -305,14 +318,16 @@ testSpawnRace TestTransport{..} rtable = do
305318 wrapEP e =
306319 e { NT.connect = \x y z -> do
307320 healthy <- newIORef True
308− fmap (fmap $ wrapConnection healthy) $ NT.connect e x y z
321+ fmap (fmap $ wrapConnection healthy e x) $ NT.connect e x y z
309322 }
310323
311− wrapConnection :: IORef Bool -> NT.Connection -> NT.Connection
312− wrapConnection healthy (NT.Connection s closeC) =
324+ wrapConnection :: IORef Bool -> NT.EndPoint -> NT.EndPointAddress
325+ -> NT.Connection -> NT.Connection
326+ wrapConnection healthy e remoteAddr (NT.Connection s closeC) =
313327 flip NT.Connection closeC $ \msg -> do
314328 when (msg == messageToPayload (createMessage ())) $ do
315329 writeIORef healthy False
330+ testBreakConnection (NT.address e) remoteAddr
316331 isHealthy <- readIORef healthy
317332 if isHealthy then s msg
318333 else return $ Left $ NT.TransportError NT.SendFailed ""
@@ -330,8 +345,10 @@ testCall TestTransport{..} rtable = do
330345 node <- newLocalNode testTransport rtable
331346 nid <- readMVar serverNodeAddr
332347 runProcess node $ do
333− (120 :: Int) <- call $(mkStatic 'sdictInt) nid (factorialClosure 5)
334− liftIO $ putMVar clientDone ()
348+ (a :: Int) <- call $(mkStatic 'sdictInt) nid (factorialClosure 5)
349+ if a == 120
350+ then liftIO $ putMVar clientDone ()
351+ else error "something went horribly wrong"
335352
336353 takeMVar clientDone
337354
@@ -348,8 +365,10 @@ testCallBind TestTransport{..} rtable = do
348365 node <- newLocalNode testTransport rtable
349366 nid <- readMVar serverNodeAddr
350367 runProcess node $ do
351− (120 :: Int) <- call $(mkStatic 'sdictInt) nid (factorial' 5)
352− liftIO $ putMVar clientDone ()
368+ (a :: Int) <- call $(mkStatic 'sdictInt) nid (factorial' 5)
369+ if a == 120
370+ then liftIO $ putMVar clientDone ()
371+ else error "Something went horribly wrong"
353372
354373 takeMVar clientDone
355374
@@ -360,9 +379,11 @@ testSeq TestTransport{..} rtable = do
360379 runProcess node $ do
361380 us <- getSelfPid
362381 join . unClosure $ sendFac 5 us `seqCP` sendFac 6 us
363− 120 :: Int <- expect
364− 720 :: Int <- expect
365− liftIO $ putMVar done ()
382+ a :: Int <- expect
383+ b :: Int <- expect
384+ if a == 120 && b == 720
385+ then liftIO $ putMVar done ()
386+ else error "Something went horribly wrong"
366387 takeMVar done
367388
368389-- Test 'spawnSupervised'
@@ -391,25 +412,33 @@ testSpawnSupervised TestTransport{..} rtable = do
391412 throw supervisorDeath
392413
393414 forkProcess node2 $ do
394− [super, child] <- liftIO $ mapM readMVar [superPid, childPid]
395− ref <- monitor child
396− self <- getSelfPid
397− let waitForMOrL = do
398− liftIO $ threadDelay 10000
399− mpinfo <- getProcessInfo child
400− case mpinfo of
401− Nothing -> waitForMOrL
402− Just pinfo ->
403− unless (isJust $ lookup self (infoMonitors pinfo)) waitForMOrL
404− waitForMOrL
405− liftIO $ putMVar linkUp ()
406− -- because monitor message was sent before message to process
407− -- we hope that it will be processed before
408− ProcessMonitorNotification ref' pid' (DiedException e) <- expect
409− True <- return $ ref' == ref
410− && pid' == child
411− && e == show (ProcessLinkException super (DiedException (show supervisorDeath)))
412− liftIO $ putMVar thirdProcessDone ()
415+ res <- liftIO $ mapM readMVar [superPid, childPid]
416+ case res of
417+ [super, child] -> do
418+ ref <- monitor child
419+ self <- getSelfPid
420+ let waitForMOrL = do
421+ liftIO $ threadDelay 10000
422+ mpinfo <- getProcessInfo child
423+ case mpinfo of
424+ Nothing -> waitForMOrL
425+ Just pinfo ->
426+ unless (isJust $ lookup self (infoMonitors pinfo)) waitForMOrL
427+ waitForMOrL
428+ liftIO $ putMVar linkUp ()
429+ -- because monitor message was sent before message to process
430+ -- we hope that it will be processed before
431+ res' <- expect
432+ case res' of
433+ (ProcessMonitorNotification ref' pid' (DiedException e)) ->
434+ if (ref' == ref && pid' == child &&
435+ e == show (ProcessLinkException super
436+ (DiedException (show supervisorDeath))))
437+ then liftIO $ putMVar thirdProcessDone ()
438+ else error "Something went horribly wrong"
439+ _ -> error "Something went horribly wrong"
440+
441+ _ -> die $ "Something went horribly wrong"
413442
414443 takeMVar thirdProcessDone
415444 where
@@ -424,8 +453,10 @@ testSpawnInvalid TestTransport{..} rtable = do
424453 (pid, ref) <- spawnMonitor (localNodeId node) (closure (staticLabel "ThisDoesNotExist") empty)
425454 ProcessMonitorNotification ref' pid' _reason <- expect
426455 -- Depending on the exact interleaving, reason might be NoProc or the exception thrown by the absence of the static closure
427− True <- return $ ref' == ref && pid == pid'
428− liftIO $ putMVar done ()
456+ res <- return $ ref' == ref && pid == pid'
457+ if res == True
458+ then liftIO $ putMVar done ()
459+ else error "Something went horribly wrong"
429460 takeMVar done
430461
431462testClosureExpect :: TestTransport -> RemoteTable -> Assertion
@@ -437,8 +468,10 @@ testClosureExpect TestTransport{..} rtable = do
437468 us <- getSelfPid
438469 them <- spawn nodeId $ cpExpect $(mkStatic 'sdictInt) `bindCP` cpSend $(mkStatic 'sdictInt) us
439470 send them (1234 :: Int)
440− (1234 :: Int) <- expect
441− liftIO $ putMVar done ()
471+ (res :: Int) <- expect
472+ if res == 1234
473+ then liftIO $ putMVar done ()
474+ else error "Something went horribly wrong"
442475 takeMVar done
443476
444477testSpawnChannel :: TestTransport -> RemoteTable -> Assertion
@@ -463,8 +496,10 @@ testTDict TestTransport{..} rtable = do
463496 done <- newEmptyMVar
464497 [node1, node2] <- replicateM 2 $ newLocalNode testTransport rtable
465498 forkProcess node1 $ do
466− True <- call $(functionTDict 'isPrime) (localNodeId node2) ($(mkClosure 'isPrime) (79 :: Integer))
467− liftIO $ putMVar done ()
499+ res <- call $(functionTDict 'isPrime) (localNodeId node2) ($(mkClosure 'isPrime) (79 :: Integer))
500+ if res == True
501+ then liftIO $ putMVar done ()
502+ else error "Something went horribly wrong..."
468503 takeMVar done
469504
470505testFib :: TestTransport -> RemoteTable -> Assertion
@@ -475,8 +510,11 @@ testFib TestTransport{..} rtable = do
475510 forkProcess (head nodes) $ do
476511 (sport, rport) <- newChan
477512 spawnLocal $ dfib (map localNodeId nodes, sport, 10)
478− 55 <- receiveChan rport :: Process Integer
513+ ff <- receiveChan rport :: Process Integer
479514 liftIO $ putMVar done ()
515+ if ff /= 55
516+ then die $ "Something went horribly wrong"
517+ else return ()
480518
481519 takeMVar done
482520
@@ -484,7 +522,7 @@ testSpawnReconnect :: TestTransport -> RemoteTable -> Assertion
484522testSpawnReconnect testtrans@TestTransport{..} rtable = do
485523 [node1, node2] <- replicateM 2 $ newLocalNode testTransport rtable
486524 let nid1 = localNodeId node1
487− nid2 = localNodeId node2
525+ -- nid2 = localNodeId node2
488526 done <- newEmptyMVar
489527 iv <- newMVar (0 :: Int)
490528
@@ -501,9 +539,12 @@ testSpawnReconnect testtrans@TestTransport{..} rtable = do
501539 liftIO $ threadDelay 100000
502540
503541 count <- liftIO $ takeMVar iv
504− True <- return $ count == 2 || count == 3 -- It depends on which message we get first in 'spawn'
542+ res <- return $ count == 2 || count == 3 -- It depends on which message we get first in 'spawn'
505543
506544 liftIO $ putMVar done ()
545+ if res /= True
546+ then error "Something went horribly wrong"
547+ else return ()
507548
508549 takeMVar done
509550
distributed-process-tests/src/Control/Distributed/Process/Tests/Internal/Utils.hs+16−5
@@ -20,6 +20,7 @@ module Control.Distributed.Process.Tests.Internal.Utils
2020 -- ping !
2121 , Ping(Ping)
2222 , ping
23+ , pause
2324 , shouldBe
2425 , shouldMatch
2526 , shouldContain
@@ -73,15 +74,16 @@ import Control.Concurrent
7374import Control.Concurrent.MVar
7475 ( putMVar
7576 )
76−import Control.Distributed.Process
77+import Control.Distributed.Process hiding (finally, catch)
7778import Control.Distributed.Process.Node
7879import Control.Distributed.Process.Serializable()
7980
8081import Control.Exception (AsyncException(ThreadKilled), SomeException)
81−import Control.Monad (forever)
82+import Control.Monad (forever, void)
83+import Control.Monad.Catch (finally, catch)
8284import Control.Monad.STM (atomically)
8385import Control.Rematch hiding (match)
84−import Control.Rematch.Run
86+import Control.Rematch.Run
8587import Data.Binary
8688import Data.Typeable (Typeable)
8789
@@ -89,6 +91,7 @@ import Test.HUnit (Assertion, assertFailure)
8991import Test.HUnit.Base (assertBool)
9092
9193import GHC.Generics
94+import System.Timeout (timeout)
9295
9396-- | A mutable cell containing a test result.
9497type TestResult a = MVar a
@@ -107,10 +110,18 @@ data TestProcessControl = Stop | Go | Report ProcessId
107110
108111instance Binary TestProcessControl where
109112
113+data Private = Private
114+ deriving (Typeable, Generic)
115+instance Binary Private where
116+
110117-- | Does exactly what it says on the tin, doing so in the @Process@ monad.
111118noop :: Process ()
112119noop = return ()
113120
121+pause :: Int -> Process ()
122+pause delay =
123+ void $ receiveTimeout delay [ match (\Private -> return ()) ]
124+
114125synchronisedAssertion :: Eq a
115126 => String
116127 -> LocalNode
@@ -223,10 +234,10 @@ testProcessReport pid = do
223234tryRunProcess :: LocalNode -> Process () -> IO ()
224235tryRunProcess node p = do
225236 tid <- liftIO myThreadId
226− runProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
237+ void $ timeout (1000000 * 60 * 5 :: Int) $
238+ runProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
227239
228240tryForkProcess :: LocalNode -> Process () -> IO ProcessId
229241tryForkProcess node p = do
230242 tid <- liftIO myThreadId
231243 forkProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
232−
distributed-process-tests/src/Control/Distributed/Process/Tests/Mx.hs+385−129
@@ -1,12 +1,23 @@
1−{-# LANGUAGE DeriveGeneric #-}
1+{-# LANGUAGE DeriveGeneric #-}
2+{-# LANGUAGE ParallelListComp #-}
3+
24module Control.Distributed.Process.Tests.Mx (tests) where
35
46import Control.Distributed.Process.Tests.Internal.Utils
57import Network.Transport.Test (TestTransport(..))
6−
7−import Control.Concurrent (threadDelay)
8−import Control.Distributed.Process
8+import Control.Distributed.Process hiding (bracket, finally, try)
9+import Control.Distributed.Process.Internal.Types
10+ ( ProcessExitException(..)
11+ , unsafeCreateUnencodedMessage
12+ )
913import Control.Distributed.Process.Node
14+import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
15+ ( send
16+ , nsend
17+ , nsendRemote
18+ , usend
19+ , sendChan
20+ )
1021import Control.Distributed.Process.Management
1122 ( MxEvent(..)
1223 , MxAgentId(..)
@@ -21,19 +32,15 @@ import Control.Distributed.Process.Management
2132 , mxUpdateLocal
2233 , mxNotify
2334 , mxBroadcast
24− , mxGetId
25− , mxGet
26− , mxSet
27− , mxClear
28− , mxPurgeTable
29− , mxDropTable
3035 )
31−import Control.Monad (void)
36+import Control.Monad (void, unless)
37+import Control.Monad.Catch(finally, bracket, try)
38+import Control.Rematch (equalTo)
3239import Data.Binary
33−import Data.List (find, sort)
34−import Data.Maybe (isJust)
40+import Data.List (find, sort, intercalate)
41+import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
3542import Data.Typeable
36−import GHC.Generics
43+import GHC.Generics hiding (from)
3744#if ! MIN_VERSION_base(4,6,0)
3845import Prelude hiding (catch, log)
3946#endif
@@ -49,7 +56,17 @@ data Publish = Publish
4956
5057instance Binary Publish where
5158
52−testAgentBroadcast :: TestResult () -> Process ()
59+awaitExit :: ProcessId -> Process ()
60+awaitExit pid =
61+ withMonitorRef pid $ \ref -> do
62+ receiveWait
63+ [ matchIf (\(ProcessMonitorNotification r _ _) -> r == ref)
64+ (\_ -> return ())
65+ ]
66+ where
67+ withMonitorRef p = bracket (monitor p) unmonitor
68+
69+testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
5370testAgentBroadcast result = do
5471 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
5572
@@ -64,7 +81,7 @@ testAgentBroadcast result = do
6481 mxNotify ()
6582 -- Once the publisher has seen our message, it will broadcast the Publish
6683 -- and the consumer will see that and send the result to our typed channel.
67− stash result =<< receiveChan resultRP
84+ stash result =<< receiveChanTimeout 10000000 resultRP
6885
6986 kill publisher "finished"
7087 kill consumer "finished"
@@ -72,7 +89,7 @@ testAgentBroadcast result = do
7289testAgentDualInput :: TestResult (Maybe Int) -> Process ()
7390testAgentDualInput result = do
7491 (sp, rp) <- newChan
75− _ <- mxAgent (MxAgentId "sum-agent") (0 :: Int) [
92+ s <- mxAgent (MxAgentId "sum-agent") (0 :: Int) [
7693 mxSink $ (\(i :: Int) -> do
7794 mxSetLocal . (+i) =<< mxGetLocal
7895 i' <- mxGetLocal
@@ -82,6 +99,8 @@ testAgentDualInput result = do
8299 else mxReady)
83100 ]
84101
102+ mRef <- monitor s
103+
85104 mxNotify (1 :: Int)
86105 nsend "sum-agent" (3 :: Int)
87106 mxNotify (2 :: Int)
@@ -89,6 +108,10 @@ testAgentDualInput result = do
89108 mxNotify (5 :: Int)
90109
91110 stash result =<< receiveChanTimeout 10000000 rp
111+ died <- receiveTimeout 10000000 [
112+ matchIf (\(ProcessMonitorNotification r _ _) -> r == mRef) (const $ return True)
113+ ]
114+ died `shouldBe` equalTo (Just True)
92115
93116testAgentPrioritisation :: TestResult [String] -> Process ()
94117testAgentPrioritisation result = do
@@ -100,12 +123,12 @@ testAgentPrioritisation result = do
100123
101124 let name = "prioritising-agent"
102125 (sp, rp) <- newChan
103− void $ mxAgent (MxAgentId name) ["first"] [
104− mxSink (\(s :: String) -> do
105− mxUpdateLocal ((s:))
126+ s <- mxAgent (MxAgentId name) ["first"] [
127+ mxSink (\(s :: String) -> do
128+ mxUpdateLocal (s:)
106129 st <- mxGetLocal
107130 case length st of
108− n | n == 5 -> do liftMX $ sendChan sp st
131+ n | n == 5 -> do liftMX $ sendChan sp (sort st)
109132 mxDeactivate "finished"
110133 _ -> mxReceive -- go to the mailbox
111134 )
@@ -116,23 +139,33 @@ testAgentPrioritisation result = do
116139 mxNotify "fourth"
117140 nsend name "fifth"
118141
119− stash result . sort =<< receiveChan rp
142+ stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
143+ awaitExit s
120144
121145testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
122146testAgentMailboxHandling result = do
123147 (sp, rp) <- newChan
124− agent <- mxAgent (MxAgentId "listener-agent") () [
148+ agent <- mxAgent (MxAgentId "mailbox-agent") () [
125149 mxSink $ \() -> (liftMX $ sendChan sp ()) >> mxReady
126150 ]
127151
128− nsend "listener-agent" ()
152+ nsend "mailbox-agent" ()
129153
130154 stash result =<< receiveChanTimeout 1000000 rp
131155 kill agent "finished"
132156
133157testAgentEventHandling :: TestResult Bool -> Process ()
134158testAgentEventHandling 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+
135167 let initState = [] :: [MxEvent]
168+ (rc, rs) <- newChan
136169 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
137170 (mxSink $ \ev -> do
138171 st <- mxGetLocal
@@ -141,7 +174,7 @@ testAgentEventHandling result = do
141174 (MxSpawned _) -> mxSetLocal (ev:st)
142175 (MxProcessDied _ _) -> mxSetLocal (ev:st)
143176 _ -> return ()
144− act >> mxReady),
177+ act >> (liftMX $ sendChan rc ()) >> mxReady),
145178 (mxSink $ \(ev, sp :: SendPort Bool) -> do
146179 st <- mxGetLocal
147180 let found =
@@ -161,126 +194,349 @@ testAgentEventHandling result = do
161194 mxReady)
162195 ]
163196
164− _ <- monitor agentPid
165− (sp, rp) <- newChan
166− pid <- spawnLocal $ sendChan sp ()
167− () <- receiveChan rp
197+ -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
198+ faff 2000000 rs
199+
200+ (sp, rp) <- newChan :: Process (SendPort (), ReceivePort ())
201+
202+ pid <- spawnLocal $ expect >>= sendChan sp
168203
169204 -- By waiting for a monitor notification, we have a
170− -- higher probably that the agent has seen
205+ -- higher probably that the agent has seen the spawn and died events
171206 monitor pid
172− receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
207+
208+ send pid ()
209+ rct <- receiveChanTimeout 10000000 rp
210+ unless (isJust rct) $ die "No response on channel"
211+
212+ pmn <- receiveTimeout 2000000 [ match (\ProcessMonitorNotification{} -> return ()) ]
213+ unless (isJust pmn) $ die "No monitor notification arrived"
214+
215+ -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
216+ faff 2000000 rs
173217
174218 (replyTo, reply) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
175219 mxNotify (MxSpawned pid, replyTo)
176220 mxNotify (MxProcessDied pid DiedNormal, replyTo)
177221
178− seenAlive <- receiveChan reply
179− seenDead <- receiveChan reply
222+ seenAlive <- receiveChanTimeout 10000000 reply
223+ seenDead <- receiveChanTimeout 10000000 reply
224+
225+ stash result $ foldr (&&) True $ catMaybes [seenAlive, seenDead]
226+ kill timer "test-complete"
227+ kill agentPid "test-complete"
228+ where
229+ faff delay port = do
230+ res <- receiveChanTimeout delay port
231+ unless (isNothing res) $ pause delay
232+
233+testMxRegEvents :: TestResult () -> Process ()
234+testMxRegEvents result = do
235+ {- This test only deals with the local case, to ensure that we are being
236+ notified in the expected order - the remote cases related to the
237+ behaviour of the node controller are contained in the CH test suite. -}
238+ ensure (stash result ()) $ do
239+ let label = "testMxRegEvents"
240+ let agentLabel = "mxRegEvents-agent"
241+ let delay = 1000000
242+ (regChan, regSink) <- newChan
243+ (unRegChan, unRegSink) <- newChan
244+ agent <- mxAgent (MxAgentId agentLabel) () [
245+ mxSink $ \ev -> do
246+ case ev of
247+ MxRegistered pid label'
248+ | label' == label -> liftMX $ sendChan regChan (label', pid)
249+ MxUnRegistered pid label'
250+ | label' == label -> liftMX $ sendChan unRegChan (label', pid)
251+ _ -> return ()
252+ mxReady
253+ ]
254+
255+ p1 <- spawnLocal expect
256+ p2 <- spawnLocal expect
257+
258+ register label p1
259+ reg1 <- receiveChanTimeout delay regSink
260+ reg1 `shouldBe` equalTo (Just (label, p1))
261+
262+ unregister label
263+ unreg1 <- receiveChanTimeout delay unRegSink
264+ unreg1 `shouldBe` equalTo (Just (label, p1))
265+
266+ register label p2
267+ reg2 <- receiveChanTimeout delay regSink
268+ reg2 `shouldBe` equalTo (Just (label, p2))
269+
270+ reregister label p1
271+ unreg2 <- receiveChanTimeout delay unRegSink
272+ unreg2 `shouldBe` equalTo (Just (label, p2))
273+
274+ reg3 <- receiveChanTimeout delay regSink
275+ reg3 `shouldBe` equalTo (Just (label, p1))
276+
277+ mapM_ (flip kill $ "test-complete") [agent, p1, p2]
278+
279+testMxRegMon :: LocalNode -> TestResult () -> Process ()
280+testMxRegMon remoteNode result = do
281+ ensure (stash result ()) $ do
282+ -- ensure that when a registered process dies, we get a notification that
283+ -- it has been unregistered as well as seeing the name get removed
284+ let label1 = "aaaaa"
285+ let label2 = "bbbbb"
286+ let isValid l = l == label1 || l == label2
287+ let agentLabel = "mxRegMon-agent"
288+ let delay = 1000000
289+ (regChan, regSink) <- newChan
290+ (unRegChan, unRegSink) <- newChan
291+ agent <- mxAgent (MxAgentId agentLabel) () [
292+ mxSink $ \ev -> do
293+ case ev of
294+ MxRegistered pid label
295+ | isValid label -> liftMX $ sendChan regChan (label, pid)
296+ MxUnRegistered pid label
297+ | isValid label -> liftMX $ sendChan unRegChan (label, pid)
298+ _ -> return ()
299+ mxReady
300+ ]
301+
302+ (sp, rp) <- newChan
303+ liftIO $ forkProcess remoteNode $ do
304+ getSelfPid >>= sendChan sp
305+ expect :: Process ()
306+
307+ p1 <- receiveChan rp
308+
309+ register label1 p1
310+ reg1 <- receiveChanTimeout delay regSink
311+ reg1 `shouldBe` equalTo (Just (label1, p1))
312+
313+ register label2 p1
314+ reg2 <- receiveChanTimeout delay regSink
315+ reg2 `shouldBe` equalTo (Just (label2, p1))
316+
317+ n1 <- whereis label1
318+ n1 `shouldBe` equalTo (Just p1)
319+
320+ n2 <- whereis label2
321+ n2 `shouldBe` equalTo (Just p1)
322+
323+ kill p1 "goodbye"
324+
325+ unreg1 <- receiveChanTimeout delay unRegSink
326+ unreg2 <- receiveChanTimeout delay unRegSink
327+
328+ let evts = [unreg1, unreg2]
329+ -- we can't rely on the order of the values in the node controller's
330+ -- map (it's either racy to do so, or no such guarantee exists for Data.Map),
331+ -- so we simply verify that we received the un-registration events we expect
332+ evts `shouldContain` (Just (label1, p1))
333+ evts `shouldContain` (Just (label2, p1))
334+
335+ kill agent "test-complete"
336+
337+ensure :: Process () -> Process () -> Process ()
338+ensure = flip finally
339+
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+ ]
180437
181− stash result $ seenAlive && seenDead
438+ case mNode of
439+ Nothing -> void $ spawnLocal (proc sp)
440+ Just remoteNode -> void $ liftIO $ forkProcess remoteNode $ proc sp
182441
183−testAgentPublication :: TestResult (Maybe Publish) -> Process ()
184−testAgentPublication result = do
185− (syncChan, rp) <- newChan
186− let ourId = MxAgentId "publication-agent"
187− agentPid <- mxAgent ourId () [
188− mxSink $ \() -> do
189− selfId <- mxGetId
190− liftMX $ mxSet selfId "publish" Publish >> sendChan syncChan ()
191− mxReady
192− ]
442+ p1 <- receiveChanTimeout 2000000 rp
443+ unless (isJust p1) $ die "Timed out waiting for ProcessId"
444+ res <- try $ test (fromJust p1) sink
193445
194− mxNotify ()
195− () <- receiveChan rp
446+ kill agent "bye"
447+ kill (fromJust p1) "bye"
196448
197− stash result =<< mxGet ourId "publish"
449+ case res of
450+ Left (ProcessExitException _ m) -> (liftIO $ putStrLn $ "SomeException-" ++ show m) >> die m
451+ Right tr -> tr `shouldBe` equalTo True
198452
199− mref <- monitor agentPid
200− kill agentPid "finished"
201− receiveWait [
202− matchIf (\(ProcessMonitorNotification ref _ _) -> ref == mref)
203− ((\_ -> return ()))
204− ]
205453
206−testAgentTableClear :: Int -> TestResult (Maybe Int, Maybe Int) -> Process ()
207−testAgentTableClear val result =
208− let tId = (MxAgentId "agent-1")
209− tKey = "key-1" in do
210− mxSet tId tKey val
211− get1 <- mxGet tId tKey
212− mxClear tId tKey
213− get2 <- mxGet tId tKey
214− stash result (get1, get2)
215−
216−testAgentTablePurge :: TestResult (Maybe Int) -> Process ()
217−testAgentTablePurge result =
218− let tId = MxAgentId "agent-2"
219− tKey = "key-2" in do
220− mxSet tId tKey (12345 :: Int)
221− mxPurgeTable tId
222− stash result =<< mxGet tId tKey
223−
224−testAgentTableDelete :: Int
225− -> TestResult (Maybe Int, Maybe Int, Maybe Int)
226− -> Process ()
227−testAgentTableDelete val result =
228− let tId = (MxAgentId "agent-3")
229− tKey = "key-3" in do
230− mxSet tId tKey val
231− get1 <- mxGet tId tKey
232− mxDropTable tId
233− get2 <- mxGet tId tKey
234− mxSet tId tKey val
235− get3 <- mxGet tId tKey
236− stash result (get1, get2, get3)
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
237466
238467tests :: TestTransport -> IO [Test]
239468tests TestTransport{..} = do
240469 node1 <- newLocalNode testTransport initRemoteTable
470+ node2 <- newLocalNode testTransport initRemoteTable
241471 return [
242− testGroup "Mx Agents" [
243− testCase "Event Handling"
244− (delayedAssertion
245− "expected True, but events where not as expected"
246− node1 True testAgentEventHandling)
247− , testCase "Inter-Agent Broadcast"
248− (delayedAssertion
249− "expected (), but no broadcast was received"
250− node1 () testAgentBroadcast)
251− , testCase "Agent Mailbox Handling"
252− (delayedAssertion
253− "expected (Just ()), but no regular (mailbox) input was handled"
254− node1 (Just ()) testAgentMailboxHandling)
255− , testCase "Agent Dual Input Handling"
256− (delayedAssertion
257− "expected sum = 15, but the result was Nothing"
258− node1 (Just 15 :: Maybe Int) testAgentDualInput)
259− , testCase "Agent Input Prioritisation"
260− (delayedAssertion
261− "expected [first, second, third, fourth, fifth], but result diverged"
262− node1 (sort ["first", "second",
263− "third", "fourth",
264− "fifth"]) testAgentPrioritisation)
265− ],
266− testGroup "Mx Global Properties" [
267− testCase "Global Property Publication"
268− (delayedAssertion
269− "expected (Just Publish), but no table entry was found"
270− node1 (Just Publish) testAgentPublication)
271− , testCase "Clearing Global Properties"
272− (delayedAssertion
273− "expected (Just 1024, Nothing): invalid table entry found!"
274− node1 (Just 1024, Nothing) (testAgentTableClear 1024))
275− , testCase "Purging Global Tables"
276− (delayedAssertion
277− "expected Nothing, but a table entry was found"
278− node1 Nothing testAgentTablePurge)
279− , testCase "Deleting and (Re)Creating Global Tables"
280− (delayedAssertion
281− "expected (Just 15, Nothing, Just 15): invalid table entry found!"
282− node1 (Just 15, Nothing, Just 15) (testAgentTableDelete 15))
283− -- Wait for other tests to finish.
284− , testCase "Wait" $
285− threadDelay 100000
286− ]]
472+ testGroup "MxAgents" [
473+ testCase "EventHandling"
474+ (delayedAssertion
475+ "expected True, but events where not as expected"
476+ node1 True testAgentEventHandling)
477+ , testCase "InterAgentBroadcast"
478+ (delayedAssertion
479+ "expected (), but no broadcast was received"
480+ node1 (Just ()) testAgentBroadcast)
481+ , testCase "AgentMailboxHandling"
482+ (delayedAssertion
483+ "expected (Just ()), but no regular (mailbox) input was handled"
484+ node1 (Just ()) testAgentMailboxHandling)
485+ , testCase "AgentDualInputHandling"
486+ (delayedAssertion
487+ "expected sum = 15, but the result was Nothing"
488+ node1 (Just 15 :: Maybe Int) testAgentDualInput)
489+ , testCase "AgentInputPrioritisation"
490+ (delayedAssertion
491+ "expected [first, second, third, fourth, fifth], but result diverged"
492+ node1 (sort ["first", "second",
493+ "third", "fourth",
494+ "fifth"]) testAgentPrioritisation)
495+ ]
496+ , testGroup "MxEvents" [
497+ testCase "NameRegistrationEvents"
498+ (delayedAssertion
499+ "expected registration events to map to the correct ProcessId"
500+ node1 () testMxRegEvents)
501+ , testCase "PostDeathNameUnRegistrationEvents"
502+ (delayedAssertion
503+ "expected process deaths to result in unregistration events"
504+ node1 () (testMxRegMon node2))
505+ , testGroup "SendEvents" $ buildTestCases node1 node2
506+ ]
507+ ]
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+ ]
distributed-process-tests/src/Control/Distributed/Process/Tests/Receive.hs+8−12
@@ -1,4 +1,4 @@
1−{-# LANGUAGE TemplateHaskell, DeriveDataTypeable #-}
1+{-# LANGUAGE TemplateHaskell #-}
22{-# OPTIONS_GHC -Wall #-}
33
44-- | XXX test doesn't work, because failure exceptions don't get propagated. The
@@ -10,16 +10,12 @@ import Network.Transport.Test (TestTransport(..))
1010
1111import Network.Transport (Transport)
1212import Control.Distributed.Process
13−import Control.Distributed.Process.Closure
1413import Control.Distributed.Process.Node
1514
1615import Control.Monad
17−import Text.Printf
18−import Data.Binary
19−import Data.Typeable
2016
2117import Test.HUnit (Assertion, (@?=))
22−import Test.Framework (Test, defaultMain)
18+import Test.Framework (Test)
2319import Test.Framework.Providers.HUnit (testCase)
2420
2521-- Tests:
@@ -46,7 +42,7 @@ recTest2 :: ReceivePort ()
4642 -> SendPort String
4743 -> ReceivePort String -> ReceivePort String
4844 -> Process ()
49−recTest2 wait sync r1 r2 = do
45+recTest2 wait sync r1 _ = do
5046 forever $ do
5147 receiveChan wait
5248 r <- receiveWait
@@ -59,7 +55,7 @@ recTest3 :: ReceivePort ()
5955 -> SendPort String
6056 -> ReceivePort String -> ReceivePort String
6157 -> Process ()
62−recTest3 wait sync r1 r2 = do
58+recTest3 wait sync r1 _ = do
6359 forever $ do
6460 receiveChan wait
6561 r <- receiveWait
@@ -72,7 +68,7 @@ recTest4 :: ReceivePort ()
7268 -> SendPort String
7369 -> ReceivePort String -> ReceivePort String
7470 -> Process ()
75−recTest4 wait sync r1 r2 = do
71+recTest4 wait sync r1 _ = do
7672 forever $ do
7773 receiveChan wait
7874 r <- receiveWait
@@ -86,11 +82,11 @@ master :: Process ()
8682master = do
8783 (waits,waitr) <- newChan
8884 (syncs,syncr) <- newChan
89− let go expect = do
85+ let go expected = do
9086 sendChan waits ()
9187 r <- receiveChan syncr
92− liftIO $ print (r,expect, r == expect)
93− liftIO $ r @?= expect
88+ liftIO $ print (r, expected, r == expected)
89+ liftIO $ r @?= expected
9490
9591 liftIO $ putStrLn "---- Test 1 ----"
9692 (s1,r1) <- newChan
distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hs+11−7
@@ -29,7 +29,7 @@ import Test.Framework.Providers.HUnit (testCase)
2929
3030testLocalDeadProcessInfo :: TestResult (Maybe ProcessInfo) -> Process ()
3131testLocalDeadProcessInfo result = do
32− pid <- spawnLocal $ do "finish" <- expect; return ()
32+ pid <- spawnLocal $ do (_ :: String) <- expect; return ()
3333 mref <- monitor pid
3434 send pid "finish"
3535 _ <- receiveWait [
@@ -52,8 +52,10 @@ testLocalLiveProcessInfo result = do
5252 link self
5353 mRef <- monitor self
5454 stash mon mRef
55− "die" <- expect
56− return ()
55+ res <- expect
56+ case res of
57+ "die" -> return ()
58+ _ -> die $ "unexpected message received: " ++ res
5759
5860 monRef <- liftIO $ takeMVar mon
5961
@@ -84,9 +86,9 @@ testRemoteLiveProcessInfo TestTransport{..} node1 = do
8486 -- our send op shouldn't overtake link or monitor requests AFAICT
8587 -- so a little table tennis should get us synchronised properly
8688 send serverPid (self, "ping")
87− "pong" <- expect
89+ pong <- expect
8890 pInfo <- getProcessInfo serverPid
89− stash result $ pInfo /= Nothing
91+ stash result $ pong == "pong" && pInfo /= Nothing
9092 where
9193 launchRemote :: MVar ProcessId -> IO ()
9294 launchRemote locMV = do
@@ -97,8 +99,10 @@ testRemoteLiveProcessInfo TestTransport{..} node1 = do
9799 _ <- receiveWait [
98100 match (\(pid, "ping") -> send pid "pong")
99101 ]
100− "stop" <- expect
101− return ()
102+ res <- expect
103+ case res of
104+ "stop" -> return ()
105+ _ -> die $ "unexpected message received: " ++ res
102106 return ()
103107
104108 withActiveRemote :: LocalNode
distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hs+113−8
@@ -5,6 +5,7 @@ module Control.Distributed.Process.Tests.Tracing (tests) where
55import Control.Distributed.Process.Tests.Internal.Utils
66import Network.Transport.Test (TestTransport(..))
77
8+import Control.Applicative ((<*))
89import Control.Concurrent (threadDelay)
910import Control.Concurrent.MVar
1011 ( MVar
@@ -19,9 +20,13 @@ import Control.Distributed.Process.Debug
1920import Control.Distributed.Process.Management
2021 ( MxEvent(..)
2122 )
23+import qualified Control.Exception as IO (bracket)
24+import Data.List (isPrefixOf, isSuffixOf)
2225
2326#if ! MIN_VERSION_base(4,6,0)
2427import Prelude hiding (catch, log)
28+#else
29+import Prelude hiding ((<*))
2530#endif
2631
2732import Test.Framework
@@ -29,6 +34,10 @@ import Test.Framework
2934 , testGroup
3035 )
3136import Test.Framework.Providers.HUnit (testCase)
37+import System.Environment (getEnvironment)
38+-- These are available in System.Environment only since base 4.7
39+import System.SetEnv (setEnv, unsetEnv)
40+
3241
3342testSpawnTracing :: TestResult Bool -> Process ()
3443testSpawnTracing result = do
@@ -116,9 +125,11 @@ testTraceSending result = do
116125 (\ev ->
117126 case ev of
118127 (MxSent to from msg) -> do
119− (Just s) <- unwrapMessage msg :: Process (Maybe String)
120− stash res (to == pid && from == self && s == "hello there")
121− stash res (to == pid && from == self)
128+ mS <- unwrapMessage msg :: Process (Maybe String)
129+ case mS of
130+ (Just s) -> do stash res (to == pid && from == self && s == "hello there")
131+ stash res (to == pid && from == self)
132+ _ -> die "failed state invariant, message type unmatched..."
122133 _ ->
123134 return ()) $ do
124135 send pid "hello there"
@@ -237,12 +248,8 @@ testRemoteTraceRelay TestTransport{..} result =
237248 -- Here we set up that relay, and then wait for a signal
238249 -- that the tracer (on node1) has seen the expected
239250 -- MxSpawned message, at which point we're finished
240− (Just log') <- whereis "logger"
241− pid <- liftIO $ forkProcess node2 $ do
242− logRelay <- spawnLocal $ relay log'
243− reregister "logger" logRelay
244− getSelfNode >>= stash mvNid >> (expect :: Process ())
245251
252+ pid <- splinchLogger node2 mvNid
246253 nid <- liftIO $ takeMVar mvNid
247254 mref <- monitor pid
248255 observedPid <- liftIO $ newEmptyMVar
@@ -282,6 +289,96 @@ testRemoteTraceRelay TestTransport{..} result =
282289 -- and just to be polite...
283290 liftIO $ closeLocalNode node2
284291
292+ where
293+ splinchLogger n2 mv = do
294+ mLog <- whereis "logger"
295+ case mLog of
296+ Nothing -> die "no logger registered"
297+ Just log' -> do liftIO $ forkProcess n2 $ do
298+ logRelay <- spawnLocal $ relay log'
299+ reregister "logger" logRelay
300+ getSelfNode >>= stash mv >> (expect :: Process ())
301+
302+
303+-- | Sets the value of an environment variable while executing the given IO
304+-- computation and restores the preceeding value upon completion.
305+withEnv :: String -> String -> IO a -> IO a
306+withEnv var val =
307+ IO.bracket (fmap (lookup var) getEnvironment <* setEnv var val)
308+ (maybe (unsetEnv var) (setEnv var))
309+ . const
310+
311+-- | Tests that one and only one interesting trace message is produced when a
312+-- given action is performed. A message is considered interesting when the given
313+-- function return @True@.
314+testSystemLoggerMsg :: TestTransport
315+ -> Process a
316+ -> (a -> String -> Bool)
317+ -> IO ()
318+testSystemLoggerMsg t action interestingMessage =
319+ withEnv "DISTRIBUTED_PROCESS_TRACE_CONSOLE" "yes" $
320+ withEnv "DISTRIBUTED_PROCESS_TRACE_FLAGS" "pdnusrl" $ do
321+ n <- newLocalNode (testTransport t) initRemoteTable
322+
323+ runProcess n $ do
324+ self <- getSelfPid
325+ reregister "trace.logger" self
326+ a <- action
327+ let interestingMessage' (_ :: String, msg) = interestingMessage a msg
328+ -- Wait for the trace message.
329+ receiveWait [ matchIf interestingMessage' $ const $ return () ]
330+ -- Only one interesting message should arrive.
331+ expectedTimeout <- receiveTimeout
332+ 100000
333+ [ matchIf interestingMessage' $ const $ return () ]
334+ case expectedTimeout of
335+ Nothing -> return ()
336+ Just _ -> die "Unexpected message arrived..."
337+
338+
339+-- | Tests that one and only one trace message is produced when a message is
340+-- received.
341+testSystemLoggerMxReceive :: TestTransport -> IO ()
342+testSystemLoggerMxReceive t = testSystemLoggerMsg t
343+ (getSelfPid >>= flip send ())
344+ (\_ msg -> "MxReceived" `isPrefixOf` msg
345+ -- discard traces of internal messages
346+ && not (":: RegisterReply" `isSuffixOf` msg)
347+ )
348+
349+-- | Tests that one and only one trace message is produced when a message is
350+-- sent.
351+testSystemLoggerMxSent :: TestTransport -> IO ()
352+testSystemLoggerMxSent t = testSystemLoggerMsg t
353+ (getSelfPid >>= flip send ())
354+ (const $ isPrefixOf "MxSent")
355+
356+-- | Tests that one and only one trace message is produced when a process dies.
357+testSystemLoggerMxProcessDied :: TestTransport -> IO ()
358+testSystemLoggerMxProcessDied t = testSystemLoggerMsg t
359+ (spawnLocal $ return ())
360+ (\pid -> isPrefixOf $ "MxProcessDied " ++ show pid)
361+
362+-- | Tests that one and only one trace message appears when a process spawns.
363+testSystemLoggerMxSpawned :: TestTransport -> IO ()
364+testSystemLoggerMxSpawned t = testSystemLoggerMsg t
365+ (spawnLocal $ return ())
366+ (\pid -> isPrefixOf $ "MxSpawned " ++ show pid)
367+
368+-- | Tests that one and only one trace message appears when a process is
369+-- registered.
370+testSystemLoggerMxRegistered :: TestTransport -> IO ()
371+testSystemLoggerMxRegistered t = testSystemLoggerMsg t
372+ (getSelfPid >>= register "a" >> getSelfPid)
373+ (\self -> isPrefixOf $ "MxRegistered " ++ show self ++ " " ++ show "a")
374+
375+-- | Tests that one and only one trace message appears when a process is
376+-- unregistered.
377+testSystemLoggerMxUnRegistered :: TestTransport -> IO ()
378+testSystemLoggerMxUnRegistered t = testSystemLoggerMsg t
379+ (getSelfPid >>= register "a" >> unregister "a" >> getSelfPid)
380+ (\self -> isPrefixOf $ "MxUnRegistered " ++ show self ++ " " ++ show "a")
381+
285382tests :: TestTransport -> IO [Test]
286383tests testtrans@TestTransport{..} = do
287384 node1 <- newLocalNode testTransport initRemoteTable
@@ -323,4 +420,12 @@ tests testtrans@TestTransport{..} = do
323420 (synchronisedAssertion
324421 "expected blah"
325422 node1 True (testRemoteTraceRelay testtrans) lock)
423+ , testGroup "SystemLoggerTracer"
424+ [ testCase "MxReceive" $ testSystemLoggerMxReceive testtrans
425+ , testCase "MxSent" $ testSystemLoggerMxSent testtrans
426+ , testCase "MxProcessDied" $ testSystemLoggerMxProcessDied testtrans
427+ , testCase "MxSpawned" $ testSystemLoggerMxSpawned testtrans
428+ , testCase "MxRegistered" $ testSystemLoggerMxRegistered testtrans
429+ , testCase "MxUnRegistered" $ testSystemLoggerMxUnRegistered testtrans
430+ ]
326431 ] ]
distributed-process-tests/tests/runInMemory.hs−1
@@ -8,7 +8,6 @@ import Network.Transport.Test (TestTransport(..))
88import Network.Transport.InMemory
99import Test.Framework (defaultMainWithArgs)
1010
11−import Control.Concurrent (threadDelay)
1211import System.Environment (getArgs)
1312
1413main :: IO ()
distributed-process-tests/tests/runTCP.hs+10−3
@@ -10,21 +10,28 @@ import Network.Transport.TCP
1010 ( createTransportExposeInternals
1111 , TransportInternals(socketBetween)
1212 , defaultTCPParameters
13+ , defaultTCPAddr
14+ , TCPParameters(..)
1315 )
1416import Test.Framework (defaultMainWithArgs)
1517
1618import Control.Concurrent (threadDelay)
19+import Control.Exception (IOException, try)
1720import System.Environment (getArgs)
21+import System.IO
1822
1923main :: IO ()
2024main = do
25+ hSetBuffering stdout LineBuffering
26+ hSetBuffering stderr LineBuffering
2127 Right (transport, internals) <-
22− createTransportExposeInternals "127.0.0.1" "8080" defaultTCPParameters
28+ createTransportExposeInternals (defaultTCPAddr "127.0.0.1" "8080")
29+ defaultTCPParameters { transportConnectTimeout = Just 3000000 }
2330 ts <- tests TestTransport
2431 { testTransport = transport
2532 , testBreakConnection = \addr1 addr2 -> do
26− sock <- socketBetween internals addr1 addr2
27− sClose sock
33+ esock <- try $ socketBetween internals addr1 addr2
34+ either (\e -> const (return ()) (e :: IOException)) sClose esock
2835 threadDelay 10000
2936 }
3037 args <- getArgs
distributed-process.cabal+51−37
@@ -1,12 +1,12 @@
11Name: distributed-process
2−Version: 0.5.3
2+Version: 0.7.4
33Cabal-Version: >=1.8
44Build-Type: Simple
55License: BSD3
66License-File: LICENSE
77Copyright: Well-Typed LLP, Tweag I/O Limited
88Author: Duncan Coutts, Nicolas Wu, Edsko de Vries
9−Maintainer: watson.timothy@gmail.com, edsko@well-typed.com, duncan@well-typed.com
9+Maintainer: Tim Watson <watson.timothy@gmail.com>
1010Stability: experimental
1111Homepage: http://haskell-distributed.github.com/
1212Bug-Reports: https://github.com/haskell-distributed/distributed-process/issues
@@ -21,7 +21,7 @@ Description: This is an implementation of Cloud Haskell, as described in
2121
2222 You will probably also want to install a Cloud Haskell backend such
2323 as distributed-process-simplelocalnet.
24−Tested-With: GHC==7.2.2 GHC==7.4.1 GHC==7.4.2 GHC==7.6.2
24+Tested-With: GHC==7.10.3 GHC==8.0.2 GHC==8.2.2 GHC==8.4.4
2525Category: Control
2626extra-source-files: ChangeLog
2727
@@ -41,23 +41,26 @@ flag old-locale
4141 default: False
4242
4343Library
44− Build-Depends: base >= 4.4 && < 5,
45− binary >= 0.6.3 && < 0.8,
44+ Build-Depends: base >= 4.6 && < 5,
45+ binary >= 0.6.3 && < 0.10,
4646 hashable >= 1.2.0.5 && < 1.3,
47− network-transport >= 0.4.1.0 && < 0.5,
48− stm >= 2.4 && < 2.5,
49− transformers >= 0.2 && < 0.5,
47+ network-transport >= 0.4.1.0 && < 0.6,
48+ stm >= 2.4 && < 2.6,
49+ transformers >= 0.2 && < 0.6,
5050 mtl >= 2.0 && < 2.4,
5151 data-accessor >= 0.2 && < 0.3,
5252 bytestring >= 0.9 && < 0.11,
5353 random >= 1.0 && < 1.2,
54− ghc-prim >= 0.2 && < 0.5,
5554 distributed-static >= 0.2 && < 0.4,
56− rank1dynamic >= 0.1 && < 0.4,
57− syb >= 0.3 && < 0.7
55+ rank1dynamic >= 0.1 && < 0.5,
56+ syb >= 0.3 && < 0.8,
57+ exceptions >= 0.5,
58+ containers >= 0.5 && < 0.7,
59+ deepseq >= 1.3.0.1 && < 1.6
5860 Exposed-modules: Control.Distributed.Process,
5961 Control.Distributed.Process.Closure,
6062 Control.Distributed.Process.Debug,
63+ Control.Distributed.Process.Internal.BiMultiMap,
6164 Control.Distributed.Process.Internal.Closure.BuiltIn,
6265 Control.Distributed.Process.Internal.Closure.Explicit,
6366 Control.Distributed.Process.Internal.CQueue,
@@ -75,7 +78,6 @@ Library
7578 Control.Distributed.Process.UnsafePrimitives
7679 Control.Distributed.Process.Management.Internal.Agent,
7780 Control.Distributed.Process.Management.Internal.Bus,
78− Control.Distributed.Process.Management.Internal.Table,
7981 Control.Distributed.Process.Management.Internal.Types,
8082 Control.Distributed.Process.Management.Internal.Trace.Primitives,
8183 Control.Distributed.Process.Management.Internal.Trace.Remote,
@@ -83,21 +85,33 @@ Library
8385 Control.Distributed.Process.Management.Internal.Trace.Tracer
8486 ghc-options: -Wall
8587 HS-Source-Dirs: src
86− if impl(ghc <= 7.4.2)
87− Build-Depends: containers >= 0.4 && < 0.5,
88− deepseq == 1.3.0.0
89− else
90− Build-Depends: containers >= 0.4 && < 0.6,
91− deepseq >= 1.3.0.1 && < 1.6
88+ other-extensions: BangPatterns
89+ CPP
90+ DeriveDataTypeable
91+ DeriveFunctor
92+ DeriveGeneric
93+ ExistentialQuantification
94+ FlexibleInstances
95+ GADTs
96+ GeneralizedNewtypeDeriving
97+ KindSignatures
98+ MagicHash
99+ PatternGuards
100+ RankNTypes
101+ RecordWildCards
102+ ScopedTypeVariables
103+ StandaloneDeriving
104+ TypeFamilies
105+ TypeSynonymInstances
106+ UnboxedTuples
107+ UndecidableInstances
92108 if flag(old-locale)
93109 Build-Depends: time < 1.5, old-locale >= 1.0 && <1.1
94110 else
95111 Build-Depends: time >= 1.5
96112 if flag(th)
97− if impl(ghc <= 7.4.2)
98− Build-Depends: template-haskell >= 2.7 && < 2.8
99− else
100− Build-Depends: template-haskell >= 2.6 && < 2.11
113+ other-extensions: TemplateHaskell
114+ Build-Depends: template-haskell >= 2.6
101115 Exposed-modules: Control.Distributed.Process.Internal.Closure.TH
102116 CPP-Options: -DTemplateHaskellSupport
103117
@@ -105,50 +119,50 @@ Library
105119
106120benchmark distributed-process-throughput
107121 Type: exitcode-stdio-1.0
108− Build-Depends: base >= 4.4 && < 5,
122+ Build-Depends: base >= 4.6 && < 5,
109123 distributed-process,
110− network-transport-tcp >= 0.3 && < 0.5,
124+ network-transport-tcp >= 0.3 && < 0.7,
111125 bytestring >= 0.9 && < 0.11,
112− binary >= 0.6.3 && < 0.8
126+ binary >= 0.6.3 && < 0.10
113127 Main-Is: benchmarks/Throughput.hs
114128 ghc-options: -Wall
115129
116130benchmark distributed-process-latency
117131 Type: exitcode-stdio-1.0
118− Build-Depends: base >= 4.4 && < 5,
132+ Build-Depends: base >= 4.6 && < 5,
119133 distributed-process,
120− network-transport-tcp >= 0.3 && < 0.5,
134+ network-transport-tcp >= 0.3 && < 0.7,
121135 bytestring >= 0.9 && < 0.11,
122− binary >= 0.6.3 && < 0.8
136+ binary >= 0.6.3 && < 0.10
123137 Main-Is: benchmarks/Latency.hs
124138 ghc-options: -Wall
125139
126140benchmark distributed-process-channels
127141 Type: exitcode-stdio-1.0
128− Build-Depends: base >= 4.4 && < 5,
142+ Build-Depends: base >= 4.6 && < 5,
129143 distributed-process,
130− network-transport-tcp >= 0.3 && < 0.5,
144+ network-transport-tcp >= 0.3 && < 0.7,
131145 bytestring >= 0.9 && < 0.11,
132− binary >= 0.6.3 && < 0.8
146+ binary >= 0.6.3 && < 0.10
133147 Main-Is: benchmarks/Channels.hs
134148 ghc-options: -Wall
135149
136150benchmark distributed-process-spawns
137151 Type: exitcode-stdio-1.0
138− Build-Depends: base >= 4.4 && < 5,
152+ Build-Depends: base >= 4.6 && < 5,
139153 distributed-process,
140− network-transport-tcp >= 0.3 && < 0.5,
154+ network-transport-tcp >= 0.3 && < 0.7,
141155 bytestring >= 0.9 && < 0.11,
142− binary >= 0.6.3 && < 0.8
156+ binary >= 0.6.3 && < 0.10
143157 Main-Is: benchmarks/Spawns.hs
144158 ghc-options: -Wall
145159
146160benchmark distributed-process-ring
147161 Type: exitcode-stdio-1.0
148− Build-Depends: base >= 4.4 && < 5,
162+ Build-Depends: base >= 4.6 && < 5,
149163 distributed-process,
150− network-transport-tcp >= 0.3 && < 0.5,
164+ network-transport-tcp >= 0.3 && < 0.7,
151165 bytestring >= 0.9 && < 0.11,
152− binary >= 0.6.3 && < 0.8
166+ binary >= 0.6.3 && < 0.10
153167 Main-Is: benchmarks/ProcessRing.hs
154168 ghc-options: -Wall -threaded -O2 -rtsopts
src/Control/Distributed/Process.hs+42−12
@@ -40,8 +40,10 @@ module Control.Distributed.Process
4040 , mergePortsRR
4141 -- * Unsafe messaging variants
4242 , unsafeSend
43+ , unsafeUSend
4344 , unsafeSendChan
4445 , unsafeNSend
46+ , unsafeNSendRemote
4547 , unsafeWrapMessage
4648 -- * Advanced messaging
4749 , Match
@@ -100,6 +102,7 @@ module Control.Distributed.Process
100102 , monitorPort
101103 , unmonitor
102104 , withMonitor
105+ , withMonitor_
103106 , MonitorRef -- opaque
104107 , ProcessLinkException(..)
105108 , NodeLinkException(..)
@@ -157,13 +160,10 @@ module Control.Distributed.Process
157160 , reconnectPort
158161 ) where
159162
160−#if ! MIN_VERSION_base(4,6,0)
161−import Prelude hiding (catch)
162−#endif
163−
164163import Control.Monad.IO.Class (liftIO)
165−import Control.Applicative ((<$>))
164+import Control.Applicative
166165import Control.Monad.Reader (ask)
166+import Control.Concurrent (killThread)
167167import Control.Concurrent.MVar
168168 ( MVar
169169 , newEmptyMVar
@@ -198,6 +198,7 @@ import Control.Distributed.Process.Internal.Types
198198 , RegisterReply(..)
199199 , LocalProcess(processNode)
200200 , Message
201+ , localProcessWithId
201202 )
202203import Control.Distributed.Process.Serializable (Serializable)
203204import Control.Distributed.Process.Internal.Primitives
@@ -212,8 +213,10 @@ import Control.Distributed.Process.Internal.Primitives
212213 , mergePortsBiased
213214 , mergePortsRR
214215 , unsafeSend
216+ , unsafeUSend
215217 , unsafeSendChan
216218 , unsafeNSend
219+ , unsafeNSendRemote
217220 -- Advanced messaging
218221 , Match
219222 , receiveWait
@@ -267,6 +270,7 @@ import Control.Distributed.Process.Internal.Primitives
267270 , monitorPort
268271 , unmonitor
269272 , withMonitor
273+ , withMonitor_
270274 -- Logging
271275 , say
272276 -- Registry
@@ -303,6 +307,10 @@ import Control.Distributed.Process.Internal.Primitives
303307 , reconnectPort
304308 )
305309import Control.Distributed.Process.Node (forkProcess)
310+import Control.Distributed.Process.Internal.Types
311+ ( processThread
312+ , withValidLocalState
313+ )
306314import Control.Distributed.Process.Internal.Spawn
307315 ( -- Spawning Processes/Channels
308316 spawn
@@ -312,7 +320,17 @@ import Control.Distributed.Process.Internal.Spawn
312320 , spawnSupervised
313321 , call
314322 )
315−import Control.Exception (SomeException, throw)
323+import qualified Control.Monad.Catch as Catch
324+
325+#if MIN_VERSION_base(4,6,0)
326+import Prelude
327+#else
328+import Prelude hiding (catch)
329+#endif
330+import qualified Control.Exception as Exception (onException)
331+import Data.Accessor ((^.))
332+import Data.Foldable (forM_)
333+
316334
317335-- INTERNAL NOTES
318336--
@@ -409,9 +427,21 @@ spawnChannelLocal proc = do
409427-- or duplicate messages sent to the isolated process after it exits.
410428-- Silently dropping messages may not always be the best approach.
411429callLocal :: Process a -> Process a
412−callLocal proc = mask $ \release -> do
413− mv <- liftIO newEmptyMVar :: Process (MVar (Either SomeException a))
414− child <- spawnLocal $ try (release proc) >>= liftIO . putMVar mv
415− rs <- liftIO (takeMVar mv) `onException`
416− (kill child "exception in parent process" >> liftIO (takeMVar mv))
417− either throw return rs
430+callLocal proc = Catch.mask $ \release -> do
431+ mv <- liftIO newEmptyMVar :: Process (MVar (Either Catch.SomeException a))
432+ child <- spawnLocal $ Catch.try (release proc) >>= liftIO . putMVar mv
433+ lproc <- ask
434+ liftIO $ do
435+ rs <- Exception.onException (takeMVar mv) $ Catch.uninterruptibleMask_ $
436+ -- Exceptions need to be prevented from interrupting the clean up or
437+ -- the original exception which caused entering the handler could be
438+ -- forgotten. For instance, this could have a problematic effect
439+ -- when the original exception was meant to kill the thread and the
440+ -- second exception doesn't (like the exception thrown by
441+ -- 'System.Timeout.timeout').
442+ do mchildThreadId <- withValidLocalState (processNode lproc) $
443+ \vst -> return $ fmap processThread $
444+ vst ^. localProcessWithId (processLocalId child)
445+ forM_ mchildThreadId killThread
446+ takeMVar mv
447+ either Catch.throwM return rs
src/Control/Distributed/Process/Debug.hs+10−14
@@ -83,13 +83,13 @@
8383-- environment variable accepts the following flags, which enable tracing specific
8484-- event types:
8585--
86−-- p = trace the spawning of new processes
87−-- d = trace the death of processes
88−-- n = trace registration of names (i.e., named processes)
89−-- u = trace un-registration of names (i.e., named processes)
90−-- s = trace the sending of messages to other processes
91−-- r = trace the receipt of messages from other processes
92−-- l = trace node up/down events
86+-- * @p@ = trace the spawning of new processes
87+-- * @d@ = trace the death of processes
88+-- * @n@ = trace registration of names (i.e., named processes)
89+-- * @u@ = trace un-registration of names (i.e., named processes)
90+-- * @s@ = trace the sending of messages to other processes
91+-- * @r@ = trace the receipt of messages from other processes
92+-- * @l@ = trace node up/down events
9393--
9494-- Users of the /simplelocalnet/ Cloud Haskell backend should also note that
9595-- because the trace file option only supports trace output from a single node
@@ -141,17 +141,14 @@ module Control.Distributed.Process.Debug
141141 )
142142 where
143143
144−import Control.Applicative ((<$>))
144+import Control.Applicative
145145import Control.Distributed.Process.Internal.Primitives
146146 ( proxy
147− , finally
148147 , die
149148 , whereis
150149 , send
151150 , receiveWait
152151 , matchIf
153− , finally
154− , try
155152 , monitor
156153 )
157154import Control.Distributed.Process.Internal.Types
@@ -196,12 +193,11 @@ import Control.Exception (SomeException)
196193
197194import Control.Monad.IO.Class (liftIO)
198195import Control.Monad.Reader (ask)
196+import Control.Monad.Catch (finally, try)
199197
200198import Data.Binary()
201199
202−#if ! MIN_VERSION_base(4,6,0)
203−import Prelude hiding (catch)
204−#endif
200+import Prelude
205201
206202--------------------------------------------------------------------------------
207203-- Debugging/Tracing API --
src/Control/Distributed/Process/Internal/BiMultiMap.hsnew file+135
@@ -0,0 +1,135 @@
1+-- | This is an implementation of bidirectional multimaps.
2+module Control.Distributed.Process.Internal.BiMultiMap
3+ ( BiMultiMap
4+ , empty
5+ , singleton
6+ , size
7+ , insert
8+ , lookupBy1st
9+ , lookupBy2nd
10+ , delete
11+ , deleteAllBy1st
12+ , deleteAllBy2nd
13+ , partitionWithKeyBy1st
14+ , partitionWithKeyBy2nd
15+ , flip
16+ ) where
17+
18+import Data.List (foldl')
19+import Data.Map.Strict (Map)
20+import qualified Data.Map.Strict as Map
21+import Data.Set (Set)
22+import qualified Data.Set as Set
23+import Prelude hiding (flip, lookup)
24+
25+-- | A bidirectional multimaps @BiMultiMap a b v@ is a set of triplets of type
26+-- @(a, b, v)@.
27+--
28+-- It is possible to lookup values by using either @a@ or @b@ as keys.
29+--
30+data BiMultiMap a b v = BiMultiMap !(Map a (Set (b, v))) !(Map b (Set (a, v)))
31+
32+-- The bidirectional multimap is implemented with a pair of multimaps.
33+--
34+-- Each multimap represents a set of triples, and one invariant is that both
35+-- multimaps should represent exactly the same set of triples.
36+--
37+-- Each of the multimaps, however, uses a different component of the triplets
38+-- as key. This allows to do efficient deletions by any of the two components.
39+
40+-- | The empty bidirectional multimap.
41+empty :: BiMultiMap a b v
42+empty = BiMultiMap Map.empty Map.empty
43+
44+-- | A bidirectional multimap containing a single triplet.
45+singleton :: (Ord a, Ord b, Ord v) => a -> b -> v -> BiMultiMap a b v
46+singleton a b v = insert a b v empty
47+
48+-- | Yields the amount of triplets in the multimap.
49+size :: BiMultiMap a b v -> Int
50+size (BiMultiMap m _) = foldl' (+) 0 $ map Set.size $ Map.elems m
51+
52+-- | Inserts a triplet in the multimap.
53+insert :: (Ord a, Ord b, Ord v)
54+ => a -> b -> v -> BiMultiMap a b v -> BiMultiMap a b v
55+insert a b v (BiMultiMap m r) =
56+ BiMultiMap (Map.insertWith (\_new old -> Set.insert (b, v) old)
57+ a
58+ (Set.singleton (b, v))
59+ m)
60+ (Map.insertWith (\_new old -> Set.insert (a, v) old)
61+ b
62+ (Set.singleton (a, v))
63+ r)
64+
65+-- | Looks up all the triplets whose first component is the given value.
66+lookupBy1st :: Ord a => a -> BiMultiMap a b v -> Set (b, v)
67+lookupBy1st a (BiMultiMap m _) = maybe Set.empty id $ Map.lookup a m
68+
69+-- | Looks up all the triplets whose second component is the given value.
70+lookupBy2nd :: Ord b => b -> BiMultiMap a b v -> Set (a, v)
71+lookupBy2nd b = lookupBy1st b . flip
72+
73+-- | Deletes a triplet. It yields the original multimap if the triplet is
74+-- not present.
75+delete :: (Ord a, Ord b, Ord v)
76+ => a -> b -> v -> BiMultiMap a b v -> BiMultiMap a b v
77+delete a b v (BiMultiMap m r) =
78+ let m' = Map.update (nothingWhen Set.null . Set.delete (b, v)) a m
79+ r' = Map.update (nothingWhen Set.null . Set.delete (a, v)) b r
80+ in BiMultiMap m' r'
81+
82+-- | Deletes all triplets whose first component is the given value.
83+deleteAllBy1st :: (Ord a, Ord b, Ord v) => a -> BiMultiMap a b v -> BiMultiMap a b v
84+deleteAllBy1st a (BiMultiMap m r) =
85+ let (mm, m') = Map.updateLookupWithKey (\_ _ -> Nothing) a m
86+ r' = case mm of
87+ Nothing -> r
88+ Just mb -> reverseDelete a (Set.toList mb) r
89+ in BiMultiMap m' r'
90+
91+-- | Like 'deleteAllBy1st' but deletes by the second component of the triplets.
92+deleteAllBy2nd :: (Ord a, Ord b, Ord v)
93+ => b -> BiMultiMap a b v -> BiMultiMap a b v
94+deleteAllBy2nd b = flip . deleteAllBy1st b . flip
95+
96+-- | Yields the triplets satisfying the given predicate, and a multimap
97+-- with all this triplets removed.
98+partitionWithKeyBy1st :: (Ord a, Ord b, Ord v)
99+ => (a -> Set (b, v) -> Bool) -> BiMultiMap a b v
100+ -> (Map a (Set (b, v)), BiMultiMap a b v)
101+partitionWithKeyBy1st p (BiMultiMap m r) =
102+ let (m0, m1) = Map.partitionWithKey p m
103+ r1 = foldl' (\rr (a, mb) -> reverseDelete a (Set.toList mb) rr) r $
104+ Map.toList m0
105+ in (m0, BiMultiMap m1 r1)
106+
107+-- | Like 'partitionWithKeyBy1st' but the predicates takes the second component
108+-- of the triplets as first argument.
109+partitionWithKeyBy2nd :: (Ord a, Ord b, Ord v)
110+ => (b -> Set (a, v) -> Bool) -> BiMultiMap a b v
111+ -> (Map b (Set (a, v)), BiMultiMap a b v)
112+partitionWithKeyBy2nd p b = let (m, b') = partitionWithKeyBy1st p $ flip b
113+ in (m, flip b')
114+
115+-- | Exchange the first and the second components of all triplets.
116+flip :: BiMultiMap a b v -> BiMultiMap b a v
117+flip (BiMultiMap m r) = BiMultiMap r m
118+
119+-- Internal functions
120+
121+-- | @reverseDelete a bs m@ removes from @m@ all the triplets wich have @a@ as
122+-- first component and second and third components in @bs@.
123+--
124+-- The @m@ map is in reversed form, meaning that the second component of the
125+-- triplets is used as key.
126+reverseDelete :: (Ord a, Ord b, Ord v)
127+ => a -> [(b, v)] -> Map b (Set (a, v)) -> Map b (Set (a, v))
128+reverseDelete a bs r = foldl' (\rr (b, v) -> Map.update (rmb v) b rr) r bs
129+ where
130+ rmb v = nothingWhen Set.null . Set.delete (a, v)
131+
132+-- | @nothingWhen p a@ is @Just a@ when @a@ satisfies predicate @p@.
133+-- Yields @Nothing@ otherwise.
134+nothingWhen :: (a -> Bool) -> a -> Maybe a
135+nothingWhen p a = if p a then Nothing else Just a
src/Control/Distributed/Process/Internal/CQueue.hs+31−2
@@ -1,3 +1,4 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveFunctor #-}
23{-# LANGUAGE BangPatterns #-}
34{-# LANGUAGE MagicHash, UnboxedTuples, PatternGuards, ScopedTypeVariables, RankNTypes #-}
@@ -46,8 +47,8 @@ import Control.Distributed.Process.Internal.StrictList
4647import Data.Maybe (fromJust)
4748import Data.Traversable (traverse)
4849import GHC.MVar (MVar(MVar))
49−import GHC.IO (IO(IO))
50−import GHC.Prim (mkWeak#)
50+import GHC.IO (IO(IO), unIO)
51+import GHC.Exts (mkWeak#)
5152import GHC.Weak (Weak(Weak))
5253
5354-- We use a TCHan rather than a Chan so that we have a non-blocking read
@@ -75,13 +76,25 @@ data BlockSpec =
7576 | Blocking
7677 | Timeout Int
7778
79+-- Match operations
80+--
81+-- They can be either a message match or a channel match.
7882data MatchOn m a
7983 = MatchMsg (m -> Maybe a)
8084 | MatchChan (STM a)
8185 deriving (Functor)
8286
87+-- Lists of chunks of matches
88+--
89+-- Two consecutive chunks never have the same kind of matches. i.e. if one chunk
90+-- contains message matches then the next one must contain channel matches and
91+-- viceversa.
8392type MatchChunks m a = [Either [m -> Maybe a] [STM a]]
8493
94+-- Splits a list of matches into chunks.
95+--
96+-- > concatMap (either (map MatchMsg) (map MatchChan)) . chunkMatches == id
97+--
8598chunkMatches :: [MatchOn m a] -> MatchChunks m a
8699chunkMatches [] = []
87100chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
@@ -89,6 +102,7 @@ chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
89102chunkMatches (MatchChan r : ms) = Right (r : chk) : chunkMatches rest
90103 where (chk, rest) = spanMatchChan ms
91104
105+-- | @spanMatchMsg = first (map (\(MatchMsg x) -> x)) . span isMatchMsg@
92106spanMatchMsg :: [MatchOn m a] -> ([m -> Maybe a], [MatchOn m a])
93107spanMatchMsg [] = ([],[])
94108spanMatchMsg (m : ms)
@@ -96,6 +110,7 @@ spanMatchMsg (m : ms)
96110 | otherwise = ([], m:ms)
97111 where !(msgs,rest) = spanMatchMsg ms
98112
113+-- | @spanMatchMsg = first (map (\(MatchChan x) -> x)) . span isMatchChan@
99114spanMatchChan :: [MatchOn m a] -> ([STM a], [MatchOn m a])
100115spanMatchChan [] = ([],[])
101116spanMatchChan (m : ms)
@@ -127,6 +142,7 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
127142 -- Decrement counter is smth is returned from the queue,
128143 -- this is safe to use as method is called under a mask
129144 -- and there is no 'unmasked' operation inside
145+ decrementJust :: IO (Maybe (Either a a)) -> IO (Maybe a)
130146 decrementJust f =
131147 traverse (either return (\x -> decrement >> return x)) =<< f
132148 decrement = atomically $ modifyTVar' size pred
@@ -143,6 +159,10 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
143159 arr' <- grabNew arr
144160 goCheck chunks arr'
145161
162+ -- Yields the value of the first succesful STM transaction as
163+ -- @Just (Left v)@. If all transactions fail, yields the value of the second
164+ -- argument.
165+ waitChans :: [STM a] -> STM (Maybe (Either a a)) -> STM (Maybe (Either a a))
146166 waitChans ports on_block =
147167 foldr orElse on_block (map (fmap (Just . Left)) ports)
148168
@@ -151,6 +171,10 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
151171 -- mailbox. For channel matches, we do a non-blocking check at
152172 -- this point.
153173 --
174+ -- Yields @Just (Left a)@ when a channel is matched, @Just (Right a)@
175+ -- when a message is matched and @Nothing@ when there are no messages and we
176+ -- aren't blocking.
177+ --
154178 goCheck :: MatchChunks m a
155179 -> StrictList m -- messages to check, in this order
156180 -> IO (Maybe (Either a a))
@@ -249,6 +273,7 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
249273 checkArrived :: [m -> Maybe a] -> StrictList m -> (StrictList m, Maybe a)
250274 checkArrived matches list = go list Nil
251275 where
276+ -- @go xs ys@ searches for a message match in @append xs ys@
252277 go Nil Nil = (Nil, Nothing)
253278 go Nil r = go r Nil
254279 go (Append xs ys) tl = go xs (append ys tl)
@@ -265,7 +290,11 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
265290-- | Weak reference to a CQueue
266291mkWeakCQueue :: CQueue a -> IO () -> IO (Weak (CQueue a))
267292mkWeakCQueue m@(CQueue (StrictMVar (MVar m#)) _ _) f = IO $ \s ->
293+#if MIN_VERSION_base(4,9,0)
294+ case mkWeak# m# m (unIO f) s of (# s1, w #) -> (# s1, Weak w #)
295+#else
268296 case mkWeak# m# m f s of (# s1, w #) -> (# s1, Weak w #)
297+#endif
269298
270299queueSize :: CQueue a -> IO Int
271300queueSize (CQueue _ _ size) = readTVarIO size
src/Control/Distributed/Process/Internal/Closure/Explicit.hs+1−2
@@ -6,7 +6,6 @@
66 , UndecidableInstances
77 , KindSignatures
88 , GADTs
9− , OverlappingInstances
109 , EmptyDataDecls
1110 , DeriveDataTypeable #-}
1211module Control.Distributed.Process.Internal.Closure.Explicit
@@ -109,7 +108,7 @@ instance Binary EndOfTuple where
109108class Curry a b | a -> b where
110109 curryFun :: a -> b
111110
112−instance Curry ((a,EndOfTuple) -> b) (a -> b) where
111+instance Curry ((a, EndOfTuple) -> b) (a -> b) where
113112 curryFun f = \x -> f (x,undefined)
114113
115114instance Curry (b -> c) r => Curry ((a,b) -> c) (a -> r) where
src/Control/Distributed/Process/Internal/Closure/TH.hs+15−7
@@ -29,11 +29,14 @@ import Language.Haskell.TH
2929 , Type(AppT, ForallT, VarT, ArrowT)
3030 , Info(VarI)
3131 , TyVarBndr(PlainTV, KindedTV)
32−#if ! MIN_VERSION_template_haskell(2,10,0)
3332 , Pred
33+#if MIN_VERSION_template_haskell(2,10,0)
34+ , conT
35+ , appT
36+#else
37+ , classP
3438#endif
3539 , varT
36− , classP
3740 -- Lifted constructors
3841 -- .. Literals
3942 , stringL
@@ -71,10 +74,6 @@ import Control.Distributed.Process.Serializable
7174 )
7275import Control.Distributed.Process.Internal.Closure.BuiltIn (staticDecode)
7376
74−#if MIN_VERSION_template_haskell(2,10,0)
75−type Pred = Type
76−#endif
77−
7877--------------------------------------------------------------------------------
7978-- User-level API --
8079--------------------------------------------------------------------------------
@@ -261,7 +260,12 @@ generateStatic n xs typ = do
261260 ]
262261 where
263262 typeable :: TyVarBndr -> Q Pred
264− typeable tv = classP (mkName "Typeable") [varT (tyVarBndrName tv)]
263+ typeable tv =
264+#if MIN_VERSION_template_haskell(2,10,0)
265+ conT (mkName "Typeable") `appT` varT (tyVarBndrName tv)
266+#else
267+ classP (mkName "Typeable") [varT (tyVarBndrName tv)]
268+#endif
265269
266270-- | Generate a serialization dictionary with name 'n' for type 'typ'
267271generateDict :: Name -> Type -> Q [Dec]
@@ -299,7 +303,11 @@ getType :: Name -> Q (Name, Type)
299303getType name = do
300304 info <- reify name
301305 case info of
306+#if MIN_VERSION_template_haskell(2,11,0)
307+ VarI origName typ _ -> return (origName, typ)
308+#else
302309 VarI origName typ _ _ -> return (origName, typ)
310+#endif
303311 _ -> fail $ show name ++ " not found"
304312
305313-- | Variation on 'funD' which takes a single expression to define the function
src/Control/Distributed/Process/Internal/Messaging.hs+2−2
@@ -30,7 +30,7 @@ import qualified Network.Transport as NT
3030 , close
3131 )
3232import Control.Distributed.Process.Internal.Types
33− ( LocalNode(localState, localEndPoint, localCtrlChan)
33+ ( LocalNode(localEndPoint, localCtrlChan)
3434 , withValidLocalState
3535 , modifyValidLocalState
3636 , modifyValidLocalState_
@@ -201,7 +201,7 @@ sendCtrlMsg mNid signal = do
201201 liftIO $ writeChan (localCtrlChan (processNode proc)) $! msg
202202 Just nid ->
203203 liftIO $ sendBinary (processNode proc)
204− (ProcessIdentifier (processId proc))
204+ (NodeIdentifier (processNodeId $ processId proc))
205205 (NodeIdentifier nid)
206206 WithImplicitReconnect
207207 msg
src/Control/Distributed/Process/Internal/Primitives.hs+187−102
@@ -23,8 +23,10 @@ module Control.Distributed.Process.Internal.Primitives
2323 , mergePortsRR
2424 -- * Unsafe messaging variants
2525 , unsafeSend
26+ , unsafeUSend
2627 , unsafeSendChan
2728 , unsafeNSend
29+ , unsafeNSendRemote
2830 -- * Advanced messaging
2931 , Match
3032 , receiveWait
@@ -74,8 +76,11 @@ module Control.Distributed.Process.Internal.Primitives
7476 , unlink
7577 , monitor
7678 , unmonitor
79+ , unmonitorAsync
7780 , withMonitor
81+ , withMonitor_
7882 -- * Logging
83+ , SayMessage(..)
7984 , say
8085 -- * Registry
8186 , register
@@ -123,8 +128,9 @@ module Control.Distributed.Process.Internal.Primitives
123128import Prelude hiding (catch)
124129#endif
125130
126−import Data.Binary (decode)
127−import Data.Time.Clock (getCurrentTime)
131+import Data.Binary (Binary(..), Put, Get, decode)
132+import Data.Time.Clock (getCurrentTime, UTCTime(..))
133+import Data.Time.Calendar (Day(..))
128134import Data.Time.Format (formatTime)
129135#if MIN_VERSION_time(1,5,0)
130136import Data.Time.Format (defaultTimeLocale)
@@ -132,12 +138,17 @@ import Data.Time.Format (defaultTimeLocale)
132138import System.Locale (defaultTimeLocale)
133139#endif
134140import System.Timeout (timeout)
135−import Control.Monad (when)
141+import Control.Monad (when, void)
136142import Control.Monad.Reader (ask)
137143import Control.Monad.IO.Class (liftIO)
138−import Control.Applicative ((<$>))
139−import Control.Exception (Exception(..), throw, throwIO, SomeException)
140−import qualified Control.Exception as Ex (catch, mask, mask_, try)
144+import Control.Monad.Catch
145+ ( Exception
146+ , SomeException
147+ , throwM
148+ , fromException
149+ )
150+import qualified Control.Monad.Catch as Catch
151+import Control.Applicative
141152import Control.Distributed.Process.Internal.StrictMVar
142153 ( StrictMVar
143154 , modifyMVar
@@ -177,6 +188,7 @@ import Control.Distributed.Process.Internal.Types
177188 , SpawnRef(..)
178189 , ProcessSignal(..)
179190 , NodeMonitorNotification(..)
191+ , ProcessMonitorNotification(..)
180192 , monitorCounter
181193 , spawnCounter
182194 , SendPort(..)
@@ -201,7 +213,6 @@ import Control.Distributed.Process.Internal.Types
201213 , isEncoded
202214 , createMessage
203215 , createUnencodedMessage
204− , runLocalProcess
205216 , ImplicitReconnect( NoImplicitReconnect)
206217 , LocalProcessState
207218 , LocalSendPortId
@@ -225,6 +236,7 @@ import Control.Distributed.Process.Internal.WeakTQueue
225236 , readTQueue
226237 , mkWeakTQueue
227238 )
239+import Prelude
228240
229241import Unsafe.Coerce
230242
@@ -242,17 +254,15 @@ send them msg = do
242254 node = processNode proc
243255 nodeId = localNodeId node
244256 destNode = (processNodeId them) in do
245− case destNode == nodeId of
246− True -> sendLocal them msg
247− False -> liftIO $ sendMessage (processNode proc)
248− (ProcessIdentifier (processId proc))
249− (ProcessIdentifier them)
250− NoImplicitReconnect
251− msg
252− -- We do not fire the trace event until after the sending is complete;
253− -- In the remote case, 'sendMessage' can block in the networking stack.
254257 liftIO $ traceEvent (localEventBus node)
255258 (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
256266
257267-- | /Unsafe/ variant of 'send'. This function makes /no/ attempt to serialize
258268-- and (in the case when the destination process resides on the same local
@@ -272,13 +282,23 @@ unsafeSend = Unsafe.send
272282--
273283usend :: Serializable a => ProcessId -> a -> Process ()
274284usend them msg = do
275− here <- getSelfNode
285+ proc <- ask
276286 let there = processNodeId them
277− if here == there
287+ let (us, node) = (processId proc, processNode proc)
288+ let msg' = wrapMessage msg
289+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg')
290+ if localNodeId (processNode proc) == there
278291 then sendLocal them msg
279292 else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
280293 (createMessage msg)
281294
295+-- | /Unsafe/ variant of 'usend'. This function makes /no/ attempt to serialize
296+-- the message when the destination process resides on the same local
297+-- node. Therefore, a local receiver would need to be prepared to cope with any
298+-- errors resulting from evaluation of the message.
299+unsafeUSend :: Serializable a => ProcessId -> a -> Process ()
300+unsafeUSend = Unsafe.usend
301+
282302-- | Wait for a message of a specific type
283303expect :: forall a. Serializable a => Process a
284304expect = receiveWait [match return]
@@ -287,7 +307,13 @@ expect = receiveWait [match return]
287307-- Channels --
288308--------------------------------------------------------------------------------
289309
290−-- | Create a new typed channel
310+-- | Create a new typed channel, bound to the calling Process
311+--
312+-- Note that the channel is bound to the lifecycle of the process that evaluates
313+-- this function, such that when it dies/exits, the channel will no longer
314+-- function, but will remain accessible. Thus reading from the ReceivePort will
315+-- fail silently thereafter, blocking indefinitely (unless a timeout is used).
316+--
291317newChan :: Serializable a => Process (SendPort a, ReceivePort a)
292318newChan = do
293319 proc <- ask
@@ -315,13 +341,16 @@ newChan = do
315341sendChan :: Serializable a => SendPort a -> a -> Process ()
316342sendChan (SendPort cid) msg = do
317343 proc <- ask
318− let node = localNodeId (processNode proc)
319− destNode = processNodeId (sendPortProcessId cid) in do
320− case destNode == node of
344+ let node = processNode proc
345+ pid = processId proc
346+ us = localNodeId node
347+ them = processNodeId (sendPortProcessId cid) in do
348+ liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid $ wrapMessage msg)
349+ case them == us of
321350 True -> sendChanLocal cid msg
322351 False -> do
323− liftIO $ sendBinary (processNode proc)
324− (ProcessIdentifier (processId proc))
352+ liftIO $ sendBinary node
353+ (ProcessIdentifier pid)
325354 (SendPortIdentifier cid)
326355 NoImplicitReconnect
327356 msg
@@ -382,8 +411,11 @@ newtype Match b = Match { unMatch :: MatchOn Message (Process b) }
382411receiveWait :: [Match b] -> Process b
383412receiveWait ms = do
384413 queue <- processQueue <$> ask
385− Just proc <- liftIO $ dequeue queue Blocking (map unMatch ms)
386− proc
414+ mProc <- liftIO $ dequeue queue Blocking (map unMatch ms)
415+ case mProc of
416+ Just proc' -> proc'
417+ Nothing -> die $ "System Invariant Violation: CQueue.hs returned `Nothing` "
418+ ++ "in the absence of a timeout value."
387419
388420-- | Like 'receiveWait' but with a timeout.
389421--
@@ -462,17 +494,14 @@ forward msg them = do
462494 us = processId proc
463495 nid = localNodeId node
464496 destNode = (processNodeId them) in do
465− case destNode == nid of
466− True -> sendCtrlMsg Nothing (LocalSend them msg)
467− False -> liftIO $ sendPayload (processNode proc)
468− (ProcessIdentifier (processId proc))
469− (ProcessIdentifier them)
470− NoImplicitReconnect
471− (messageToPayload msg)
472− -- We do not fire the trace event until after the sending is complete;
473− -- In the remote case, 'sendMessage' can block in the networking stack.
474− liftIO $ traceEvent (localEventBus node)
475− (MxSent them us msg)
497+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg)
498+ if destNode == nid
499+ then sendCtrlMsg Nothing (LocalSend them msg)
500+ else liftIO $ sendPayload (processNode proc)
501+ (ProcessIdentifier (processId proc))
502+ (ProcessIdentifier them)
503+ NoImplicitReconnect
504+ (messageToPayload msg)
476505
477506-- | Forward a raw 'Message' to the given 'ProcessId'.
478507--
@@ -486,14 +515,10 @@ uforward msg them = do
486515 us = processId proc
487516 nid = localNodeId node
488517 destNode = (processNodeId them) in do
489− case destNode == nid of
490− True -> sendCtrlMsg Nothing (LocalSend them msg)
491− False -> sendCtrlMsg (Just destNode) $ UnreliableSend (processLocalId them)
492− msg
493− -- We do not fire the trace event until after the sending is complete;
494− -- In the remote case, 'sendCtrlMsg' can block in the networking stack.
495− liftIO $ traceEvent (localEventBus node)
496− (MxSent them us msg)
518+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg)
519+ if destNode == nid
520+ then sendCtrlMsg Nothing (LocalSend them msg)
521+ else sendCtrlMsg (Just destNode) $ UnreliableSend (processLocalId them) msg
497522
498523-- | Wrap a 'Serializable' value in a 'Message'. Note that 'Message's are
499524-- 'Serializable' - like the datum they contain - but also note, deserialising
@@ -690,7 +715,7 @@ instance Exception ProcessTerminationException
690715
691716-- | Terminate immediately (throws a ProcessTerminationException)
692717terminate :: Process a
693−terminate = liftIO $ throwIO ProcessTerminationException
718+terminate = throwM ProcessTerminationException
694719
695720-- [Issue #110]
696721-- | Die immediately - throws a 'ProcessExitException' with the given @reason@.
@@ -700,7 +725,7 @@ die reason = do
700725-- could be decoded by a handler passed to 'catchExit', re-thrown or even
701726-- passed to another process via the tracing mechanism.
702727 pid <- getSelfPid
703− liftIO $ throwIO (ProcessExitException pid (createMessage reason))
728+ throwM (ProcessExitException pid (createMessage reason))
704729
705730-- | Forceful request to kill a process. Where 'exit' provides an exception
706731-- that can be caught and handled, 'kill' throws an unexposed exception type
@@ -733,12 +758,12 @@ catchExit :: forall a b . (Show a, Serializable a)
733758 => Process b
734759 -> (ProcessId -> a -> Process b)
735760 -> Process b
736−catchExit act exitHandler = catch act handleExit
761+catchExit act exitHandler = Catch.catch act handleExit
737762 where
738763 handleExit ex@(ProcessExitException from msg) =
739764 if messageFingerprint msg == fingerprint (undefined :: a)
740765 then exitHandler from decoded
741− else liftIO $ throwIO ex
766+ else throwM ex
742767 where
743768 decoded :: a
744769 -- Make sure the value is fully decoded so that we don't hang to
@@ -757,12 +782,12 @@ catchExit act exitHandler = catch act handleExit
757782catchesExit :: Process b
758783 -> [(ProcessId -> Message -> (Process (Maybe b)))]
759784 -> Process b
760−catchesExit act handlers = catch act ((flip handleExit) handlers)
785+catchesExit act handlers = Catch.catch act ((flip handleExit) handlers)
761786 where
762787 handleExit :: ProcessExitException
763788 -> [(ProcessId -> Message -> Process (Maybe b))]
764789 -> Process b
765− handleExit ex [] = liftIO $ throwIO ex
790+ handleExit ex [] = throwM ex
766791 handleExit ex@(ProcessExitException from msg) (h:hs) = do
767792 r <- h from msg
768793 case r of
@@ -871,12 +896,19 @@ monitor = monitor' . ProcessIdentifier
871896-- @withMonitor@ returns, there might still be unreceived monitor
872897-- messages in the queue.
873898--
874−withMonitor :: ProcessId -> Process a -> Process a
875−withMonitor pid code = bracket (monitor pid) unmonitor (\_ -> code)
876− -- unmonitor blocks waiting for the response, so there's a possibility
877− -- that an exception might interrupt withMonitor before the unmonitor
878− -- has completed. I think that's better than making the unmonitor
879− -- uninterruptible.
899+withMonitor :: ProcessId -> (MonitorRef -> Process a) -> Process a
900+withMonitor pid = bracket (monitor pid) unmonitor
901+
902+-- | Establishes temporary monitoring of another process.
903+--
904+-- @withMonitor_ pid code@ sets up monitoring of @pid@ for the duration
905+-- of @code@. Note: although monitoring is no longer active when
906+-- @withMonitor_@ returns, there might still be unreceived monitor
907+-- messages in the queue.
908+--
909+-- Since 0.6.1
910+withMonitor_ :: ProcessId -> Process a -> Process a
911+withMonitor_ p = withMonitor p . const
880912
881913-- | Remove a link
882914--
@@ -914,12 +946,21 @@ unlinkPort sport = do
914946-- | Remove a monitor
915947--
916948-- This has the same synchronous/asynchronous nature as 'unlink'.
949+--
950+-- ProcessMonitorNotification messages for the given MonitorRef are removed from
951+-- the mailbox.
917952unmonitor :: MonitorRef -> Process ()
918953unmonitor ref = do
919954 unmonitorAsync ref
920955 receiveWait [ matchIf (\(DidUnmonitor ref') -> ref' == ref)
921956 (\_ -> return ())
922957 ]
958+ -- Discard the notification if any. With the current NC implementation at most
959+ -- one notification is in the mailbox for any given ref.
960+ void $ receiveTimeout 0
961+ [ matchIf (\(ProcessMonitorNotification ref' _ _) -> ref' == ref)
962+ (const $ return ())
963+ ]
923964
924965--------------------------------------------------------------------------------
925966-- Exception handling --
@@ -927,56 +968,43 @@ unmonitor ref = do
927968
928969-- | Lift 'Control.Exception.catch'
929970catch :: Exception e => Process a -> (e -> Process a) -> Process a
930−catch p h = do
931− lproc <- ask
932− liftIO $ Ex.catch (runLocalProcess lproc p) (runLocalProcess lproc . h)
971+catch = Catch.catch
972+{-# DEPRECATED catch "Use Control.Monad.Catch.catch instead" #-}
933973
934974-- | Lift 'Control.Exception.try'
935975try :: Exception e => Process a -> Process (Either e a)
936−try p = do
937− lproc <- ask
938− liftIO $ Ex.try (runLocalProcess lproc p)
976+try = Catch.try
977+{-# DEPRECATED try "Use Control.Monad.Catch.try instead" #-}
939978
940979-- | Lift 'Control.Exception.mask'
941980mask :: ((forall a. Process a -> Process a) -> Process b) -> Process b
942−mask p = do
943− lproc <- ask
944− liftIO $ Ex.mask $ \restore ->
945− runLocalProcess lproc (p (liftRestore restore))
946− where
947− liftRestore :: (forall a. IO a -> IO a)
948− -> (forall a. Process a -> Process a)
949− liftRestore restoreIO = \p2 -> do
950− ourLocalProc <- ask
951− liftIO $ restoreIO $ runLocalProcess ourLocalProc p2
981+mask = Catch.mask
982+{-# DEPRECATED mask "Use Control.Monad.Catch.mask_ instead" #-}
952983
953984-- | Lift 'Control.Exception.mask_'
954985mask_ :: Process a -> Process a
955−mask_ p = do
956− lproc <- ask
957− liftIO $ Ex.mask_ $ runLocalProcess lproc p
986+mask_ = Catch.mask_
987+{-# DEPRECATED mask_ "Use Control.Monad.Catch.mask_ instead" #-}
958988
959989-- | Lift 'Control.Exception.onException'
960990onException :: Process a -> Process b -> Process a
961−onException p what = p `catch` \e -> do _ <- what
962− liftIO $ throwIO (e :: SomeException)
991+onException = Catch.onException
992+{-# DEPRECATED onException "Use Control.Monad.Catch.onException instead" #-}
963993
964994-- | Lift 'Control.Exception.bracket'
965995bracket :: Process a -> (a -> Process b) -> (a -> Process c) -> Process c
966−bracket before after thing =
967− mask $ \restore -> do
968− a <- before
969− r <- restore (thing a) `onException` after a
970− _ <- after a
971− return r
996+bracket = Catch.bracket
997+{-# DEPRECATED bracket "Use Control.Monad.Catch.bracket instead" #-}
972998
973999-- | Lift 'Control.Exception.bracket_'
9741000bracket_ :: Process a -> Process b -> Process c -> Process c
975−bracket_ before after thing = bracket before (const after) (const thing)
1001+bracket_ = Catch.bracket_
1002+{-# DEPRECATED bracket_ "Use Control.Monad.Catch.bracket_ instead" #-}
9761003
9771004-- | Lift 'Control.Exception.finally'
9781005finally :: Process a -> Process b -> Process a
979−finally a sequel = bracket_ (return ()) sequel a
1006+finally = Catch.finally
1007+{-# DEPRECATED finally "Use Control.Monad.Catch.finally instead" #-}
9801008
9811009-- | You need this when using 'catches'
9821010data Handler a = forall e . Exception e => Handler (e -> Process a)
@@ -986,10 +1014,10 @@ instance Functor Handler where
9861014
9871015-- | Lift 'Control.Exception.catches'
9881016catches :: Process a -> [Handler a] -> Process a
989−catches proc handlers = proc `catch` catchesHandler handlers
1017+catches proc handlers = proc `Catch.catch` catchesHandler handlers
9901018
9911019catchesHandler :: [Handler a] -> SomeException -> Process a
992−catchesHandler handlers e = foldr tryHandler (throw e) handlers
1020+catchesHandler handlers e = foldr tryHandler (throwM e) handlers
9931021 where tryHandler (Handler handler) res
9941022 = case fromException e of
9951023 Just e' -> handler e'
@@ -1058,17 +1086,52 @@ unlinkPortAsync (SendPort cid) =
10581086-- Logging --
10591087--------------------------------------------------------------------------------
10601088
1089+data SayMessage = SayMessage { sayTime :: UTCTime
1090+ , sayProcess :: ProcessId
1091+ , sayMessage :: String }
1092+ deriving (Typeable)
1093+
1094+-- There is sadly no Show UTCTime instance
1095+instance Show SayMessage where
1096+ showsPrec p msg =
1097+ showParen (p >= 11)
1098+ $ showString "SayMessage "
1099+ . showString (formatTime defaultTimeLocale "%c" (sayTime msg))
1100+ . showChar ' '
1101+ . showsPrec 11 (sayProcess msg) . showChar ' '
1102+ . showsPrec 11 (sayMessage msg) . showChar ' '
1103+
1104+instance Binary SayMessage where
1105+ put s = do
1106+ putUTCTime (sayTime s)
1107+ put (sayProcess s)
1108+ put (sayMessage s)
1109+ get = SayMessage <$> getUTCTime <*> get <*> get
1110+
1111+-- Sadly there is no Binary UTCTime instance
1112+putUTCTime :: UTCTime -> Put
1113+putUTCTime (UTCTime (ModifiedJulianDay day) tod) = do
1114+ put day
1115+ put (toRational tod)
1116+
1117+getUTCTime :: Get UTCTime
1118+getUTCTime = do
1119+ day <- get
1120+ tod <- get
1121+ return $! UTCTime (ModifiedJulianDay day)
1122+ (fromRational tod)
1123+
10611124-- | Log a string
10621125--
1063−-- @say message@ sends a message (time, pid of the current process, message)
1064−-- to the process registered as 'logger'. By default, this process simply
1065−-- sends the string to 'stderr'. Individual Cloud Haskell backends might
1066−-- replace this with a different logger process, however.
1126+-- @say message@ sends a message of type 'SayMessage' with the current time and
1127+-- 'ProcessId' of the current process to the process registered as @logger@. By
1128+-- default, this process simply sends the string to @stderr@. Individual Cloud
1129+-- Haskell backends might replace this with a different logger process, however.
10671130say :: String -> Process ()
10681131say string = do
10691132 now <- liftIO getCurrentTime
10701133 us <- getSelfPid
1071− nsend "logger" (formatTime defaultTimeLocale "%c" now, us, string)
1134+ nsend "logger" (SayMessage now us string)
10721135
10731136--------------------------------------------------------------------------------
10741137-- Registry --
@@ -1103,8 +1166,10 @@ registerImpl force label pid = do
11031166--
11041167-- See comments in 'whereisRemoteAsync'
11051168registerRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
1106−registerRemoteAsync nid label pid =
1107− sendCtrlMsg (Just nid) (Register label nid (Just pid) False)
1169+registerRemoteAsync nid label pid = do
1170+ here <- getSelfNode
1171+ sendCtrlMsg (if nid == here then Nothing else Just nid)
1172+ (Register label nid (Just pid) False)
11081173
11091174reregisterRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
11101175reregisterRemoteAsync nid label pid =
@@ -1127,7 +1192,7 @@ unregister label = do
11271192handleRegistrationReply :: String -> Bool -> Maybe ProcessId -> Process ()
11281193handleRegistrationReply label ok owner =
11291194 when (not ok) $
1130− liftIO $ throwIO $ ProcessRegistrationException label owner
1195+ throwM $ ProcessRegistrationException label owner
11311196
11321197-- | Remove a process from a remote registry (asynchronous).
11331198--
@@ -1156,13 +1221,18 @@ whereis label = do
11561221-- use 'monitorNode' and take appropriate action when you receive a
11571222-- 'NodeMonitorNotification').
11581223whereisRemoteAsync :: NodeId -> String -> Process ()
1159−whereisRemoteAsync nid label =
1160− sendCtrlMsg (Just nid) (WhereIs label)
1224+whereisRemoteAsync nid label = do
1225+ here <- getSelfNode
1226+ sendCtrlMsg (if nid == here then Nothing else Just nid) (WhereIs label)
11611227
11621228-- | Named send to a process in the local registry (asynchronous)
11631229nsend :: Serializable a => String -> a -> Process ()
1164−nsend label msg =
1165− sendCtrlMsg Nothing (NamedSend label (createMessage msg))
1230+nsend label msg = do
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')
11661236
11671237-- | Named send to a process in the local registry (asynchronous).
11681238-- This function makes /no/ attempt to serialize and (in the case when the
@@ -1173,8 +1243,23 @@ unsafeNSend = Unsafe.nsend
11731243
11741244-- | Named send to a process in a remote registry (asynchronous)
11751245nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
1176−nsendRemote nid label msg =
1177− sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
1246+nsendRemote nid label msg = do
1247+ proc <- ask
1248+ let us = processId proc
1249+ let node = processNode proc
1250+ if localNodeId node == nid
1251+ 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))
1256+
1257+-- | Named send to a process in a remote registry (asynchronous)
1258+-- This function makes /no/ attempt to serialize and (in the case when the
1259+-- destination process resides on the same local node) therefore ensure that
1260+-- the payload is fully evaluated before it is delivered.
1261+unsafeNSendRemote :: Serializable a => NodeId -> String -> a -> Process ()
1262+unsafeNSendRemote = Unsafe.nsendRemote
11781263
11791264--------------------------------------------------------------------------------
11801265-- Closures --
src/Control/Distributed/Process/Internal/Spawn.hs+3−3
@@ -43,7 +43,7 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
4343 )
4444import Control.Distributed.Process.Internal.Primitives
4545 ( -- Basic messaging
46− send
46+ usend
4747 , expect
4848 , receiveWait
4949 , match
@@ -71,7 +71,7 @@ spawn nid proc = do
7171 receiveWait [
7272 matchIf (\(DidSpawn ref _) -> ref == sRef) $ \(DidSpawn _ pid) -> do
7373 unmonitor mRef
74− send pid ()
74+ usend pid ()
7575 return pid
7676 , matchIf (\(NodeMonitorNotification ref _ _) -> ref == mRef) $ \_ ->
7777 return (nullProcessId nid)
@@ -118,7 +118,7 @@ call dict nid proc = do
118118 cpDelayed us (returnCP sdictUnit ())
119119 )
120120 mResult <- receiveWait
121− [ match $ \a -> send pid () >> return (Right a)
121+ [ match $ \a -> usend pid () >> return (Right a)
122122 , matchIf (\(ProcessMonitorNotification ref _ _) -> ref == mRef)
123123 (\(ProcessMonitorNotification _ _ reason) -> return (Left reason))
124124 ]
src/Control/Distributed/Process/Internal/StrictMVar.hs+8−4
@@ -36,8 +36,8 @@ import qualified Control.Concurrent.MVar as MVar
3636#endif
3737 )
3838import GHC.MVar (MVar(MVar))
39−import GHC.IO (IO(IO))
40−import GHC.Prim (mkWeak#)
39+import GHC.IO (IO(IO), unIO)
40+import GHC.Exts (mkWeak#)
4141import GHC.Weak (Weak(Weak))
4242
4343newtype StrictMVar a = StrictMVar (MVar.MVar a)
@@ -85,5 +85,9 @@ modifyMVarMasked (StrictMVar v) f =
8585 evaluateFst (x, y) = evaluate x >> return (x, y)
8686
8787mkWeakMVar :: StrictMVar a -> IO () -> IO (Weak (StrictMVar a))
88−mkWeakMVar m@(StrictMVar (MVar m#)) f = IO $ \s ->
89− case mkWeak# m# m f s of (# s1, w #) -> (# s1, Weak w #)
88+mkWeakMVar q@(StrictMVar (MVar m#)) f = IO $ \s ->
89+#if MIN_VERSION_base(4,9,0)
90+ case mkWeak# m# q (unIO f) s of (# s', w #) -> (# s', Weak w #)
91+#else
92+ case mkWeak# m# q f s of (# s', w #) -> (# s', Weak w #)
93+#endif
src/Control/Distributed/Process/Internal/Types.hs+52−4
@@ -4,6 +4,9 @@
44{-# LANGUAGE GADTs #-}
55{-# LANGUAGE DeriveGeneric #-}
66{-# LANGUAGE CPP #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE Rank2Types #-}
710
811-- | Types used throughout the Cloud Haskell framework
912--
@@ -112,11 +115,12 @@ import Control.Concurrent (ThreadId)
112115import Control.Concurrent.Chan (Chan)
113116import Control.Concurrent.STM (STM)
114117import Control.Concurrent.STM.TChan (TChan)
118+import Control.Monad.Catch (MonadThrow(..), MonadCatch(..), MonadMask(..))
115119import qualified Network.Transport as NT (EndPoint, EndPointAddress, Connection)
116−import Control.Applicative (Applicative, Alternative, (<$>), (<*>))
120+import Control.Applicative
117121import Control.Monad.Fix (MonadFix)
118122import Control.Monad.Reader (MonadReader(..), ReaderT, runReaderT)
119−import Control.Monad.IO.Class (MonadIO)
123+import Control.Monad.IO.Class (MonadIO(..))
120124import Control.Distributed.Process.Serializable
121125 ( Fingerprint
122126 , Serializable
@@ -139,6 +143,7 @@ import qualified Control.Distributed.Process.Internal.StrictContainerAccessors a
139143
140144import Data.Hashable
141145import GHC.Generics
146+import Prelude
142147
143148--------------------------------------------------------------------------------
144149-- Node and process identifiers --
@@ -345,7 +350,50 @@ data LocalProcessState = LocalProcessState
345350newtype Process a = Process {
346351 unProcess :: ReaderT LocalProcess IO a
347352 }
348− deriving (Functor, Monad, MonadIO, MonadReader LocalProcess, Typeable, Applicative, MonadFix)
353+ deriving ( Applicative
354+ , Functor
355+ , Monad
356+ , MonadFix
357+ , MonadIO
358+ , MonadReader LocalProcess
359+ , Typeable
360+ )
361+
362+instance MonadThrow Process where
363+ throwM = liftIO . throwIO
364+instance MonadCatch Process where
365+ catch p h = do
366+ lproc <- ask
367+ liftIO $ catch (runLocalProcess lproc p) (runLocalProcess lproc . h)
368+instance MonadMask Process where
369+#if MIN_VERSION_exceptions(0,10,0)
370+ generalBracket acquire release inner = do
371+ lproc <- ask
372+ liftIO $
373+ generalBracket (runLocalProcess lproc acquire)
374+ (\a e -> runLocalProcess lproc $ release a e)
375+ (runLocalProcess lproc . inner)
376+#endif
377+ mask p = do
378+ lproc <- ask
379+ liftIO $ mask $ \restore ->
380+ runLocalProcess lproc (p (liftRestore restore))
381+ where
382+ liftRestore :: (forall a. IO a -> IO a)
383+ -> (forall a. Process a -> Process a)
384+ liftRestore restoreIO = \p2 -> do
385+ ourLocalProc <- ask
386+ liftIO $ restoreIO $ runLocalProcess ourLocalProc p2
387+ uninterruptibleMask p = do
388+ lproc <- ask
389+ liftIO $ uninterruptibleMask $ \restore ->
390+ runLocalProcess lproc (p (liftRestore restore))
391+ where
392+ liftRestore :: (forall a. IO a -> IO a)
393+ -> (forall a. Process a -> Process a)
394+ liftRestore restoreIO = \p2 -> do
395+ ourLocalProc <- ask
396+ liftIO $ restoreIO $ runLocalProcess ourLocalProc p2
349397
350398--------------------------------------------------------------------------------
351399-- Typed channels --
@@ -589,7 +637,7 @@ newtype DidUnlinkPort = DidUnlinkPort SendPortId
589637
590638-- | 'SpawnRef' are used to return pids of spawned processes
591639newtype SpawnRef = SpawnRef Int32
592− deriving (Show, Binary, Typeable, Eq)
640+ deriving (Show, Binary, Typeable, Eq, Ord)
593641
594642-- | (Asynchronius) reply from 'spawn'
595643data DidSpawn = DidSpawn SpawnRef ProcessId
src/Control/Distributed/Process/Internal/WeakTQueue.hs+7−2
@@ -1,3 +1,4 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE DeriveDataTypeable #-}
23{-# LANGUAGE MagicHash, UnboxedTuples #-}
34-- | Clone of Control.Concurrent.STM.TQueue with support for mkWeakTQueue
@@ -22,8 +23,8 @@ module Control.Distributed.Process.Internal.WeakTQueue (
2223import Prelude hiding (read)
2324import GHC.Conc
2425import Data.Typeable (Typeable)
25−import GHC.IO (IO(IO))
26−import GHC.Prim (mkWeak#)
26+import GHC.IO (IO(IO), unIO)
27+import GHC.Exts (mkWeak#)
2728import GHC.Weak (Weak(Weak))
2829
2930--------------------------------------------------------------------------------
@@ -99,4 +100,8 @@ isEmptyTQueue (TQueue read write) = do
99100
100101mkWeakTQueue :: TQueue a -> IO () -> IO (Weak (TQueue a))
101102mkWeakTQueue q@(TQueue _read (TVar write#)) f = IO $ \s ->
103+#if MIN_VERSION_base(4,9,0)
104+ case mkWeak# write# q (unIO f) s of (# s', w #) -> (# s', Weak w #)
105+#else
102106 case mkWeak# write# q f s of (# s', w #) -> (# s', Weak w #)
107+#endif
src/Control/Distributed/Process/Management.hs+41−83
@@ -76,6 +76,40 @@
7676--
7777-- * Whether messages will be taken from the mailbox first, or the event bus.
7878--
79+-- Since the event bus uses STM broadcast channels to communicate with agents,
80+-- no message written to the bus successfully can be lost.
81+--
82+-- Agents can also receive messages via their mailboxes - these are subject to
83+-- the same guarantees as all inter-process message sending.
84+--
85+-- Messages dispatched on an STM broadcast channel (i.e., management event bus)
86+-- are guaranteed to be delivered with the same FIFO ordering guarantees that
87+-- exist between two communicating processes, such that communication from the
88+-- node controller's threads (i.e., MxEvent's) will never be re-ordered, but
89+-- messages dispatched to the event bus by other processes (including, but not
90+-- limited to agents) are only guaranteed to be ordered between one sender and
91+-- one receiver.
92+--
93+-- No guarantee exists for the ordering in which messages sent to an agent's
94+-- mailbox will be delivered, vs messages dispatched via the event bus.
95+--
96+-- Because of the above, there are no ordering guarantees for messages sent
97+-- between agents, or for processes to agents, except for those that apply to
98+-- messages sent between regular processes, since agents are
99+-- implemented as such.
100+--
101+-- The event bus is serial and single threaded. Anything that is published by
102+-- the node controller will be seen in FIFO order. There are no ordering
103+-- guarantees pertaining to entries published to the event bus by other
104+-- processes or agents.
105+--
106+-- It should not be possible to see, for example, an @MxReceived@ before the
107+-- corresponding @MxSent@ event, since the places where we issue the @MxSent@
108+-- write directly to the event bus (using STM) in the calling (green) thread,
109+-- before dispatching instructions to the node controller to perform the
110+-- necessary routing to deliver the message to a process (or registered name,
111+-- or typed channel) locally or remotely.
112+--
79113-- [Management Data API]
80114--
81115-- Both management agents and clients of the API have access to a variety of
@@ -83,28 +117,8 @@
83117-- system information. Agents maintain their own internal state privately (via a
84118-- state transformer - see 'mxGetLocal' et al), however it is possible for
85119-- agents to share additional data with each other (and the outside world)
86−-- using /data tables/.
87−--
88−-- Each agent is assigned its own data table, which acts as a shared map, where
89−-- the keys are @String@s and the values are @Serializable@ datum of whatever
90−-- type the agent or its clients stores.
91−--
92−-- Because an agent's /data table/ stores its values in raw 'Message' format,
93−-- it works effectively as an /un-typed dictionary/, into which data of varying
94−-- types can be fed and later retrieved. The upside of this is that different
95−-- keys can be mapped to various types without any additional work on the part
96−-- of the developer. The downside is that the code reading these values must
97−-- know in advance what type(s) to expect, and the API provides no additional
98−-- support for handling that.
99−--
100−-- Publishing is accomplished using the 'mxPublish' and 'mxSet' APIs, whilst
101−-- querying and deletion are handled by 'mxGet', 'mxClear', 'mxPurgeTable' and
102−-- 'mxDropTable' respectively.
103−--
104−-- When a management agent terminates, their tables are left in memory despite
105−-- termination, such that an agent may resume its role (by restarting) or have
106−-- its 'MxAgentId' taken over by another subsequent agent, leaving the data
107−-- originally captured in place.
120+-- using whatever mechanism the user wishes, e.g., acidstate, or shared memory
121+-- primitives.
108122--
109123-- [Defining Agents]
110124--
@@ -164,8 +178,6 @@
164178-- > monitorNames = getSelfPid >>= nsend "name-monitor"
165179-- > monitorNames2 = getSelfPid >>= mxNotify
166180--
167−-- For some real-world examples, see the distributed-process-platform package.
168−--
169181-- [Performance, Stablity and Scalability]
170182--
171183-- /Management Agents/ offer numerous advantages over regular processes:
@@ -194,10 +206,6 @@
194206-- the event bus /and/ their own mailboxes, plus searching through the set of
195207-- event sinks (for each agent) to determine the right handler for the event.
196208--
197−-- Each management agent requires not only its own @Process@ (in which the agent
198−-- code is run), but also a peer process that provides its /data table/. These
199−-- data tables also have to be coordinated and manaaged on each agent's behalf.
200−--
201209-- [Architecture Overview]
202210--
203211-- The architecture of the management event bus is internal and subject to
@@ -264,16 +272,9 @@ module Control.Distributed.Process.Management
264272 , mxGetLocal
265273 , mxUpdateLocal
266274 , liftMX
267− -- * Mx Data API
268− , mxPublish
269− , mxSet
270− , mxGet
271− , mxClear
272− , mxPurgeTable
273− , mxDropTable
274275 ) where
275276
276−import Control.Applicative ((<$>))
277+import Control.Applicative
277278import Control.Concurrent.STM (atomically)
278279import Control.Concurrent.STM.TChan
279280 ( readTChan
@@ -281,14 +282,10 @@ import Control.Concurrent.STM.TChan
281282 , TChan
282283 )
283284import Control.Distributed.Process.Internal.Primitives
284− ( newChan
285− , nsend
286− , receiveWait
287− , matchChan
285+ ( receiveWait
288286 , matchAny
289287 , matchSTM
290288 , unwrapMessage
291− , onException
292289 , register
293290 , whereis
294291 , die
@@ -303,26 +300,26 @@ import Control.Distributed.Process.Internal.Types
303300 , unsafeCreateUnencodedMessage
304301 )
305302import Control.Distributed.Process.Management.Internal.Bus (publishEvent)
306−import qualified Control.Distributed.Process.Management.Internal.Table as Table
307303import Control.Distributed.Process.Management.Internal.Types
308304 ( MxAgentId(..)
309305 , MxAgent(..)
310306 , MxAction(..)
311307 , ChannelSelector(..)
312308 , MxAgentState(..)
313− , MxAgentStart(..)
314309 , MxSink
315310 , MxEvent(..)
316311 )
317312import Control.Distributed.Process.Serializable (Serializable)
318313import Control.Monad.IO.Class (liftIO)
319314import Control.Monad.Reader (ask)
315+import Control.Monad.Catch (onException)
320316import qualified Control.Monad.State as ST
321317 ( get
322318 , modify
323319 , lift
324320 , runStateT
325321 )
322+import Prelude
326323
327324-- | Publishes an arbitrary @Serializable@ message to the management event bus.
328325-- Note that /no attempt is made to force the argument/, therefore it is very
@@ -334,42 +331,6 @@ mxNotify msg = do
334331 bus <- localEventBus . processNode <$> ask
335332 liftIO $ publishEvent bus $ unsafeCreateUnencodedMessage msg
336333
337−-- | Publish an arbitrary @Message@ as a property in the management database.
338−--
339−-- For publishing @Serializable@ data, use 'mxSet' instead.
340−--
341−mxPublish :: MxAgentId -> String -> Message -> Process ()
342−mxPublish a k v = Table.set k v (Table.MxForAgent a)
343−
344−-- | Sets an arbitrary @Serializable@ datum against a key in the management
345−-- database. Note that /no attempt is made to force the argument/, therefore
346−-- it is very important that you do not pass unevaluated thunks that might
347−-- crash some other, arbitrary process (or management agent!) that obtains
348−-- and attempts to force the value later on.
349−--
350−mxSet :: Serializable a => MxAgentId -> String -> a -> Process ()
351−mxSet mxId key msg = do
352− Table.set key (unsafeCreateUnencodedMessage msg) (Table.MxForAgent mxId)
353−
354−-- | Fetches a property from the management database for the given key.
355−-- If the property is not set, or does not match the expected type when
356−-- typechecked (at runtime), returns @Nothing@.
357−mxGet :: Serializable a => MxAgentId -> String -> Process (Maybe a)
358−mxGet = Table.fetch . Table.MxForAgent
359−
360−-- | Clears a property from the management database using the given key.
361−-- If the key does not exist in the database, this is a noop.
362−mxClear :: MxAgentId -> String -> Process ()
363−mxClear mxId key = Table.clear key (Table.MxForAgent mxId)
364−
365−-- | Purges a table in the management database of all its stored properties.
366−mxPurgeTable :: MxAgentId -> Process ()
367−mxPurgeTable = Table.purge . Table.MxForAgent
368−
369−-- | Deletes a table from the management database.
370−mxDropTable :: MxAgentId -> Process ()
371−mxDropTable = Table.delete . Table.MxForAgent
372−
373334--------------------------------------------------------------------------------
374335-- API for writing user defined management extensions (i.e., agents) --
375336--------------------------------------------------------------------------------
@@ -489,10 +450,7 @@ mxAgentWithFinalize mxId initState handlers dtor = do
489450 return pid
490451 where
491452 start (sendTChan, recvTChan) = do
492− (sp, rp) <- newChan
493− nsend Table.mxTableCoordinator (MxAgentStart sp mxId)
494− tablePid <- receiveWait [ matchChan rp (\(p :: ProcessId) -> return p) ]
495− let nState = MxAgentState mxId sendTChan tablePid initState
453+ let nState = MxAgentState mxId sendTChan initState
496454 runAgent dtor handlers InputChan recvTChan nState
497455
498456 runAgent :: MxAgent s ()
src/Control/Distributed/Process/Management/Internal/Agent.hs+2−1
@@ -3,7 +3,7 @@
33
44module Control.Distributed.Process.Management.Internal.Agent where
55
6−import Control.Applicative ((<$>))
6+import Control.Applicative
77import Control.Concurrent (forkIO)
88import Control.Concurrent.MVar (MVar, newEmptyMVar, putMVar, takeMVar)
99import Control.Concurrent.STM (atomically)
@@ -44,6 +44,7 @@ import Control.Monad (void)
4444import Control.Monad.IO.Class (liftIO)
4545import Control.Monad.Reader (ask)
4646import GHC.Weak (Weak, deRefWeak)
47+import Prelude
4748
4849--------------------------------------------------------------------------------
4950-- Agent Controller Implementation --
src/Control/Distributed/Process/Management/Internal/Table.hsdeleted−222
@@ -1,222 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE RankNTypes #-}
4−{-# LANGUAGE DeriveGeneric #-}
5−{-# LANGUAGE RecordWildCards #-}
6−
7−module Control.Distributed.Process.Management.Internal.Table
8− ( MxTableRequest(..)
9− , MxTableId(..)
10− , mxTableCoordinator
11− , startTableCoordinator
12− , delete
13− , purge
14− , clear
15− , set
16− , get
17− , fetch
18− ) where
19−
20−import Control.Distributed.Process.Internal.Primitives
21− ( receiveWait
22− , receiveChan
23− , match
24− , matchAny
25− , matchIf
26− , matchChan
27− , send
28− , nsend
29− , sendChan
30− , getSelfPid
31− , link
32− , monitor
33− , unwrapMessage
34− , newChan
35− , withMonitor
36− )
37−import Control.Distributed.Process.Internal.Types
38− ( Process
39− , ProcessId
40− , ProcessMonitorNotification(..)
41− , SendPort
42− , ReceivePort
43− , Message
44− , unsafeCreateUnencodedMessage
45− )
46−import Control.Distributed.Process.Management.Internal.Types
47− ( MxTableId(..)
48− , MxAgentId(..)
49− , MxAgentStart(..)
50− , Fork)
51−import Control.Distributed.Process.Serializable (Serializable)
52−import Control.Monad.IO.Class (liftIO)
53−import Data.Accessor (Accessor, accessor, (^=), (^:))
54−import Data.Binary (Binary)
55−import Data.Map (Map)
56−import qualified Data.Map as Map
57−import Data.Typeable (Typeable)
58−
59−import GHC.Generics
60−
61−-- An extremely lightweight shared Map implementation, for use
62−-- by /management agents/ and their cohorts. Each agent is assigned
63−-- a table, into which any serializable @Message@ can be inserted.
64−-- Data are inserted, removed and searched for via their key, which
65−-- is a string. Tables can be purged, values can be set, fetched or
66−-- cleared/removed.
67−--
68−
69−data MxTableRequest =
70− Delete
71− | Purge
72− | Clear !String
73− | Set !String !Message
74− | Get !String !(SendPort (Maybe Message)) -- see [note: un-typed send port]
75− deriving (Typeable, Generic)
76−instance Binary MxTableRequest where
77−
78−data MxTableState = MxTableState { _name :: !String
79− , _entries :: !(Map String Message)
80− }
81−
82−type MxTables = Map MxAgentId ProcessId
83−
84−mxTableCoordinator :: String
85−mxTableCoordinator = "mx.table.coordinator"
86−
87−delete :: MxTableId -> Process ()
88−delete = sendReq Delete
89−
90−purge :: MxTableId -> Process ()
91−purge = sendReq Purge
92−
93−clear :: String -> MxTableId -> Process ()
94−clear k = sendReq (Clear k)
95−
96−set :: String -> Message -> MxTableId -> Process ()
97−set k v = sendReq (Set k v)
98−
99−fetch :: forall a. (Serializable a)
100− => MxTableId
101− -> String
102− -> Process (Maybe a)
103−fetch (MxForPid pid) key = get pid key
104−fetch mxId@(MxForAgent _) key = do
105− (sp, rp) <- newChan :: Process (SendPort (Maybe Message),
106− ReceivePort (Maybe Message))
107− sendReq (Get key sp) mxId
108− receiveChan rp >>= maybe (return Nothing)
109− (unwrapMessage :: Message -> Process (Maybe a))
110−
111−-- [note: un-typed send port]
112−-- Here, fetch uses a typed channel over a raw Message to obtain
113−-- its result, so type checking is deferred until receipt and will
114−-- be handled in the caller's thread. This is necessary because
115−-- the server portion of the code knows nothing about the types
116−-- involved, nor should it, since these tables can be used to
117−-- store arbitrary serializable data.
118−
119−get :: forall a. (Serializable a)
120− => ProcessId
121− -> String
122− -> Process (Maybe a)
123−get pid key = do
124− safeFetch pid key >>= maybe (return Nothing)
125− (unwrapMessage :: Message -> Process (Maybe a))
126−
127−safeFetch :: ProcessId -> String -> Process (Maybe Message)
128−safeFetch pid key = do
129− (sp, rp) <- newChan
130− send pid $ Get key sp
131− withMonitor pid $ do
132− receiveWait [
133− matchChan rp return
134− , matchIf (\(ProcessMonitorNotification _ pid' _) -> pid' == pid)
135− (\_ -> return $ Just (unsafeCreateUnencodedMessage ()))
136− ]
137−
138−sendReq :: MxTableRequest -> MxTableId -> Process ()
139−sendReq req tid = (resolve tid) req
140−
141−resolve :: Serializable a => MxTableId -> (a -> Process ())
142−resolve (MxForAgent agent) = \msg -> nsend mxTableCoordinator (agent, msg)
143−resolve (MxForPid pid) = \msg -> send pid msg
144−
145−startTableCoordinator :: Fork -> Process ()
146−startTableCoordinator fork = run Map.empty
147− where
148− run :: MxTables -> Process ()
149− run tables =
150− receiveWait [
151− -- note that this state change can race with MxAgentStart requests
152− match (\(ProcessMonitorNotification _ pid _) -> do
153− return $ Map.filter (/= pid) tables)
154− , match (\(MxAgentStart ch agent) -> do
155− lookupAgent tables agent >>= \(p, t) -> do
156− sendChan ch p >> return t)
157− , match (\req@(agent, tReq :: MxTableRequest) -> do
158− case tReq of
159− Get k sp -> do
160− lookupAgent tables agent >>= \(p, t) -> do
161− safeFetch p k >>= sendChan sp >> return t
162− _ -> do
163− handleRequest tables req)
164− , matchAny (\_ -> return tables) -- unrecognised messages are dropped
165− ] >>= run
166−
167− handleRequest :: MxTables
168− -> (MxAgentId, MxTableRequest)
169− -> Process MxTables
170− handleRequest tables' (agent, req) = do
171− lookupAgent tables' agent >>= \(p, t) -> send p req >> return t
172−
173− lookupAgent :: MxTables -> MxAgentId -> Process (ProcessId, MxTables)
174− lookupAgent tables' agentId' = do
175− case Map.lookup agentId' tables' of
176− Nothing -> launchNew agentId' tables'
177− Just p -> return (p, tables')
178−
179− launchNew :: MxAgentId
180− -> MxTables
181− -> Process (ProcessId, MxTables)
182− launchNew mxId tblMap = do
183− let initState = MxTableState { _name = (agentId mxId)
184− , _entries = Map.empty
185− }
186− (pid, _) <- spawnSup $ tableHandler initState
187− return $ (pid, mxId `seq` pid `seq` Map.insert mxId pid tblMap)
188−
189− spawnSup proc = do
190− us <- getSelfPid
191− -- we need to use that passed in "fork", in order to
192− -- break an import cycle with Node.hs courtesy of the
193− -- management agent, API and tracing modules
194− them <- liftIO $ fork $ link us >> proc
195− ref <- monitor them
196− return (them, ref)
197−
198−tableHandler :: MxTableState -> Process ()
199−tableHandler state = do
200− ns <- receiveWait [
201− match (handleTableRequest state)
202− , matchAny (\_ -> return (Just state))
203− ]
204− case ns of
205− Nothing -> return ()
206− Just s' -> tableHandler s'
207− where
208− handleTableRequest _ Delete = return Nothing
209− handleTableRequest st Purge = return $ Just $ (entries ^= Map.empty) $ st
210− handleTableRequest st (Clear k) = return $ Just $ (entries ^: (k `seq` Map.delete k)) $ st
211− handleTableRequest st (Set k v) = return $ Just $ (entries ^: (k `seq` v `seq` Map.insert k v)) st
212− handleTableRequest st (Get k c) = getEntry k c st >> return (Just st)
213−
214−getEntry :: String
215− -> SendPort (Maybe Message)
216− -> MxTableState
217− -> Process ()
218−getEntry k m MxTableState{..} = do
219− sendChan m =<< return (Map.lookup k _entries)
220−
221−entries :: Accessor MxTableState (Map String Message)
222−entries = accessor _entries (\ls st -> st { _entries = ls })
src/Control/Distributed/Process/Management/Internal/Trace/Primitives.hs+10−3
@@ -28,11 +28,12 @@ module Control.Distributed.Process.Management.Internal.Trace.Primitives
2828 , withRegisteredTracer
2929 ) where
3030
31−import Control.Applicative ((<$>))
31+import Control.Applicative
3232import Control.Distributed.Process.Internal.Primitives
3333 ( whereis
3434 , newChan
3535 , receiveChan
36+ , die
3637 )
3738import Control.Distributed.Process.Management.Internal.Trace.Types
3839 ( TraceArg(..)
@@ -67,6 +68,7 @@ import Control.Monad.IO.Class (liftIO)
6768import Control.Monad.Reader (ask)
6869
6970import qualified Data.Set as Set (fromList)
71+import Prelude
7072
7173--------------------------------------------------------------------------------
7274-- Main API --
@@ -167,6 +169,11 @@ withRegisteredTracer act = do
167169 withLocalTracer $ \t -> liftIO $ Tracer.getCurrentTraceClient t sp
168170 currentTracer <- receiveChan rp
169171 case currentTracer of
170− Nothing -> do { (Just p') <- whereis "tracer.initial"; act p' }
172+ Nothing -> do mTP <- whereis "tracer.initial"
173+ -- NB: this should NOT ever happen, but forcing pattern matches
174+ -- is not considered cool in later versions of MonadFail
175+ case mTP of
176+ Just p' -> act p'
177+ Nothing -> die $ "System Invariant Violation: Tracer Process "
178+ ++ "Name Not Found (whereis tracer.initial)"
171179 (Just p) -> act p
172−
src/Control/Distributed/Process/Management/Internal/Trace/Tracer.hs+7−4
@@ -11,7 +11,7 @@ module Control.Distributed.Process.Management.Internal.Trace.Tracer
1111 , eventLogTracer
1212 ) where
1313
14−import Control.Applicative ((<$>))
14+import Control.Applicative
1515import Control.Concurrent.Chan (writeChan)
1616import Control.Concurrent.MVar
1717 ( MVar
@@ -21,9 +21,7 @@ import Control.Distributed.Process.Internal.CQueue
2121 ( CQueue
2222 )
2323import Control.Distributed.Process.Internal.Primitives
24− ( catch
25− , finally
26− , die
24+ ( die
2725 , receiveWait
2826 , forward
2927 , sendChan
@@ -63,6 +61,10 @@ import Control.Distributed.Process.Internal.Types
6361
6462import Control.Monad.IO.Class (liftIO)
6563import Control.Monad.Reader (ask)
64+import Control.Monad.Catch
65+ ( catch
66+ , finally
67+ )
6668
6769import Data.Set (Set)
6870import qualified Data.Set as Set
@@ -73,6 +75,7 @@ import Data.Maybe (fromMaybe)
7375import Data.Time.Clock (getCurrentTime)
7476import Data.Time.Format (formatTime)
7577import Debug.Trace (traceEventIO)
78+import Prelude
7679
7780#if ! MIN_VERSION_base(4,6,0)
7881import Prelude hiding (catch)
src/Control/Distributed/Process/Management/Internal/Trace/Types.hs−10
@@ -43,7 +43,6 @@ import Control.Distributed.Process.Serializable
4343import Data.Binary
4444import Data.List (intersperse)
4545import Data.Set (Set)
46−import qualified Data.Set as Set (fromList)
4746import Data.Typeable
4847import GHC.Generics
4948
@@ -158,12 +157,3 @@ getTraceFlags t s = publishEvent t (unsafeCreateUnencodedMessage s)
158157
159158getCurrentTraceClient :: MxEventBus -> SendPort (Maybe ProcessId) -> IO ()
160159getCurrentTraceClient t s = publishEvent t (unsafeCreateUnencodedMessage s)
161−
162−class Traceable a where
163− uod :: [a] -> TraceSubject
164−
165−instance Traceable ProcessId where
166− uod = TraceProcs . Set.fromList
167−
168−instance Traceable String where
169− uod = TraceNames . Set.fromList
src/Control/Distributed/Process/Management/Internal/Types.hs+9−19
@@ -1,16 +1,13 @@
11{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE StandaloneDeriving #-}
32{-# LANGUAGE ExistentialQuantification #-}
43{-# LANGUAGE GeneralizedNewtypeDeriving #-}
54{-# LANGUAGE DeriveGeneric #-}
65module Control.Distributed.Process.Management.Internal.Types
76 ( MxAgentId(..)
8− , MxTableId(..)
97 , MxAgentState(..)
108 , MxAgent(..)
119 , MxAction(..)
1210 , ChannelSelector(..)
13− , MxAgentStart(..)
1411 , Fork
1512 , MxSink
1613 , MxEvent(..)
@@ -24,8 +21,8 @@ import Control.Concurrent.STM
2421import Control.Distributed.Process.Internal.Types
2522 ( Process
2623 , ProcessId
24+ , SendPortId
2725 , Message
28− , SendPort
2926 , DiedReason
3027 , NodeId
3128 )
@@ -34,6 +31,7 @@ import qualified Control.Monad.State as ST
3431 ( MonadState
3532 , StateT
3633 )
34+import Control.Monad.Fix (MonadFix)
3735import Data.Binary
3836import Data.Typeable (Typeable)
3937import GHC.Generics
@@ -60,8 +58,14 @@ data MxEvent =
6058 -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
6159 | MxSent ProcessId ProcessId Message
6260 -- ^ 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
6365 | MxReceived ProcessId Message
6466 -- ^ 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
6569 | MxConnected ConnectionId EndPointAddress
6670 -- ^ fired when a network-transport connection is first established
6771 | MxDisconnected ConnectionId EndPointAddress
@@ -100,17 +104,10 @@ type Fork = (Process () -> IO ProcessId)
100104newtype MxAgentId = MxAgentId { agentId :: String }
101105 deriving (Typeable, Binary, Eq, Ord)
102106
103−data MxTableId =
104− MxForAgent !MxAgentId
105− | MxForPid !ProcessId
106− deriving (Typeable, Generic)
107−instance Binary MxTableId where
108−
109107data MxAgentState s = MxAgentState
110108 {
111109 mxAgentId :: !MxAgentId
112110 , mxBus :: !(TChan Message)
113− , mxSharedTable :: !ProcessId
114111 , mxLocalState :: !s
115112 }
116113
@@ -123,19 +120,12 @@ newtype MxAgent s a =
123120 } deriving ( Functor
124121 , Monad
125122 , MonadIO
123+ , MonadFix
126124 , ST.MonadState (MxAgentState s)
127125 , Typeable
128126 , Applicative
129127 )
130128
131−data MxAgentStart = MxAgentStart
132− {
133− mxAgentTableChan :: SendPort ProcessId
134− , mxAgentIdStart :: MxAgentId
135− }
136− deriving (Typeable, Generic)
137−instance Binary MxAgentStart where
138−
139129data ChannelSelector = InputChan | Mailbox
140130
141131-- | Represents the actions a management agent can take
src/Control/Distributed/Process/Node.hs+232−175
@@ -5,6 +5,7 @@
55{-# LANGUAGE BangPatterns #-}
66{-# LANGUAGE GeneralizedNewtypeDeriving #-}
77{-# LANGUAGE RecordWildCards #-}
8+{-# LANGUAGE MagicHash #-}
89
910-- | Local nodes
1011--
@@ -20,10 +21,6 @@ module Control.Distributed.Process.Node
2021
2122-- TODO: Calls to 'sendBinary' and co (by the NC) may stall the node controller.
2223
23−#if ! MIN_VERSION_base(4,6,0)
24−import Prelude hiding (catch)
25−#endif
26−
2724import System.IO (fixIO, hPutStrLn, stderr)
2825import System.Mem.Weak (Weak, deRefWeak)
2926import qualified Data.ByteString.Lazy as BSL (fromChunks)
@@ -31,28 +28,39 @@ import Data.Binary (decode)
3128import Data.Map (Map)
3229import qualified Data.Map as Map
3330 ( empty
31+ , delete
3432 , toList
3533 , fromList
36− , filter
34+ , insert
35+ , lookup
36+ , partition
3737 , partitionWithKey
3838 , elems
3939 , size
4040 , filterWithKey
4141 , foldlWithKey
4242 )
43+import Data.Time.Format (formatTime)
44+#if MIN_VERSION_time(1,5,0)
45+import Data.Time.Format (defaultTimeLocale)
46+#else
47+import System.Locale (defaultTimeLocale)
48+#endif
4349import Data.Set (Set)
4450import qualified Data.Set as Set
4551 ( empty
4652 , insert
4753 , delete
54+ , map
4855 , member
4956 , toList
57+ , union
5058 )
5159import Data.Foldable (forM_)
5260import Data.Maybe (isJust, fromJust, isNothing, catMaybes)
5361import Data.Typeable (Typeable)
5462import Control.Category ((>>>))
55−import Control.Applicative (Applicative, (<$>))
63+import Control.Applicative
5664import Control.Monad (void, when, join)
5765import Control.Monad.IO.Class (MonadIO, liftIO)
5866import Control.Monad.State.Strict (MonadState, StateT, evalStateT, gets)
@@ -60,11 +68,12 @@ import qualified Control.Monad.State.Strict as StateT (get, put)
6068import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask)
6169import Control.Exception
6270 ( throwIO
63− , AsyncException(ThreadKilled)
6471 , SomeException
6572 , Exception
6673 , throwTo
6774 , uninterruptibleMask_
75+ , getMaskingState
76+ , MaskingState(..)
6877 )
6978import qualified Control.Exception as Exception
7079 ( Handler(..)
@@ -72,12 +81,13 @@ import qualified Control.Exception as Exception
7281 , catches
7382 , finally
7483 )
75−import Control.Concurrent (forkIO, forkIOWithUnmask, killThread, myThreadId)
84+import Control.Concurrent (forkIO, killThread)
85+import Control.Distributed.Process.Internal.BiMultiMap (BiMultiMap)
86+import qualified Control.Distributed.Process.Internal.BiMultiMap as BiMultiMap
7687import Control.Distributed.Process.Internal.StrictMVar
7788 ( newMVar
7889 , withMVar
7990 , modifyMVarMasked
80− , modifyMVar_
8191 , modifyMVar
8292 , newEmptyMVar
8393 , putMVar
@@ -167,18 +177,17 @@ import Control.Distributed.Process.Internal.Types
167177 , RegisterReply(..)
168178 , WhereIsReply(..)
169179 , payloadToMessage
170− , messageToPayload
171180 , createUnencodedMessage
181+ , unsafeCreateUnencodedMessage
172182 , runLocalProcess
173183 , firstNonReservedProcessId
174− , ImplicitReconnect(WithImplicitReconnect,NoImplicitReconnect)
184+ , ImplicitReconnect(WithImplicitReconnect)
175185 )
176186import Control.Distributed.Process.Management.Internal.Agent
177187 ( mxAgentController
178188 )
179−import qualified Control.Distributed.Process.Management.Internal.Table as Table
180− ( mxTableCoordinator
181− , startTableCoordinator
189+import Control.Distributed.Process.Management.Internal.Types
190+ ( MxEvent(..)
182191 )
183192import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Trace
184193 ( remoteTable
@@ -192,25 +201,22 @@ import Control.Distributed.Process.Management.Internal.Trace.Types
192201 , traceLogFmt
193202 , enableTrace
194203 )
195−import Control.Distributed.Process.Management.Internal.Types
196− ( MxEvent(..)
197− )
198204import Control.Distributed.Process.Serializable (Serializable)
199205import Control.Distributed.Process.Internal.Messaging
200206 ( sendBinary
201− , sendMessage
202− , sendPayload
203207 , closeImplicitReconnections
204208 , impliesDeathOf
205209 )
206210import Control.Distributed.Process.Internal.Primitives
207211 ( register
208− , finally
209212 , receiveWait
210213 , match
211214 , sendChan
212− , catch
213215 , unwrapMessage
216+ , monitor
217+ , unmonitorAsync
218+ , getSelfNode
219+ , SayMessage(..)
214220 )
215221import Control.Distributed.Process.Internal.Types (SendPort, Tracer(..))
216222import qualified Control.Distributed.Process.Internal.Closure.BuiltIn as BuiltIn (remoteTable)
@@ -219,7 +225,20 @@ import qualified Control.Distributed.Process.Internal.StrictContainerAccessors a
219225 ( mapMaybe
220226 , mapDefault
221227 )
228+import Control.Monad.Catch (try)
229+import GHC.IO (IO(..), unsafeUnmask)
230+import GHC.Base ( maskAsyncExceptions# )
231+
222232import Unsafe.Coerce
233+import Prelude
234+
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
223242
224243--------------------------------------------------------------------------------
225244-- Initialization --
@@ -305,8 +324,6 @@ startServiceProcesses node = do
305324 -- before /that/ process has started - this is a totally harmless race
306325 -- however, so we deliberably ignore it
307326 startDefaultTracer node
308− tableCoordinatorPid <- fork $ Table.startTableCoordinator fork
309− runProcess node $ register Table.mxTableCoordinator tableCoordinatorPid
310327 logger <- forkProcess node loop
311328 runProcess node $ do
312329 register "logger" logger
@@ -315,12 +332,11 @@ startServiceProcesses node = do
315332 -- process which uses 'send' or other primitives which are traced.
316333 register "trace.logger" logger
317334 where
318− fork = forkProcess node
319−
320335 loop = do
321336 receiveWait
322− [ match $ \((time, pid, string) ::(String, ProcessId, String)) -> do
323− liftIO . hPutStrLn stderr $ time ++ " " ++ show pid ++ ": " ++ string
337+ [ match $ \(SayMessage time pid string) -> do
338+ let time' = formatTime defaultTimeLocale "%c" time
339+ liftIO . hPutStrLn stderr $ time' ++ " " ++ show pid ++ ": " ++ string
324340 loop
325341 , match $ \((time, string) :: (String, String)) -> do
326342 -- this is a 'trace' message from the local node tracer
@@ -355,19 +371,21 @@ closeLocalNode node = do
355371runProcess :: LocalNode -> Process () -> IO ()
356372runProcess node proc = do
357373 done <- newEmptyMVar
358− tid <- myThreadId
359− void $ forkProcess node $ do
360− catch (proc `finally` liftIO (putMVar done ()))
361− (\(ex :: SomeException) -> liftIO $ throwTo tid ex)
362− takeMVar done
374+ -- TODO; When forkProcess inherits the masking state, protect the forked
375+ -- thread against async exceptions that could occur before 'try' is evaluated.
376+ void $ forkProcess node $ try proc >>= liftIO . putMVar done
377+ takeMVar done >>= either (throwIO :: SomeException -> IO a) return
363378
364379-- | Spawn a new process on a local node
365380forkProcess :: LocalNode -> Process () -> IO ProcessId
366−forkProcess node proc =
367− modifyMVarMasked (localState node) startProcess
381+forkProcess node proc = do
382+ ms <- getMaskingState
383+ modifyMVarMasked (localState node) (startProcess ms)
368384 where
369− startProcess :: LocalNodeState -> IO (LocalNodeState, ProcessId)
370− startProcess (LocalNodeValid vst) = do
385+ startProcess :: MaskingState
386+ -> LocalNodeState
387+ -> IO (LocalNodeState, ProcessId)
388+ startProcess ms (LocalNodeValid vst) = do
371389 let lpid = LocalProcessId { lpidCounter = vst ^. localPidCounter
372390 , lpidUnique = vst ^. localPidUnique
373391 }
@@ -389,7 +407,13 @@ forkProcess node proc =
389407 , processThread = tid
390408 , processNode = node
391409 }
392− tid' <- uninterruptibleMask_ $ forkIOWithUnmask $ \unmask -> do
410+ -- Rewrite this code when this is fixed:
411+ -- https://ghc.haskell.org/trac/ghc/ticket/10149
412+ let unmask = case ms of
413+ Unmasked -> unblock
414+ MaskedInterruptible -> block
415+ MaskedUninterruptible -> id
416+ tid' <- uninterruptibleMask_ $ forkIO $ do
393417 reason <- Exception.catches
394418 (unmask $ runLocalProcess lproc proc >> return DiedNormal)
395419 [ (Exception.Handler (\ex@(ProcessExitException from msg) -> do
@@ -435,7 +459,7 @@ forkProcess node proc =
435459 $ vst
436460 , pid
437461 )
438− startProcess LocalNodeClosed =
462+ startProcess _ LocalNodeClosed =
439463 throwIO $ NodeClosedException $ localNodeId node
440464
441465 cleanupProcess :: ProcessId
@@ -468,7 +492,7 @@ type IncomingConnection = (NT.EndPointAddress, IncomingTarget)
468492data IncomingTarget =
469493 Uninit
470494 | ToProc ProcessId (Weak (CQueue Message))
471− | ToChan TypedChannel
495+ | ToChan SendPortId TypedChannel
472496 | ToNode
473497
474498data ConnectionState = ConnectionState {
@@ -510,7 +534,8 @@ handleIncomingMessages node = go initConnectionState
510534 . (incomingFrom theirAddr ^: Set.insert cid)
511535 $ st
512536 )
513− else invalidRequest cid st
537+ else invalidRequest cid st $
538+ "attempt to connect with unsupported reliability " ++ show rel
514539 NT.Received cid payload ->
515540 case st ^. incomingAt cid of
516541 Just (_, ToProc pid weakQueue) -> do
@@ -522,13 +547,17 @@ handleIncomingMessages node = go initConnectionState
522547 enqueue queue msg -- 'enqueue' is strict
523548 trace node (MxReceived pid msg)
524549 go st
525− Just (_, ToChan (TypedChannel chan')) -> do
550+ Just (_, ToChan chId (TypedChannel chan')) -> do
526551 mChan <- deRefWeak chan'
527552 -- If mChan is Nothing, the process has given up the read end of
528553 -- the channel and we simply ignore the incoming message
529− forM_ mChan $ \chan -> atomically $
530− -- We make sure the message is fully decoded when it is enqueued
531− writeTQueue chan $! decode (BSL.fromChunks payload)
554+ forM_ mChan $ \chan -> do
555+ msg' <- atomically $ do
556+ msg <- return $! decode (BSL.fromChunks payload)
557+ -- We make sure the message is fully decoded when it is enqueued
558+ writeTQueue chan msg
559+ return msg
560+ trace node $ MxReceivedPort chId $ unsafeCreateUnencodedMessage msg'
532561 go st
533562 Just (_, ToNode) -> do
534563 let ctrlMsg = decode . BSL.fromChunks $ payload
@@ -543,7 +572,9 @@ handleIncomingMessages node = go initConnectionState
543572 Just proc ->
544573 go (incomingAt cid ^= Just (src, ToProc pid (processWeakQ proc)) $ st)
545574 Nothing ->
546− invalidRequest cid st
575+ -- incoming attempt to connect to unknown process - might
576+ -- be dead already
577+ go (incomingAt cid ^= Nothing $ st)
547578 SendPortIdentifier chId -> do
548579 let lcid = sendPortLocalId chId
549580 lpid = processLocalId (sendPortProcessId chId)
@@ -553,21 +584,30 @@ handleIncomingMessages node = go initConnectionState
553584 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
554585 case mChannel of
555586 Just channel ->
556− go (incomingAt cid ^= Just (src, ToChan channel) $ st)
587+ go (incomingAt cid ^= Just (src, ToChan chId channel) $ st)
557588 Nothing ->
558− invalidRequest cid st
589+ invalidRequest cid st $
590+ "incoming attempt to connect to unknown channel of"
591+ ++ " process " ++ show (sendPortProcessId chId)
559592 Nothing ->
560− invalidRequest cid st
593+ -- incoming attempt to connect to channel of unknown
594+ -- process - might be dead already
595+ go (incomingAt cid ^= Nothing $ st)
561596 NodeIdentifier nid ->
562597 if nid == localNodeId node
563598 then go (incomingAt cid ^= Just (src, ToNode) $ st)
564− 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 "
603+ ++ show nid
565604 Nothing ->
566605 invalidRequest cid st
606+ "message received from an unknown connection"
567607 NT.ConnectionClosed cid ->
568608 case st ^. incomingAt cid of
569609 Nothing ->
570− invalidRequest cid st
610+ invalidRequest cid st "closed unknown connection"
571611 Just (src, _) -> do
572612 trace node (MxDisconnected cid src)
573613 go ( (incomingAt cid ^= Nothing)
@@ -598,14 +638,16 @@ handleIncomingMessages node = go initConnectionState
598638 -- and we just give up
599639 fail "Cloud Haskell fatal error: received unexpected multicast"
600640
601− invalidRequest :: NT.ConnectionId -> ConnectionState -> IO ()
602− invalidRequest cid st = do
641+ invalidRequest :: NT.ConnectionId -> ConnectionState -> String -> IO ()
642+ invalidRequest cid st msg = do
603643 -- TODO: We should treat this as a fatal error on the part of the remote
604644 -- node. That is, we should report the remote node as having died, and we
605645 -- should close incoming connections (this requires a Transport layer
606646 -- extension).
607− traceEventFmtIO node "" [(TraceStr " [network] invalid request: "),
608− (Trace cid)]
647+ traceEventFmtIO node "" [ TraceStr $ " [network] invalid request"
648+ ++ " (" ++ msg ++ "): "
649+ , (Trace cid)
650+ ]
609651 go ( incomingAt cid ^= Nothing
610652 $ st
611653 )
@@ -628,9 +670,9 @@ runNodeController node =
628670
629671data NCState = NCState
630672 { -- Mapping from remote processes to linked local processes
631− _links :: !(Map Identifier (Set ProcessId))
673+ _links :: !(BiMultiMap Identifier ProcessId ())
632674 -- Mapping from remote processes to monitoring local processes
633− , _monitors :: !(Map Identifier (Set (ProcessId, MonitorRef)))
675+ , _monitors :: !(BiMultiMap Identifier ProcessId MonitorRef)
634676 -- Process registry: names and where they live, mapped to the PIDs
635677 , _registeredHere :: !(Map String ProcessId)
636678 , _registeredOnNodes :: !(Map ProcessId [(NodeId,Int)])
@@ -646,8 +688,8 @@ newtype NC a = NC { unNC :: StateT NCState (ReaderT LocalNode IO) a }
646688 )
647689
648690initNCState :: NCState
649−initNCState = NCState { _links = Map.empty
650− , _monitors = Map.empty
691+initNCState = NCState { _links = BiMultiMap.empty
692+ , _monitors = BiMultiMap.empty
651693 , _registeredHere = Map.empty
652694 , _registeredOnNodes = Map.empty
653695 }
@@ -663,6 +705,33 @@ instance Show ProcessKillException where
663705 show (ProcessKillException pid reason) =
664706 "killed-by=" ++ show pid ++ ",reason=" ++ reason
665707
708+ncSendToProcess :: ProcessId -> Message -> NC ()
709+ncSendToProcess = ncSendToProcessAndTrace True
710+
711+ncSendToProcessAndTrace :: Bool -> ProcessId -> Message -> NC ()
712+ncSendToProcessAndTrace shouldTrace pid msg = do
713+ node <- ask
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
722+ }
723+
724+ncSendToNode :: NodeId -> NCMsg -> NC ()
725+ncSendToNode to msg = do
726+ node <- ask
727+ liftIO $ if to == localNodeId node
728+ then writeChan (localCtrlChan node) $! msg
729+ else sendBinary node
730+ (NodeIdentifier $ localNodeId node)
731+ (NodeIdentifier to)
732+ WithImplicitReconnect
733+ msg
734+
666735--------------------------------------------------------------------------------
667736-- Tracing/Debugging --
668737--------------------------------------------------------------------------------
@@ -705,11 +774,7 @@ nodeController = do
705774 -- [Unified: Table 7, rule nc_forward]
706775 case destNid (ctrlMsgSignal msg) of
707776 Just nid' | nid' /= localNodeId node ->
708− liftIO $ sendBinary node
709− (ctrlMsgSender msg)
710− (NodeIdentifier nid')
711− WithImplicitReconnect
712− msg
777+ ncSendToNode nid' msg
713778 _ ->
714779 return ()
715780
@@ -730,8 +795,8 @@ nodeController = do
730795 ncEffectRegister from label atnode pid force
731796 NCMsg (ProcessIdentifier from) (WhereIs label) ->
732797 ncEffectWhereIs from label
733− NCMsg (ProcessIdentifier from) (NamedSend label msg') ->
734− ncEffectNamedSend from label msg'
798+ NCMsg _ (NamedSend label msg') ->
799+ ncEffectNamedSend label msg'
735800 NCMsg _ (UnreliableSend lpid msg') ->
736801 ncEffectLocalSend node (ProcessId (localNodeId node) lpid) msg'
737802 NCMsg _ (LocalSend to msg') ->
@@ -747,8 +812,7 @@ nodeController = do
747812 NCMsg _ SigShutdown ->
748813 liftIO $ do
749814 NT.closeEndPoint (localEndPoint node)
750− `Exception.finally` throwIO ThreadKilled
751− -- ThreadKilled seems to make more sense than fail/error here
815+ `Exception.finally` throwIO (NodeClosedException $ localNodeId node)
752816 NCMsg (ProcessIdentifier from) (GetNodeStats nid) ->
753817 ncEffectGetNodeStats from nid
754818 unexpected ->
@@ -768,22 +832,18 @@ ncEffectMonitor from them mRef = do
768832 case (shouldLink, isLocal node (ProcessIdentifier from)) of
769833 (True, _) -> -- [Unified: first rule]
770834 case mRef of
771− Just ref -> modify' $ monitorsFor them ^: Set.insert (from, ref)
772− Nothing -> modify' $ linksFor them ^: Set.insert from
835+ Just ref -> modify' $ monitors ^: BiMultiMap.insert them from ref
836+ Nothing -> modify' $ links ^: BiMultiMap.insert them from ()
773837 (False, True) -> -- [Unified: second rule]
774838 notifyDied from them DiedUnknownId mRef
775839 (False, False) -> -- [Unified: third rule]
776840 -- TODO: this is the right sender according to the Unified semantics,
777841 -- but perhaps having 'them' as the sender would make more sense
778842 -- (see also: notifyDied)
779− liftIO $ sendBinary node
780− (NodeIdentifier $ localNodeId node)
781− (NodeIdentifier $ processNodeId from)
782− WithImplicitReconnect
783− NCMsg
784− { ctrlMsgSender = NodeIdentifier (localNodeId node)
785− , ctrlMsgSignal = Died them DiedUnknownId
786− }
843+ ncSendToNode (processNodeId from) $ NCMsg
844+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
845+ , ctrlMsgSignal = Died them DiedUnknownId
846+ }
787847
788848-- [Unified: Table 11]
789849ncEffectUnlink :: ProcessId -> Identifier -> NC ()
@@ -797,7 +857,7 @@ ncEffectUnlink from them = do
797857 postAsMessage from $ DidUnlinkNode nid
798858 SendPortIdentifier cid ->
799859 postAsMessage from $ DidUnlinkPort cid
800− modify' $ linksFor them ^: Set.delete from
860+ modify' $ links ^: BiMultiMap.delete them from ()
801861
802862-- [Unified: Table 11]
803863ncEffectUnmonitor :: ProcessId -> MonitorRef -> NC ()
@@ -805,7 +865,7 @@ ncEffectUnmonitor from ref = do
805865 node <- ask
806866 when (isLocal node (ProcessIdentifier from)) $
807867 postAsMessage from $ DidUnmonitor ref
808− modify' $ monitorsFor (monitorRefIdent ref) ^: Set.delete (from, ref)
868+ modify' $ monitors ^: BiMultiMap.delete (monitorRefIdent ref) from ref
809869
810870-- [Unified: Table 12]
811871ncEffectDied :: Identifier -> DiedReason -> NC ()
@@ -820,7 +880,7 @@ ncEffectDied ident reason = do
820880 let localOnly = case ident of NodeIdentifier _ -> True ; _ -> False
821881
822882 forM_ (Map.toList affectedLinks) $ \(them, uss) ->
823− forM_ uss $ \us ->
883+ forM_ uss $ \(us, _) ->
824884 when (localOnly <= isLocal node (ProcessIdentifier us)) $
825885 notifyDied us them reason Nothing
826886
@@ -829,9 +889,35 @@ ncEffectDied ident reason = do
829889 when (localOnly <= isLocal node (ProcessIdentifier us)) $
830890 notifyDied us them reason (Just ref)
831891
832− modify' $ (links ^= unaffectedLinks) . (monitors ^= unaffectedMons)
833−
834− modify' $ registeredHere ^: Map.filter (\pid -> not $ ident `impliesDeathOf` ProcessIdentifier pid)
892+ -- Notify remote nodes that the process died so it can be removed from monitor
893+ -- lists.
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
901+ ]
902+
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
913+
914+ modify' $ (links ^= unaffectedLinks') . (monitors ^= unaffectedMons')
915+
916+ -- we now consider all labels for this identifier unregistered
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
835921
836922 remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
837923 mapM (\(pid,nidlist) ->
@@ -839,20 +925,15 @@ ncEffectDied ident reason = do
839925 True ->
840926 do forM_ nidlist $ \(nid,_) ->
841927 when (not $ isLocal node (NodeIdentifier nid))
842− (forwardNameDeath node nid)
928+ (forwardDeath node nid)
843929 return Nothing
844930 False -> return $ Just (pid,nidlist) )
845931 modify' $ registeredOnNodes ^= (Map.fromList (catMaybes remaining))
846932 where
847− forwardNameDeath node nid =
848− liftIO $ sendBinary node
849− (NodeIdentifier $ localNodeId node)
850− (NodeIdentifier $ nid)
851− WithImplicitReconnect
852− NCMsg
853− { ctrlMsgSender = NodeIdentifier (localNodeId node)
854− , ctrlMsgSignal = Died ident reason
855− }
933+ forwardDeath node nid = ncSendToNode nid
934+ NCMsg { ctrlMsgSender = NodeIdentifier (localNodeId node)
935+ , ctrlMsgSignal = Died ident reason
936+ }
856937
857938-- [Unified: Table 13]
858939ncEffectSpawn :: ProcessId -> Closure (Process ()) -> SpawnRef -> NC ()
@@ -866,11 +947,7 @@ ncEffectSpawn pid cProc ref = do
866947 Right p -> p
867948 node <- ask
868949 pid' <- liftIO $ forkProcess node proc
869− liftIO $ sendMessage node
870− (NodeIdentifier (localNodeId node))
871− (ProcessIdentifier pid)
872− WithImplicitReconnect
873− (DidSpawn ref pid')
950+ ncSendToProcess pid $ unsafeCreateUnencodedMessage $ DidSpawn ref pid'
874951
875952-- Unified semantics does not explicitly describe how to implement 'register',
876953-- but mentions it's "very similar to nsend" (Table 14)
@@ -892,14 +969,15 @@ ncEffectRegister from label atnode mPid reregistration = do
892969 do modify' $ registeredHereFor label ^= mPid
893970 updateRemote node currentVal mPid
894971 case mPid of
895− (Just p) -> liftIO $ trace node (MxRegistered p label)
972+ (Just p) -> do
973+ if reregistration
974+ then liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
975+ else return ()
976+ liftIO $ trace node (MxRegistered p label)
896977 Nothing -> liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
897978 newVal <- gets (^. registeredHereFor label)
898− liftIO $ sendMessage node
899− (NodeIdentifier (localNodeId node))
900− (ProcessIdentifier from)
901− WithImplicitReconnect
902− (RegisterReply label isOk newVal)
979+ ncSendToProcess from $ unsafeCreateUnencodedMessage $
980+ RegisterReply label isOk newVal
903981 else let operation =
904982 case reregistration of
905983 True -> flip decList
@@ -929,46 +1007,36 @@ ncEffectRegister from label atnode mPid reregistration = do
9291007 decList (x:xs) tag = x:decList xs tag
9301008 forward node to reg =
9311009 when (not $ isLocal node (NodeIdentifier to)) $
932− liftIO $ sendBinary node
933− (ProcessIdentifier from)
934− (NodeIdentifier to)
935− WithImplicitReconnect
936− NCMsg
937− { ctrlMsgSender = ProcessIdentifier from
938− , ctrlMsgSignal = reg
939− }
1010+ ncSendToNode to $ NCMsg { ctrlMsgSender = ProcessIdentifier from
1011+ , ctrlMsgSignal = reg
1012+ }
9401013
9411014
9421015-- Unified semantics does not explicitly describe 'whereis'
9431016ncEffectWhereIs :: ProcessId -> String -> NC ()
9441017ncEffectWhereIs from label = do
945− node <- ask
9461018 mPid <- gets (^. registeredHereFor label)
947− liftIO $ sendMessage node
948− (NodeIdentifier (localNodeId node))
949− (ProcessIdentifier from)
950− WithImplicitReconnect
951− (WhereIsReply label mPid)
1019+ ncSendToProcess from $ unsafeCreateUnencodedMessage $ WhereIsReply label mPid
9521020
9531021-- [Unified: Table 14]
954−ncEffectNamedSend :: ProcessId -> String -> Message -> NC ()
955−ncEffectNamedSend from label msg = do
1022+ncEffectNamedSend :: String -> Message -> NC ()
1023+ncEffectNamedSend label msg = do
9561024 mPid <- gets (^. registeredHereFor label)
957− node <- ask
9581025 -- If mPid is Nothing, we just ignore the named send (as per Table 14)
959− forM_ mPid $ \pid ->
960− liftIO $ sendPayload node
961− (ProcessIdentifier from)
962− (ProcessIdentifier pid)
963− NoImplicitReconnect
964− (messageToPayload msg)
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
9651030
9661031-- [Issue #DP-20]
9671032ncEffectLocalSend :: LocalNode -> ProcessId -> Message -> NC ()
968−ncEffectLocalSend node to msg =
1033+ncEffectLocalSend = ncEffectLocalSendAndTrace True
1034+
1035+ncEffectLocalSendAndTrace :: Bool -> LocalNode -> ProcessId -> Message -> NC ()
1036+ncEffectLocalSendAndTrace shouldTrace node to msg =
9691037 liftIO $ withLocalProc node to $ \p -> do
9701038 enqueue (processQueue p) msg
971− trace node (MxReceived to msg)
1039+ when shouldTrace $ trace node (MxReceived to msg)
9721040
9731041-- [Issue #DP-20]
9741042ncEffectLocalPortSend :: SendPortId -> Message -> NC ()
@@ -986,11 +1054,12 @@ ncEffectLocalPortSend from msg = do
9861054 -- If ch is Nothing, the process has given up the read end of
9871055 -- the channel and we simply ignore the incoming message - this
9881056 ch <- deRefWeak chan'
989− forM_ ch $ \chan -> deliverChan msg chan
990− where deliverChan :: forall a . Message -> TQueue a -> IO ()
991− deliverChan (UnencodedMessage _ raw) 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
9921060 atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
993− deliverChan (EncodedMessage _ _) _ =
1061+ trace n (MxReceivedPort p $ unsafeCreateUnencodedMessage raw)
1062+ deliverChan _ _ (EncodedMessage _ _) _ =
9941063 -- this will not happen unless someone screws with Primitives.hs
9951064 error "invalid local channel delivery"
9961065
@@ -1019,37 +1088,32 @@ ncEffectGetInfo from pid =
10191088 $ return . (^. localProcessWithId lpid)
10201089 case mProc of
10211090 Nothing -> dispatch (isLocal node (ProcessIdentifier from))
1022− from node (ProcessInfoNone DiedUnknownId)
1023− Just proc -> do
1024− itsLinks <- gets (^. linksFor them)
1025− itsMons <- gets (^. monitorsFor them)
1091+ from (ProcessInfoNone DiedUnknownId)
1092+ Just proc -> do
1093+ itsLinks <- Set.map fst . BiMultiMap.lookupBy1st them <$>
1094+ gets (^. links)
1095+ itsMons <- BiMultiMap.lookupBy1st them <$> gets (^. monitors)
10261096 registered <- gets (^. registeredHere)
10271097 size <- liftIO $ queueSize $ processQueue $ proc
10281098
10291099 let reg = registeredNames registered
10301100 dispatch (isLocal node (ProcessIdentifier from))
10311101 from
1032− node
10331102 ProcessInfo {
10341103 infoNode = (processNodeId pid)
10351104 , infoRegisteredNames = reg
10361105 , infoMessageQueueLength = size
1037− , infoMonitors = Set.toList itsMons
1038− , infoLinks = Set.toList itsLinks
1106+ , infoMonitors = Set.toList itsMons
1107+ , infoLinks = Set.toList itsLinks
10391108 }
1040− where dispatch :: (Serializable a, Show a)
1109+ where dispatch :: (Serializable a)
10411110 => Bool
10421111 -> ProcessId
1043− -> LocalNode
10441112 -> a
10451113 -> NC ()
1046− dispatch True dest _ pInfo = postAsMessage dest $ pInfo
1047− dispatch False dest node pInfo = do
1048− liftIO $ sendMessage node
1049− (NodeIdentifier (localNodeId node))
1050− (ProcessIdentifier dest)
1051− WithImplicitReconnect
1052− pInfo
1114+ dispatch True dest pInfo = postAsMessage dest $ pInfo
1115+ dispatch False dest pInfo =
1116+ ncSendToProcess dest $ unsafeCreateUnencodedMessage pInfo
10531117
10541118 registeredNames = Map.foldlWithKey (\ks k v -> if v == pid
10551119 then (k:ks)
@@ -1064,8 +1128,8 @@ ncEffectGetNodeStats from _nid = do
10641128 NodeStats {
10651129 nodeStatsNode = localNodeId node
10661130 , nodeStatsRegisteredNames = Map.size $ ncState ^. registeredHere
1067− , nodeStatsMonitors = Map.size $ ncState ^. monitors
1068− , nodeStatsLinks = Map.size $ ncState ^. links
1131+ , nodeStatsMonitors = BiMultiMap.size $ ncState ^. monitors
1132+ , nodeStatsLinks = BiMultiMap.size $ ncState ^. links
10691133 , nodeStatsProcesses = Map.size (nodeState ^. localProcesses)
10701134 }
10711135 postAsMessage from stats
@@ -1096,14 +1160,10 @@ notifyDied dest src reason mRef = do
10961160 throwException dest $ PortLinkException pid reason
10971161 (False, _, _) ->
10981162 -- The change in sender comes from [Unified: Table 10]
1099− liftIO $ sendBinary node
1100− (NodeIdentifier $ localNodeId node)
1101− (NodeIdentifier $ processNodeId dest)
1102− WithImplicitReconnect
1103− NCMsg
1104− { ctrlMsgSender = NodeIdentifier (localNodeId node)
1105− , ctrlMsgSignal = Died src reason
1106− }
1163+ ncSendToNode (processNodeId dest) $ NCMsg
1164+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
1165+ , ctrlMsgSignal = Died src reason
1166+ }
11071167
11081168-- | [Unified: Table 8]
11091169destNid :: ProcessSignal -> Maybe NodeId
@@ -1174,25 +1234,26 @@ throwException :: Exception e => ProcessId -> e -> NC ()
11741234throwException pid e = do
11751235 node <- ask
11761236 -- throwTo blocks until the exception is received by the target thread.
1177− -- We fork a helper thread to avoid blocking the node controller.
1178− liftIO $ withLocalProc node pid $ \p -> void $ forkIO $ throwTo (processThread p) e
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
11791240
11801241withLocalProc :: LocalNode -> ProcessId -> (LocalProcess -> IO ()) -> IO ()
11811242withLocalProc node pid p =
11821243 -- By [Unified: table 6, rule missing_process] messages to dead processes
11831244 -- can silently be dropped
11841245 let lpid = processLocalId pid in do
1185− withValidLocalState node $ \vst ->
1186− forM_ (vst ^. localProcessWithId lpid) p
1246+ join $ withValidLocalState node $ \vst ->
1247+ return $ forM_ (vst ^. localProcessWithId lpid) p
11871248
11881249--------------------------------------------------------------------------------
11891250-- Accessors --
11901251--------------------------------------------------------------------------------
11911252
1192−links :: Accessor NCState (Map Identifier (Set ProcessId))
1253+links :: Accessor NCState (BiMultiMap Identifier ProcessId ())
11931254links = accessor _links (\ls st -> st { _links = ls })
11941255
1195−monitors :: Accessor NCState (Map Identifier (Set (ProcessId, MonitorRef)))
1256+monitors :: Accessor NCState (BiMultiMap Identifier ProcessId MonitorRef)
11961257monitors = accessor _monitors (\ms st -> st { _monitors = ms })
11971258
11981259registeredHere :: Accessor NCState (Map String ProcessId)
@@ -1201,12 +1262,6 @@ registeredHere = accessor _registeredHere (\ry st -> st { _registeredHere = ry }
12011262registeredOnNodes :: Accessor NCState (Map ProcessId [(NodeId, Int)])
12021263registeredOnNodes = accessor _registeredOnNodes (\ry st -> st { _registeredOnNodes = ry })
12031264
1204−linksFor :: Identifier -> Accessor NCState (Set ProcessId)
1205−linksFor ident = links >>> DAC.mapDefault Set.empty ident
1206−
1207−monitorsFor :: Identifier -> Accessor NCState (Set (ProcessId, MonitorRef))
1208−monitorsFor ident = monitors >>> DAC.mapDefault Set.empty ident
1209−
12101265registeredHereFor :: String -> Accessor NCState (Maybe ProcessId)
12111266registeredHereFor ident = registeredHere >>> DAC.mapMaybe ident
12121267
@@ -1233,10 +1288,12 @@ registeredOnNodesFor ident = registeredOnNodes >>> DAC.mapMaybe ident
12331288-- * the notifications for typed channels to that process.
12341289--
12351290-- See https://github.com/haskell/containers/issues/14 for the bang on _v.
1236−splitNotif :: Identifier
1237− -> Map Identifier a
1238− -> (Map Identifier a, Map Identifier a)
1239−splitNotif ident = Map.partitionWithKey (\k !_v -> ident `impliesDeathOf` k)
1291+splitNotif :: (Ord a, Ord v)
1292+ => Identifier
1293+ -> BiMultiMap Identifier a v
1294+ -> (Map Identifier (Set (a,v)), BiMultiMap Identifier a v)
1295+splitNotif ident =
1296+ BiMultiMap.partitionWithKeyBy1st (\k !_v -> ident `impliesDeathOf` k)
12401297
12411298--------------------------------------------------------------------------------
12421299-- Auxiliary --
src/Control/Distributed/Process/Serializable.hs+6−18
@@ -1,8 +1,8 @@
11{-# LANGUAGE DeriveDataTypeable #-}
22{-# LANGUAGE UndecidableInstances #-}
33{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE ScopedTypeVariables #-}
45{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE CPP #-}
66module Control.Distributed.Process.Serializable
77 ( Serializable
88 , encodeFingerprint
@@ -17,25 +17,17 @@ module Control.Distributed.Process.Serializable
1717
1818import Data.Binary (Binary)
1919
20−#if MIN_VERSION_base(4,7,0)
21−import Data.Typeable (Typeable)
22−import Data.Typeable.Internal (TypeRep(TypeRep), typeOf)
23−#else
24−import Data.Typeable (Typeable(..))
25−import Data.Typeable.Internal (TypeRep(TypeRep))
26−#endif
20+import Data.Typeable (Typeable, typeRepFingerprint, typeOf)
2721
2822import Numeric (showHex)
2923import Control.Exception (throw)
3024import GHC.Fingerprint.Type (Fingerprint(..))
3125import Data.ByteString (ByteString)
3226import qualified Data.ByteString as BS
33−import qualified Data.ByteString.Internal as BSI ( unsafeCreate
34− , inlinePerformIO
35− , toForeignPtr
36− )
27+import qualified Data.ByteString.Internal as BSI ( unsafeCreate, toForeignPtr )
3728import Foreign.Storable (pokeByteOff, peekByteOff, sizeOf)
3829import Foreign.ForeignPtr (withForeignPtr)
30+import System.IO.Unsafe (unsafePerformIO)
3931
4032-- | Reification of 'Serializable' (see "Control.Distributed.Process.Closure")
4133data SerializableDict a where
@@ -63,7 +55,7 @@ decodeFingerprint :: ByteString -> Fingerprint
6355decodeFingerprint bs
6456 | BS.length bs /= sizeOfFingerprint =
6557 throw $ userError "decodeFingerprint: Invalid length"
66− | otherwise = BSI.inlinePerformIO $ do
58+ | otherwise = unsafePerformIO $ do
6759 let (fp, offset, _) = BSI.toForeignPtr bs
6860 withForeignPtr fp $ \p -> peekByteOff p offset
6961
@@ -73,11 +65,7 @@ sizeOfFingerprint = sizeOf (undefined :: Fingerprint)
7365
7466-- | The fingerprint of the typeRep of the argument
7567fingerprint :: Typeable a => a -> Fingerprint
76−#if MIN_VERSION_base(4,8,0)
77−fingerprint a = let TypeRep fp _ _ _ = typeOf a in fp
78−#else
79−fingerprint a = let TypeRep fp _ _ = typeOf a in fp
80−#endif
68+fingerprint = typeRepFingerprint . typeOf
8169
8270-- | Show fingerprint (for debugging purposes)
8371showFingerprint :: Fingerprint -> ShowS
src/Control/Distributed/Process/UnsafePrimitives.hs+109−29
@@ -32,7 +32,24 @@
3232-- the /normal/ strategy).
3333--
3434-- Use of the functions in this module can potentially change the runtime
35−-- behaviour of your application. You have been warned!
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!
3653--
3754-- This module is exported so that you can replace the use of Cloud Haskell's
3855-- /safe/ messaging primitives. If you want to use both variants, then you can
@@ -45,6 +62,8 @@ module Control.Distributed.Process.UnsafePrimitives
4562 send
4663 , sendChan
4764 , nsend
65+ , nsendRemote
66+ , usend
4867 , wrapMessage
4968 ) where
5069
@@ -53,9 +72,15 @@ import Control.Distributed.Process.Internal.Messaging
5372 , sendBinary
5473 , sendCtrlMsg
5574 )
56−
75+import Control.Distributed.Process.Management.Internal.Types
76+ ( MxEvent(..)
77+ )
78+import Control.Distributed.Process.Management.Internal.Trace.Types
79+ ( traceEvent
80+ )
5781import Control.Distributed.Process.Internal.Types
5882 ( ProcessId(..)
83+ , NodeId(..)
5984 , LocalNode(..)
6085 , LocalProcess(..)
6186 , Process(..)
@@ -65,6 +90,7 @@ import Control.Distributed.Process.Internal.Types
6590 , ImplicitReconnect(..)
6691 , SendPortId(..)
6792 , Message
93+ , createMessage
6894 , sendPortProcessId
6995 , unsafeCreateUnencodedMessage
7096 )
@@ -75,45 +101,99 @@ import Control.Monad.Reader (ask)
75101
76102-- | Named send to a process in the local registry (asynchronous)
77103nsend :: Serializable a => String -> a -> Process ()
78−nsend label msg =
79− sendCtrlMsg Nothing (NamedSend label (unsafeCreateUnencodedMessage msg))
104+nsend label msg = do
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')
112+
113+-- | Named send to a process in a remote registry (asynchronous)
114+nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
115+nsendRemote nid label msg = do
116+ proc <- ask
117+ let us = processId proc
118+ let node = processNode proc
119+ if localNodeId node == nid
120+ 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))
80127
81128-- | Send a message
82129send :: Serializable a => ProcessId -> a -> Process ()
83130send them msg = do
84131 proc <- ask
85132 let node = localNodeId (processNode proc)
86− destNode = (processNodeId them) in do
87− case destNode == node of
88− True -> unsafeSendLocal them msg
89− False -> liftIO $ sendMessage (processNode proc)
90− (ProcessIdentifier (processId proc))
91− (ProcessIdentifier them)
92− NoImplicitReconnect
93− msg
94− where
95− unsafeSendLocal :: (Serializable a) => ProcessId -> a -> Process ()
96− unsafeSendLocal pid msg' =
97− sendCtrlMsg Nothing $ LocalSend pid (unsafeCreateUnencodedMessage msg')
133+ destNode = (processNodeId them)
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
140+ then sendCtrlMsg Nothing $ LocalSend them msg'
141+ else liftIO $ sendMessage (processNode proc)
142+ (ProcessIdentifier (processId proc))
143+ (ProcessIdentifier them)
144+ NoImplicitReconnect
145+ msg
146+
147+-- | Send a message unreliably.
148+--
149+-- Unlike 'send', this function is insensitive to 'reconnect'. It will
150+-- try to send the message regardless of the history of connection failures
151+-- between the nodes.
152+--
153+-- Message passing with 'usend' is ordered for a given sender and receiver
154+-- if the messages arrive at all.
155+--
156+usend :: Serializable a => ProcessId -> a -> Process ()
157+usend them msg = do
158+ proc <- ask
159+ 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
165+ then sendCtrlMsg Nothing $ LocalSend them msg'
166+ else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
167+ (createMessage msg)
168+
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+--
98176
99177-- | Send a message on a typed channel
100178sendChan :: Serializable a => SendPort a -> a -> Process ()
101179sendChan (SendPort cid) msg = do
102180 proc <- ask
103− let node = localNodeId (processNode proc)
104− destNode = processNodeId (sendPortProcessId cid) in do
105− case destNode == node of
106− True -> unsafeSendChanLocal cid msg
107− False -> do
108− liftIO $ sendBinary (processNode proc)
109− (ProcessIdentifier (processId proc))
110− (SendPortIdentifier cid)
111− NoImplicitReconnect
112− msg
181+ let node = processNode proc
182+ pid = processId proc
183+ us = localNodeId node
184+ them = processNodeId (sendPortProcessId cid)
185+ msg' = wrapMessage msg in do
186+ liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid msg')
187+ if them == us
188+ then unsafeSendChanLocal cid msg' -- NB: we wrap to P.Message !!!
189+ else liftIO $ sendBinary node
190+ (ProcessIdentifier pid)
191+ (SendPortIdentifier cid)
192+ NoImplicitReconnect
193+ msg
113194 where
114− unsafeSendChanLocal :: (Serializable a) => SendPortId -> a -> Process ()
115− unsafeSendChanLocal spId msg' =
116− sendCtrlMsg Nothing $ LocalPortSend spId (unsafeCreateUnencodedMessage msg')
195+ unsafeSendChanLocal :: SendPortId -> Message -> Process ()
196+ unsafeSendChanLocal p m = sendCtrlMsg Nothing $ LocalPortSend p m
117197
118198-- | Create an unencoded @Message@ for any @Serializable@ type.
119199wrapMessage :: Serializable a => a -> Message
stack-ghc-7.10.3.yamlnew file+21
@@ -0,0 +1,21 @@
1+resolver: nightly-2016-03-08
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
10+
11+extra-deps:
12+- rank1dynamic-0.4.0
13+- distributed-static-0.3.8
14+- network-transport-0.5.2
15+- network-transport-inmemory-0.5.2
16+- rematch-0.2.0.0
17+- exceptions-0.8.2.1 # test dependency
18+
19+flags:
20+ distributed-process-tests:
21+ tcp: true
stack-ghc-8.0.2.yamlnew file+23
@@ -0,0 +1,23 @@
1+resolver: lts-9.21
2+# added -location for network-transport-tcp-0.6.0
3+# since c7fd79 broke the client facing API for createTransport :/
4+
5+packages:
6+- '.'
7+- distributed-process-tests/
8+- location:
9+ git: https://github.com/haskell-distributed/network-transport-tcp.git
10+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
11+ extra-dep: true
12+
13+extra-deps:
14+- rank1dynamic-0.4.0
15+- distributed-static-0.3.8
16+- network-transport-0.5.2
17+- network-transport-inmemory-0.5.2
18+- rematch-0.2.0.0
19+# - exceptions-0.8.2.1 # test dependency
20+
21+flags:
22+ distributed-process-tests:
23+ tcp: true
stack-ghc-8.2.2.yamlnew file+21
@@ -0,0 +1,21 @@
1+resolver: lts-11.22
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
10+
11+extra-deps:
12+- rank1dynamic-0.4.0
13+- distributed-static-0.3.8
14+- network-transport-0.5.2
15+- network-transport-inmemory-0.5.2
16+- rematch-0.2.0.0
17+# - exceptions-0.8.2.1 # test dependency
18+
19+flags:
20+ distributed-process-tests:
21+ tcp: true
stack-ghc-8.4.4.yamlnew file+20
@@ -0,0 +1,20 @@
1+resolver: lts-12.18
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
10+
11+extra-deps:
12+- rank1dynamic-0.4.0
13+- distributed-static-0.3.8
14+- network-transport-0.5.2
15+- network-transport-inmemory-0.5.2
16+- rematch-0.2.0.0
17+
18+flags:
19+ distributed-process-tests:
20+ tcp: true
stack-nightly.yamlnew file+26
@@ -0,0 +1,26 @@
1+resolver: nightly
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/distributed-static.git
8+ commit: c51e6aadd3a44c044e96a8e986c11d3a94b45b11
9+ extra-dep: true
10+- location:
11+ git: https://github.com/haskell-distributed/network-transport-tcp.git
12+ commit: d58250e2388b86a1865ac4139373cbdc106e72e1
13+ extra-dep: true
14+- location:
15+ git: https://github.com/haskell-distributed/network-transport-inmemory.git
16+ commit: 0ce97924f15a8c1570b2355151834305c9bd2a28
17+ extra-dep: true
18+
19+extra-deps:
20+- rank1dynamic-0.4.0
21+- network-transport-0.5.2
22+- rematch-0.2.0.0
23+
24+flags:
25+ distributed-process-tests:
26+ tcp: true
stack.yamlnew file+22
@@ -0,0 +1,22 @@
1+resolver: lts-12.18 # Use GHC 8.4.4
2+
3+# TODO: we can enable nightly-2018-11-11 once PR #319 is merged
4+
5+packages:
6+- '.'
7+- distributed-process-tests/
8+- location:
9+ git: https://github.com/haskell-distributed/network-transport-tcp.git
10+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
11+ extra-dep: true
12+
13+extra-deps:
14+- rank1dynamic-0.4.0
15+- distributed-static-0.3.8
16+- network-transport-0.5.2
17+- network-transport-inmemory-0.5.2
18+- rematch-0.2.0.0
19+
20+flags:
21+ distributed-process-tests:
22+ tcp: true