git.iko.soy/distributed-process
on f965dad help sign in
69 files changed+3237−7035
since splitsnapshots
unifiedsplit
.gitignore+14−3 .travis.yml+13−42 CONTRIBUTING.md−1 ChangeLog−138 LICENSE−1 Makefile+6 README.md+10−7 REPOS+4 benchmarks/Channels.hs+4−6 benchmarks/Latency.hs+4−7 benchmarks/ProcessRing.hs+4−8 benchmarks/Spawns.hs+4−8 benchmarks/Throughput.hs+4−8 distributed-process-tests/.gitignore−4 distributed-process-tests/CONTRIBUTING.md−1 distributed-process-tests/LICENSE−31 distributed-process-tests/README.md−14 distributed-process-tests/Setup.hs−2 distributed-process-tests/distributed-process-tests.cabal−158 distributed-process-tests/src/Control/Distributed/Process/Tests/CH.hs−1879 distributed-process-tests/src/Control/Distributed/Process/Tests/Closure.hs−589 distributed-process-tests/src/Control/Distributed/Process/Tests/Internal/Utils.hs−243 distributed-process-tests/src/Control/Distributed/Process/Tests/Mx.hs−542 distributed-process-tests/src/Network/Transport/Test.hs−12 distributed-process-tests/tests/runInMemory.hs−30 distributed-process-tests/tests/runTCP.hs−47 distributed-process.cabal+121−114 doc/semantics/CloudHaskellSemantics.tex−706 doc/semantics/Makefile−11 doc/semantics/references.bib−72 src/Control/Distributed/Process.hs+7−74 src/Control/Distributed/Process/Closure.hs−20 src/Control/Distributed/Process/Debug.hs+14−25 src/Control/Distributed/Process/Internal/BiMultiMap.hs−135 src/Control/Distributed/Process/Internal/CQueue.hs+16−68 src/Control/Distributed/Process/Internal/Closure/BuiltIn.hs+8−27 src/Control/Distributed/Process/Internal/Closure/Explicit.hs−147 src/Control/Distributed/Process/Internal/Closure/TH.hs+8−24 src/Control/Distributed/Process/Internal/Messaging.hs+28−37 src/Control/Distributed/Process/Internal/Primitives.hs+106−324 src/Control/Distributed/Process/Internal/Spawn.hs+10−14 src/Control/Distributed/Process/Internal/StrictMVar.hs+5−37 src/Control/Distributed/Process/Internal/Types.hs+33−181 src/Control/Distributed/Process/Internal/WeakTQueue.hs+3−9 src/Control/Distributed/Process/Management.hs+92−352 src/Control/Distributed/Process/Management/Internal/Agent.hs → src/Control/Distributed/Process/Management/Agent.hs+5−29 src/Control/Distributed/Process/Management/Internal/Bus.hs → src/Control/Distributed/Process/Management/Bus.hs+1−1 src/Control/Distributed/Process/Management/Table.hs+219 src/Control/Distributed/Process/Management/Internal/Trace/Primitives.hs → src/Control/Distributed/Process/Management/Trace/Primitives.hs+6−15 src/Control/Distributed/Process/Management/Internal/Trace/Remote.hs → src/Control/Distributed/Process/Management/Trace/Remote.hs+3−3 src/Control/Distributed/Process/Management/Internal/Trace/Tracer.hs → src/Control/Distributed/Process/Management/Trace/Tracer.hs+10−18 src/Control/Distributed/Process/Management/Internal/Trace/Types.hs → src/Control/Distributed/Process/Management/Trace/Types.hs+14−8 src/Control/Distributed/Process/Management/Internal/Types.hs → src/Control/Distributed/Process/Management/Types.hs+23−24 src/Control/Distributed/Process/Node.hs+197−345 src/Control/Distributed/Process/Serializable.hs+8−18 src/Control/Distributed/Process/UnsafePrimitives.hs+31−110 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 tests/TestCH.hs+1339 tests/TestClosure.hs+480 tests/TestMx.hs+213 distributed-process-tests/src/Control/Distributed/Process/Tests/Receive.hs → tests/TestReceive.hs+36−22 distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hs → tests/TestStats.hs+28−24 distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hs → tests/TestTracing.hs+31−127 tests/TestUtils.hs+75
.gitignore+14−3
@@ -1,4 +1,15 @@
1+tags
2+TAGS
13dist/
2−.cabal-sandbox
3−cabal.sandbox.config
4−.stack*
4+\#*#
5+*~
6+*.aux
7+*.hp
8+*.hi
9+*.o
10+*.prof
11+*.ps
12+*.swp
13+cabal-dev
14+cabal-dev*
15+.DS_Store
.travis.yml+13−42
@@ -1,43 +1,14 @@
1−language: c
2−
3−sudo: false
4−
5−matrix:
6− include:
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
19−
20−before_install:
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
25−
26−install:
27−- stack $ARGS setup --no-terminal;
28− stack $ARGS build --no-terminal --only-snapshot --test --no-run-tests;
29−
30−script:
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−
1+language: haskell
2+script: "make ci"
413notifications:
42− slack:
43− secure: LbqbNjK1KiHNiQo/i/Za4vkMD9l9mhmN+PWYFBQkNvGFWffSRayRKFrTqt4znV2p7h4dY1XZFoC7T5RemBVQLq2ppZAUWxkITeu1OUlnmVLDfJLeVYGTR/fn90nP6Y5ITE7T3A07nKmWaRbKpIgFBAOjzgqaM0csscDx3z0WW18=
4+ email:
5+ recipients:
6+ - cloud.haskell@gmail.com
7+ irc:
8+ channels:
9+ - "irc.freenode.org#haskell-distributed"
10+ use_notice: true
11+branches:
12+ only:
13+ - master
14+ - development
CONTRIBUTING.mddeleted−1
@@ -1 +0,0 @@
1−See https://github.com/haskell-distributed/cloud-haskell/blob/master/CONTRIBUTING.md.
ChangeLog−138
@@ -1,141 +1,3 @@
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−
101−2014-12-09 Tim Watson <watson.timothy@gmail.com> 0.5.2
102−
103−* Fix docstring for `register`
104−* Added Data instance to ProcessId, LocalProcessId and NodeId
105−* Add static serialiation dictionary for 'Static', for completeness
106−* Add Closure static serialization dictionary
107−* Replacement for modifyMVarMasked for GHC <= 7.4
108−* Document the use of built-in trace flags
109−* Make forkProcess exception-safe
110−* Make -Wall clean
111−
112−2014-08-13 Tim Watson <watson.timothy@gmail.com> 0.5.1
113−
114−* Fix cabal docs (thanks Markus Barenhoff)
115−* Expose lifted version of Control.Exception.mask_ (thanks Alexander Vershilov)
116−
117−2014-05-30 Tim Watson <watson.timothy@gmail.com> 0.5.0
118−
119−* Dependency on STM implicitly changed from 1.3 to 1.4, but was not reflected in the cabal file
120−* Race condition in local monitoring when using call
121−* mask now works correctly if unmask is called by another process
122−* Improve efficiency of local message passing
123−* nsend uses local communication channels
124−* Link Node Controller and Network Listener
125−* Label spawned processes using labelThread
126−* Relaxed upper bound on syb in the cabal manifest
127−* Bump binary version to include 0.7.*
128−* Exposed process info
129−* Exposed node statistics
130−* Moved tests to https://github.com/haskell-distributed/distributed-process-tests
131−* Added "polymorphic expect"
132−* Exposed Message type and broaden scope of polymorphic expect
133−* Added Management API (for working with internal/system events)
134−* Tracing can no longer be disabled
135−* We now report node statistics for monitoring/management
136−* Node.runProcess now propagates exceptions to its caller
137−* Added simple micro benchmarks
138−
13912013-01-27 Tim Watson <watson.timothy@gmail.com> 0.4.2
1402
1413* Improved exception handling for deferred type checked exit reasons
LICENSE−1
@@ -1,5 +1,4 @@
11Copyright Well-Typed LLP, 2011-2012
2−Copyright Tweag I/O Limited, 2015
32
43All rights reserved.
54
Makefilenew file+6
@@ -0,0 +1,6 @@
1+
2+ifneq (,$(BASE_DIR))
3+include $(BASE_DIR)/build.mk
4+else
5+include ../build.mk
6+endif
README.md+10−7
@@ -1,16 +1,19 @@
1−# distributed-process
2−[![travis](https://secure.travis-ci.org/haskell-distributed/distributed-process.png)](http://travis-ci.org/haskell-distributed/distributed-process)
3−[![Release](https://img.shields.io/hackage/v/distributed-process.svg)](https://hackage.haskell.org/package/distributed-process)
1+### distributed-process
42
53This repository is part of Cloud Haskell.
64
75See http://haskell-distributed.github.com for documentation, user guides,
86tutorials and assistance.
97
10−## Getting Help / Raising Issues
8+### Getting Help / Raising Issues
119
12−Please visit the [bug tracker](https://github.com/haskell-distributed/distributed-process/issues) to submit issues. You can contact the distributed-haskell@googlegroups.com mailing list for help and comments.
10+Please visit our [bug tracker](http://cloud-haskell.atlassian.net) to submit
11+issues. Anyone can browse, although you'll need to provide an email address
12+and create an account in order to submit new issues.
1313
14−## License
14+If you'd like to talk to a human, please contact us at the parallel-haskell
15+mailing list in the first instance - parallel-haskell@googlegroups.com.
1516
16−This package is made available under a 3-clause BSD-style license.
17+### License
18+
19+distributed-process is made available under a BSD-3 license.
REPOSnew file+4
@@ -0,0 +1,4 @@
1+rank1dynamic
2+distributed-static
3+network-transport
4+network-transport-tcp
benchmarks/Channels.hs+4−6
@@ -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, defaultTCPAddr, defaultTCPParameters)
7+import Network.Transport.TCP (createTransport, defaultTCPParameters)
88import Data.Binary (encode, decode)
99import qualified Data.ByteString.Lazy as BSL
1010
@@ -36,8 +36,6 @@ initialProcess "CLIENT" = do
3636main :: IO ()
3737main = do
3838 [role, host, port] <- getArgs
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
39+ Right transport <- createTransport host port defaultTCPParameters
40+ node <- newLocalNode transport initRemoteTable
41+ runProcess node $ initialProcess role
benchmarks/Latency.hs+4−7
@@ -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, defaultTCPAddr, defaultTCPParameters)
6+import Network.Transport.TCP (createTransport, defaultTCPParameters)
77import Data.Binary (encode, decode)
88import qualified Data.ByteString.Lazy as BSL
99
@@ -31,9 +31,6 @@ initialProcess "CLIENT" = do
3131main :: IO ()
3232main = do
3333 [role, host, port] <- getArgs
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
34+ Right transport <- createTransport host port defaultTCPParameters
35+ node <- newLocalNode transport initRemoteTable
36+ runProcess node $ initialProcess role
benchmarks/ProcessRing.hs+4−8
@@ -4,15 +4,11 @@ To run the benchmarks, select a value for the ring size (sz) and
44the number of times to send a message around the ring
55
66-}
7−
8−{-# LANGUAGE BangPatterns #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−
117import Control.Monad
128import Control.Distributed.Process hiding (catch)
139import Control.Distributed.Process.Node
1410import Control.Exception (catch, SomeException)
15−import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
11+import Network.Transport.TCP (createTransport, defaultTCPParameters)
1612import System.Environment
1713import System.Console.GetOpt
1814
@@ -85,7 +81,7 @@ options =
8581 (NoArg (\opts -> opts { optUnsafe = True }))
8682 "use 'unsafeSend' (ignored with -f) - default = False"
8783 , Option ['p'] ["parallel"]
88− (NoArg (\opts -> opts { optParallel = True }))
84+ (NoArg (\opts -> opts { optForward = True }))
8985 "send in parallel and consume sequentially - default = False"
9086 ]
9187
@@ -110,8 +106,8 @@ main = do
110106 argv <- getArgs
111107 (opt, _) <- parseArgv argv
112108 putStrLn $ "options: " ++ (show opt)
113− Right transport <- createTransport
114− (defaultTCPAddr "127.0.0.1" "8090" ) defaultTCPParameters
109+ Right transport <- createTransport "127.0.0.1" "8090" defaultTCPParameters
115110 node <- newLocalNode transport initRemoteTable
116111 catch (void $ runProcess node $ initialProcess opt)
117112 (\(e :: SomeException) -> putStrLn $ "ERROR: " ++ (show e))
113+
benchmarks/Spawns.hs+4−8
@@ -1,5 +1,3 @@
1−{-# LANGUAGE BangPatterns #-}
2−
31-- | Like Throughput, but send every ping from a different process
42-- (i.e., require a lightweight connection per ping)
53import System.Environment
@@ -7,7 +5,7 @@ import Control.Monad
75import Control.Applicative
86import Control.Distributed.Process
97import Control.Distributed.Process.Node
10−import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
8+import Network.Transport.TCP (createTransport, defaultTCPParameters)
119import Data.Binary (encode, decode)
1210import qualified Data.ByteString.Lazy as BSL
1311
@@ -42,8 +40,6 @@ initialProcess "CLIENT" = do
4240main :: IO ()
4341main = do
4442 [role, host, port] <- getArgs
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
43+ Right transport <- createTransport host port defaultTCPParameters
44+ node <- newLocalNode transport initRemoteTable
45+ runProcess node $ initialProcess role
benchmarks/Throughput.hs+4−8
@@ -1,12 +1,10 @@
1−{-# LANGUAGE BangPatterns #-}
21{-# LANGUAGE DeriveDataTypeable #-}
3−
42import System.Environment
53import Control.Monad
64import Control.Applicative
75import Control.Distributed.Process
86import Control.Distributed.Process.Node
9−import Network.Transport.TCP (createTransport, defaultTCPParameters, defaultTCPAddr)
7+import Network.Transport.TCP (createTransport, defaultTCPParameters)
108import Data.Binary
119import qualified Data.ByteString.Lazy as BSL
1210import Data.Typeable
@@ -67,8 +65,6 @@ initialProcess "CLIENT" = do
6765main :: IO ()
6866main = do
6967 [role, host, port] <- getArgs
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
68+ Right transport <- createTransport host port defaultTCPParameters
69+ node <- newLocalNode transport initRemoteTable
70+ runProcess node $ initialProcess role
distributed-process-tests/.gitignoredeleted−4
@@ -1,4 +0,0 @@
1−dist/
2−.cabal-sandbox
3−cabal.sandbox.config
4−.stack*
distributed-process-tests/CONTRIBUTING.mddeleted−1
@@ -1 +0,0 @@
1−See https://github.com/haskell-distributed/cloud-haskell/blob/master/CONTRIBUTING.md.
distributed-process-tests/LICENSEdeleted−31
@@ -1,31 +0,0 @@
1−Copyright Well-Typed LLP, 2011-2012
2−
3−All rights reserved.
4−
5−Redistribution and use in source and binary forms, with or without
6−modification, are permitted provided that the following conditions are met:
7−
8− * Redistributions of source code must retain the above copyright
9− notice, this list of conditions and the following disclaimer.
10−
11− * Redistributions in binary form must reproduce the above
12− copyright notice, this list of conditions and the following
13− disclaimer in the documentation and/or other materials provided
14− with the distribution.
15−
16− * Neither the name of the owner nor the names of other
17− contributors may be used to endorse or promote products derived
18− from this software without specific prior written permission.
19−
20−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31−
distributed-process-tests/README.mddeleted−14
@@ -1,14 +0,0 @@
1−# distributed-process-tests
2−[![travis](https://secure.travis-ci.org/haskell-distributed/distributed-process-tests.png)](http://travis-ci.org/haskell-distributed/distributed-process-tests)
3−[![Release](https://img.shields.io/hackage/v/distributed-process-tests.svg)](https://hackage.haskell.org/package/distributed-process-tests)
4−
5−See http://haskell-distributed.github.com for documentation, user guides,
6−tutorials and assistance.
7−
8−## Getting Help / Raising Issues
9−
10−Please visit the [bug tracker](https://github.com/haskell-distributed/distributed-process-tests/issues) to submit issues. You can contact the distributed-haskell@googlegroups.com mailing list for help and comments.
11−
12−## License
13−
14−This package is made available under a 3-clause BSD-style license.
distributed-process-tests/Setup.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Distribution.Simple
2−main = defaultMain
distributed-process-tests/distributed-process-tests.cabaldeleted−158
@@ -1,158 +0,0 @@
1−name: distributed-process-tests
2−version: 0.4.11
3−synopsis: Tests and test support tools for distributed-process.
4−homepage: http://github.com/haskell-distributed/distributed-process/tree/master/distributed-process-tests
5−description: Tests and test suite for Cloud Haskell libraries.
6−license: BSD3
7−license-file: LICENSE
8−Author: Duncan Coutts, Nicolas Wu, Edsko de Vries
9−Maintainer: Tim Watson <watson.timothy@gmail.com>
10−copyright: Well-Typed LLP
11−category: Control, Cloud Haskell
12−build-type: Simple
13−cabal-version: >=1.8
14−
15−flag tcp
16− Description: build and run TCP tests
17− Default: False
18−
19−library
20− exposed-modules: Network.Transport.Test
21− Control.Distributed.Process.Tests.CH
22− Control.Distributed.Process.Tests.Closure
23− Control.Distributed.Process.Tests.Mx
24− Control.Distributed.Process.Tests.Receive
25− Control.Distributed.Process.Tests.Stats
26− Control.Distributed.Process.Tests.Tracing
27− Control.Distributed.Process.Tests.Internal.Utils
28− Build-Depends: base >= 4.4 && < 5,
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,
33− distributed-static,
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,
38− random >= 1.0 && < 1.2,
39− rematch >= 0.1.2.1,
40− setenv >= 0.1.1.3,
41− test-framework >= 0.6 && < 0.9,
42− test-framework-hunit >= 0.2.0 && < 0.4,
43− stm
44− hs-source-dirs: src
45− ghc-options: -Wall -fno-warn-unused-do-bind
46− extensions: CPP,
47− ExistentialQuantification,
48− FlexibleInstances,
49− DeriveDataTypeable,
50− DeriveGeneric,
51− GeneralizedNewtypeDeriving,
52− RankNTypes,
53− RecordWildCards,
54− ScopedTypeVariables
55− if impl(ghc <= 7.4.2)
56− Build-Depends: ghc-prim == 0.2.0.0
57−
58−Test-Suite TestCHInMemory
59− Type: exitcode-stdio-1.0
60− Main-Is: runInMemory.hs
61− CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.CH
62− Build-Depends: base >= 4.4 && < 5,
63− distributed-process-tests,
64− network >= 2.3 && < 2.9,
65− network-transport >= 0.4.1.0 && < 0.6,
66− network-transport-inmemory >= 0.5,
67− test-framework >= 0.6 && < 0.9
68− Extensions: CPP
69− ghc-options: -Wall -threaded -eventlog -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
70− HS-Source-Dirs: tests
71−
72−Test-Suite TestCHInTCP
73− Type: exitcode-stdio-1.0
74− Main-Is: runTCP.hs
75− CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.CH
76− if flag(tcp)
77− Build-Depends: base >= 4.4 && < 5,
78− distributed-process-tests,
79− network >= 2.3 && < 2.9,
80− network-transport >= 0.4.1.0 && < 0.6,
81− network-transport-tcp >= 0.5 && < 0.7,
82− test-framework >= 0.6 && < 0.9
83− else
84− Buildable: False
85− Extensions: CPP
86− ghc-options: -Wall -threaded -eventlog -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
87− HS-Source-Dirs: tests
88−
89−
90−Test-Suite TestClosure
91− Type: exitcode-stdio-1.0
92− Main-Is: runInMemory.hs
93− CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Closure
94− Build-Depends: base >= 4.4 && < 5,
95− distributed-process-tests,
96− network >= 2.3 && < 2.9,
97− network-transport >= 0.4.1.0 && < 0.6,
98− network-transport-inmemory >= 0.5,
99− test-framework >= 0.6 && < 0.9
100− Extensions: CPP
101− ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
102− HS-Source-Dirs: tests
103−
104−Test-Suite TestStats
105− Type: exitcode-stdio-1.0
106− Main-Is: runInMemory.hs
107− CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Stats
108− Build-Depends: base >= 4.4 && < 5,
109− distributed-process-tests,
110− network >= 2.3 && < 2.9,
111− network-transport >= 0.4.1.0 && < 0.6,
112− network-transport-inmemory >= 0.5,
113− test-framework >= 0.6 && < 0.9
114− Extensions: CPP
115− ghc-options: -Wall -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
116− HS-Source-Dirs: tests
117−
118−Test-Suite TestMxInMemory
119− Type: exitcode-stdio-1.0
120− Main-Is: runInMemory.hs
121− CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Mx
122− Build-Depends: base >= 4.4 && < 5,
123− distributed-process-tests,
124− network >= 2.3 && < 2.9,
125− network-transport >= 0.4.1.0 && < 0.6,
126− network-transport-inmemory >= 0.5,
127− test-framework >= 0.6 && < 0.9
128− Extensions: CPP
129− ghc-options: -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
130− HS-Source-Dirs: tests
131−
132−Test-Suite TestTracingInMemory
133− Type: exitcode-stdio-1.0
134− Main-Is: runInMemory.hs
135− CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Tracing
136− Build-Depends: base >= 4.4 && < 5,
137− distributed-process-tests,
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,
154− network-transport-inmemory >= 0.5,
155− test-framework >= 0.6 && < 0.9
156− Extensions: CPP
157− ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
158− HS-Source-Dirs: tests
distributed-process-tests/src/Control/Distributed/Process/Tests/CH.hsdeleted−1879
@@ -1,1879 +0,0 @@
1−module Control.Distributed.Process.Tests.CH (tests) where
2−
3−#if ! MIN_VERSION_base(4,6,0)
4−import Prelude hiding (catch)
5−#endif
6−
7−import Network.Transport.Test (TestTransport(..))
8−
9−import Data.Binary (Binary(..))
10−import Data.Typeable (Typeable)
11−import Data.Foldable (forM_)
12−import Data.Function (fix)
13−import Data.IORef
14− ( readIORef
15− , writeIORef
16− , newIORef
17− )
18−import Control.Concurrent (forkIO, threadDelay, myThreadId, throwTo, ThreadId, yield)
19−import Control.Concurrent.MVar
20− ( MVar
21− , newEmptyMVar
22− , putMVar
23− , takeMVar
24− , readMVar
25− )
26−import Control.Monad (replicateM_, replicateM, forever, void, unless, join)
27−import Control.Exception (SomeException, throwIO, ErrorCall(..))
28−import Control.Monad.Catch (try, catch, finally, mask, onException)
29−import Control.Applicative ((<|>))
30−import qualified Network.Transport as NT (closeEndPoint, EndPointAddress)
31−import Control.Distributed.Process hiding
32− ( try
33− , catch
34− , finally
35− , mask
36− , onException
37− )
38−import Control.Distributed.Process.Internal.Types
39− ( LocalNode(localEndPoint)
40− , ProcessExitException(..)
41− , nullProcessId
42− , createUnencodedMessage
43− )
44−import 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)
48−import Control.Distributed.Process.Serializable (Serializable)
49−import Data.Maybe (isNothing, isJust)
50−import Test.HUnit (Assertion, assertBool, assertFailure)
51−import Test.Framework (Test, testGroup)
52−import Test.Framework.Providers.HUnit (testCase)
53−import Control.Rematch hiding (match, isNothing, isJust)
54−import Control.Rematch.Run (Match(..))
55−
56−newtype Ping = Ping ProcessId
57− deriving (Typeable, Binary, Show)
58−
59−newtype Pong = Pong ProcessId
60− deriving (Typeable, Binary, Show)
61−
62−--------------------------------------------------------------------------------
63−-- Supporting definitions --
64−--------------------------------------------------------------------------------
65−
66−expectThat :: a -> Matcher a -> Assertion
67−expectThat a matcher = case res of
68− MatchSuccess -> return ()
69− (MatchFailure msg) -> assertFailure msg
70− where res = runMatch matcher a
71−
72−-- | Like fork, but throw exceptions in the child thread to the parent
73−forkTry :: IO () -> IO ThreadId
74−forkTry p = do
75− tid <- myThreadId
76− forkIO $ catch p (\e -> throwTo tid (e :: SomeException))
77−
78−-- | The ping server from the paper
79−ping :: Process ()
80−ping = do
81− Pong partner <- expect
82− self <- getSelfPid
83− send partner (Ping self)
84− ping
85−
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−
94−-- | Quick and dirty synchronous version of whereisRemoteAsync
95−whereisRemote :: NodeId -> String -> Process (Maybe ProcessId)
96−whereisRemote nid string = do
97− whereisRemoteAsync nid string
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 ()
126−
127−data Add = Add ProcessId Double Double deriving (Typeable)
128−data Divide = Divide ProcessId Double Double deriving (Typeable)
129−data DivByZero = DivByZero deriving (Typeable)
130−
131−instance Binary Add where
132− put (Add pid x y) = put pid >> put x >> put y
133− get = Add <$> get <*> get <*> get
134−
135−instance Binary Divide where
136− put (Divide pid x y) = put pid >> put x >> put y
137− get = Divide <$> get <*> get <*> get
138−
139−instance Binary DivByZero where
140− put DivByZero = return ()
141− get = return DivByZero
142−
143−-- The math server from the paper
144−math :: Process ()
145−math = do
146− receiveWait
147− [ match (\(Add pid x y) -> send pid (x + y))
148− , matchIf (\(Divide _ _ y) -> y /= 0)
149− (\(Divide pid x y) -> send pid (x / y))
150− , match (\(Divide pid _ _) -> send pid DivByZero)
151− ]
152− math
153−
154−-- | Monitor or link to a remote node
155−monitorOrLink :: Bool -- ^ 'True' for monitor, 'False' for link
156− -> ProcessId -- ^ Process to monitor/link to
157− -> Maybe (MVar ()) -- ^ MVar to signal on once the monitor has been set up
158− -> Process (Maybe MonitorRef)
159−monitorOrLink mOrL pid mSignal = do
160− result <- if mOrL then Just <$> monitor pid
161− else link pid >> return Nothing
162− -- Monitor is asynchronous, which usually does not matter but if we want a
163− -- *specific* signal then it does. Therefore we wait until the MonitorRef is
164− -- listed in the ProcessInfo and hope that this means the monitor has been set
165− -- up.
166− forM_ mSignal $ \signal -> do
167− self <- getSelfPid
168− spawnLocal $ do
169− let waitForMOrL = do
170− liftIO $ threadDelay 100000
171− mpinfo <- getProcessInfo pid
172− case mpinfo of
173− Nothing -> waitForMOrL
174− Just pinfo ->
175− if mOrL then
176− unless (result == lookup self (infoMonitors pinfo)) waitForMOrL
177− else
178− unless (elem self $ infoLinks pinfo) waitForMOrL
179− waitForMOrL
180− liftIO $ putMVar signal ()
181− return result
182−
183−monitorTestProcess :: ProcessId -- Process to monitor/link to
184− -> Bool -- 'True' for monitor, 'False' for link
185− -> Bool -- Should we unmonitor?
186− -> DiedReason -- Expected cause of death
187− -> Maybe (MVar ()) -- Signal for 'monitor set up'
188− -> MVar () -- Signal for successful termination
189− -> Process ()
190−monitorTestProcess theirAddr mOrL un reason monitorSetup done =
191− catch (do mRef <- monitorOrLink mOrL theirAddr monitorSetup
192− case (un, mRef) of
193− (True, Nothing) -> do
194− unlink theirAddr
195− liftIO $ putMVar done ()
196− (True, Just ref) -> do
197− unmonitor ref
198− liftIO $ putMVar done ()
199− (False, ref) -> do
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− ]
208− )
209− (\(ProcessLinkException pid reason') -> do
210− (liftIO $ assertBool "link exception unmatched" $
211− pid == theirAddr && not mOrL && not un && reason == reason')
212− liftIO $ putMVar done ()
213− )
214−
215−--------------------------------------------------------------------------------
216−-- The tests proper --
217−--------------------------------------------------------------------------------
218−
219−-- | Basic ping test
220−testPing :: TestTransport -> Assertion
221−testPing TestTransport{..} = do
222− serverAddr <- newEmptyMVar
223− clientDone <- newEmptyMVar
224−
225− -- Server
226− forkIO $ do
227− localNode <- newLocalNode testTransport initRemoteTable
228− addr <- forkProcess localNode ping
229− putMVar serverAddr addr
230−
231− -- Client
232− forkIO $ do
233− localNode <- newLocalNode testTransport initRemoteTable
234− pingServer <- readMVar serverAddr
235−
236− let numPings = 10000
237−
238− runProcess localNode $ do
239− pid <- getSelfPid
240− replicateM_ numPings $ do
241− send pingServer (Pong pid)
242− p <- expectTimeout 3000000
243− case p of
244− Just (Ping _) -> return ()
245− Nothing -> die "Failed to receive Ping"
246−
247− putMVar clientDone ()
248−
249− takeMVar clientDone
250−
251−-- | Monitor a process on an unreachable node
252−testMonitorUnreachable :: TestTransport -> Bool -> Bool -> Assertion
253−testMonitorUnreachable TestTransport{..} mOrL un = do
254− deadProcess <- newEmptyMVar
255− done <- newEmptyMVar
256−
257− forkIO $ do
258− localNode <- newLocalNode testTransport initRemoteTable
259− addr <- forkProcess localNode expect
260− closeLocalNode localNode
261− putMVar deadProcess addr
262−
263− forkIO $ do
264− localNode <- newLocalNode testTransport initRemoteTable
265− theirAddr <- readMVar deadProcess
266− runProcess localNode $
267− monitorTestProcess theirAddr mOrL un DiedDisconnect Nothing done
268−
269− takeMVar done
270−
271−-- | Monitor a process which terminates normally
272−testMonitorNormalTermination :: TestTransport -> Bool -> Bool -> Assertion
273−testMonitorNormalTermination TestTransport{..} mOrL un = do
274− monitorSetup <- newEmptyMVar
275− monitoredProcess <- newEmptyMVar
276− done <- newEmptyMVar
277−
278− forkIO $ do
279− localNode <- newLocalNode testTransport initRemoteTable
280− addr <- forkProcess localNode $
281− liftIO $ readMVar monitorSetup
282− putMVar monitoredProcess addr
283−
284− forkIO $ do
285− localNode <- newLocalNode testTransport initRemoteTable
286− theirAddr <- readMVar monitoredProcess
287− runProcess localNode $
288− monitorTestProcess theirAddr mOrL un DiedNormal (Just monitorSetup) done
289−
290− takeMVar done
291−
292−-- | Monitor a process which terminates abnormally
293−testMonitorAbnormalTermination :: TestTransport -> Bool -> Bool -> Assertion
294−testMonitorAbnormalTermination TestTransport{..} mOrL un = do
295− monitorSetup <- newEmptyMVar
296− monitoredProcess <- newEmptyMVar
297− done <- newEmptyMVar
298−
299− let err = userError "Abnormal termination"
300−
301− forkIO $ do
302− localNode <- newLocalNode testTransport initRemoteTable
303− addr <- forkProcess localNode . liftIO $ do
304− readMVar monitorSetup
305− throwIO err
306− putMVar monitoredProcess addr
307−
308− forkIO $ do
309− localNode <- newLocalNode testTransport initRemoteTable
310− theirAddr <- readMVar monitoredProcess
311− runProcess localNode $
312− monitorTestProcess theirAddr mOrL un (DiedException (show err)) (Just monitorSetup) done
313−
314− takeMVar done
315−
316−-- | Monitor a local process that is already dead
317−testMonitorLocalDeadProcess :: TestTransport -> Bool -> Bool -> Assertion
318−testMonitorLocalDeadProcess TestTransport{..} mOrL un = do
319− processAddr <- newEmptyMVar
320− localNode <- newLocalNode testTransport initRemoteTable
321− done <- newEmptyMVar
322−
323− forkIO $ do
324− addr <- forkProcess localNode $ return ()
325− putMVar processAddr addr
326−
327− forkIO $ do
328− theirAddr <- readMVar processAddr
329− runProcess localNode $ do
330− monitor theirAddr
331− -- wait for the process to die
332− expect :: Process ProcessMonitorNotification
333− monitorTestProcess theirAddr mOrL un DiedUnknownId Nothing done
334−
335− takeMVar done
336−
337−-- | Monitor a remote process that is already dead
338−testMonitorRemoteDeadProcess :: TestTransport -> Bool -> Bool -> Assertion
339−testMonitorRemoteDeadProcess TestTransport{..} mOrL un = do
340− processDead <- newEmptyMVar
341− processAddr <- newEmptyMVar
342− done <- newEmptyMVar
343−
344− forkIO $ do
345− localNode <- newLocalNode testTransport initRemoteTable
346− addr <- forkProcess localNode . liftIO $ putMVar processDead ()
347− putMVar processAddr addr
348−
349− forkIO $ do
350− localNode <- newLocalNode testTransport initRemoteTable
351− theirAddr <- readMVar processAddr
352− readMVar processDead
353− runProcess localNode $ do
354− monitorTestProcess theirAddr mOrL un DiedUnknownId Nothing done
355−
356− takeMVar done
357−
358−-- | Monitor a process that becomes disconnected
359−testMonitorDisconnect :: TestTransport -> Bool -> Bool -> Assertion
360−testMonitorDisconnect TestTransport{..} mOrL un = do
361− processAddr <- newEmptyMVar
362− processAddr2 <- newEmptyMVar
363− monitorSetup <- newEmptyMVar
364− done <- newEmptyMVar
365−
366− forkIO $ do
367− localNode <- newLocalNode testTransport initRemoteTable
368− addr <- forkProcess localNode $ expect
369− addr2 <- forkProcess localNode $ return ()
370− putMVar processAddr addr
371− readMVar monitorSetup
372− NT.closeEndPoint (localEndPoint localNode)
373− putMVar processAddr2 addr2
374−
375− forkIO $ do
376− localNode <- newLocalNode testTransport initRemoteTable
377− theirAddr <- readMVar processAddr
378− forkProcess localNode $ do
379− lc <- liftIO $ readMVar processAddr2
380− send lc ()
381− runProcess localNode $ do
382− monitorTestProcess theirAddr mOrL un DiedDisconnect (Just monitorSetup) done
383−
384− takeMVar done
385−
386−-- | Test the math server (i.e., receiveWait)
387−testMath :: TestTransport -> Assertion
388−testMath TestTransport{..} = do
389− serverAddr <- newEmptyMVar
390− clientDone <- newEmptyMVar
391−
392− -- Server
393− forkIO $ do
394− localNode <- newLocalNode testTransport initRemoteTable
395− addr <- forkProcess localNode math
396− putMVar serverAddr addr
397−
398− -- Client
399− forkIO $ do
400− localNode <- newLocalNode testTransport initRemoteTable
401− mathServer <- readMVar serverAddr
402−
403− runProcess localNode $ do
404− pid <- getSelfPid
405− send mathServer (Add pid 1 2)
406− three <- expect :: Process Double
407− send mathServer (Divide pid 8 2)
408− four <- expect :: Process Double
409− send mathServer (Divide pid 8 0)
410− divByZ <- expect
411− liftIO $ putMVar clientDone (three, four, divByZ)
412−
413− res <- takeMVar clientDone
414− case res of
415− (3, 4, DivByZero) -> return ()
416− _ -> error $ "Something went horribly wrong"
417−
418−-- | Send first message (i.e. connect) to an already terminated process
419−-- (without monitoring); then send another message to a second process on
420−-- the same remote node (we're checking that the remote node did not die)
421−testSendToTerminated :: TestTransport -> Assertion
422−testSendToTerminated TestTransport{..} = do
423− serverAddr1 <- newEmptyMVar
424− serverAddr2 <- newEmptyMVar
425− clientDone <- newEmptyMVar
426−
427− forkIO $ do
428− terminated <- newEmptyMVar
429− localNode <- newLocalNode testTransport initRemoteTable
430− addr1 <- forkProcess localNode $ liftIO $ putMVar terminated ()
431− addr2 <- forkProcess localNode $ ping
432− readMVar terminated
433− putMVar serverAddr1 addr1
434− putMVar serverAddr2 addr2
435−
436− forkIO $ do
437− localNode <- newLocalNode testTransport initRemoteTable
438− server1 <- readMVar serverAddr1
439− server2 <- readMVar serverAddr2
440− runProcess localNode $ do
441− pid <- getSelfPid
442− send server1 "Hi"
443− send server2 (Pong pid)
444− expectPing clientDone
445−
446− verifyClient "Expected Ping from server" clientDone
447−
448−-- | Test (non-zero) timeout
449−testTimeout :: TestTransport -> Assertion
450−testTimeout TestTransport{..} = do
451− localNode <- newLocalNode testTransport initRemoteTable
452− done <- newEmptyMVar
453−
454− runProcess localNode $ do
455− res <- receiveTimeout 1000000 [match (\Add{} -> return ())]
456− liftIO $ putMVar done $ res == Nothing
457−
458− verifyClient "Expected receiveTimeout to timeout..." done
459−
460−-- | Test zero timeout
461−testTimeout0 :: TestTransport -> Assertion
462−testTimeout0 TestTransport{..} = do
463− serverAddr <- newEmptyMVar
464− clientDone <- newEmptyMVar
465−
466− forkIO $ do
467− localNode <- newLocalNode testTransport initRemoteTable
468− addr <- forkProcess localNode $ do
469− -- Variation on the venerable ping server which uses a zero timeout
470− partner <- fix $ \loop ->
471− receiveTimeout 0 [match (\(Pong partner) -> return partner)]
472− >>= maybe (liftIO (threadDelay 100000) >> loop) return
473− self <- getSelfPid
474− send partner (Ping self)
475− putMVar serverAddr addr
476−
477− forkIO $ do
478− localNode <- newLocalNode testTransport initRemoteTable
479− server <- readMVar serverAddr
480− runProcess localNode $ do
481− pid <- getSelfPid
482− -- Send a bunch of messages. A large number of messages that the server
483− -- is not interested in, and then a single message that it wants
484− replicateM_ 10000 $ send server "Irrelevant message"
485− send server (Pong pid)
486− expectPing clientDone
487−
488− verifyClient "Expected Ping from server" clientDone
489−
490−-- | Test typed channels
491−testTypedChannels :: TestTransport -> Assertion
492−testTypedChannels TestTransport{..} = do
493− serverChannel <- newEmptyMVar :: IO (MVar (SendPort (SendPort Bool, Int)))
494− clientDone <- newEmptyMVar
495−
496− forkIO $ do
497− localNode <- newLocalNode testTransport initRemoteTable
498− forkProcess localNode $ do
499− (serverSendPort, rport) <- newChan
500− liftIO $ putMVar serverChannel serverSendPort
501− (clientSendPort, i) <- receiveChan rport
502− sendChan clientSendPort (even i)
503− return ()
504−
505− forkIO $ do
506− localNode <- newLocalNode testTransport initRemoteTable
507− serverSendPort <- readMVar serverChannel
508− runProcess localNode $ do
509− (clientSendPort, rport) <- newChan
510− sendChan serverSendPort (clientSendPort, 5)
511− ch <- receiveChan rport
512− liftIO $ putMVar clientDone $ ch == False
513−
514− verifyClient "Expected channel to send 'False'" clientDone
515−
516−-- | Test merging receive ports
517−testMergeChannels :: TestTransport -> Assertion
518−testMergeChannels TestTransport{..} = do
519− localNode <- newLocalNode testTransport initRemoteTable
520− testFlat localNode True "aaabbbccc"
521− testFlat localNode False "abcabcabc"
522− testNested localNode True True "aaabbbcccdddeeefffggghhhiii"
523− testNested localNode True False "adgadgadgbehbehbehcficficfi"
524− testNested localNode False True "abcabcabcdefdefdefghighighi"
525− testNested localNode False False "adgbehcfiadgbehcfiadgbehcfi"
526− testBlocked localNode True
527− testBlocked localNode False
528− where
529− -- Single layer of merging
530− testFlat :: LocalNode -> Bool -> String -> IO ()
531− testFlat localNode biased expected = do
532− done <- newEmptyMVar
533− forkProcess localNode $ do
534− rs <- mapM charChannel "abc"
535− m <- mergePorts biased rs
536− xs <- replicateM 9 $ receiveChan m
537− liftIO $ putMVar done $ xs == expected
538− verifyClient "Expected single layer merge to match expected ordering" done
539−
540− -- Two layers of merging
541− testNested :: LocalNode -> Bool -> Bool -> String -> IO ()
542− testNested localNode biasedInner biasedOuter expected = do
543− done <- newEmptyMVar
544− forkProcess localNode $ do
545− rss <- mapM (mapM charChannel) ["abc", "def", "ghi"]
546− ms <- mapM (mergePorts biasedInner) rss
547− m <- mergePorts biasedOuter ms
548− xs <- replicateM (9 * 3) $ receiveChan m
549− liftIO $ putMVar done $ xs == expected
550− verifyClient "Expected nested channels to match expeted ordering" done
551−
552− -- Test that if no messages are (immediately) available, the scheduler makes no difference
553− testBlocked :: LocalNode -> Bool -> IO ()
554− testBlocked localNode biased = do
555− vs <- replicateM 3 newEmptyMVar
556− done <- newEmptyMVar
557−
558− forkProcess localNode $ do
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"
589−
590− forkProcess localNode $ do
591− (ss, rs) <- unzip <$> replicateM 3 newChan
592− liftIO $ mapM_ (uncurry putMVar) $ zip vs ss
593− m <- mergePorts biased rs
594− xs <- replicateM (6 * 3) $ receiveChan m
595− liftIO $ putMVar done $ xs == "abcacbbacbcacabcba"
596−
597− verifyClient "Expected merged ports to match expected ordering" done
598−
599− mergePorts :: Serializable a => Bool -> [ReceivePort a] -> Process (ReceivePort a)
600− mergePorts True = mergePortsBiased
601− mergePorts False = mergePortsRR
602−
603− charChannel :: Char -> Process (ReceivePort Char)
604− charChannel c = do
605− (sport, rport) <- newChan
606− replicateM_ 3 $ sendChan sport c
607− liftIO $ threadDelay 10000 -- Make sure messages have been sent
608− return rport
609−
610−testTerminate :: TestTransport -> Assertion
611−testTerminate TestTransport{..} = do
612− localNode <- newLocalNode testTransport initRemoteTable
613− runProcess localNode $ do
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"
618−
619−testMonitorNode :: TestTransport -> Assertion
620−testMonitorNode TestTransport{..} = do
621− [node1, node2] <- replicateM 2 $ newLocalNode testTransport initRemoteTable
622− done <- newEmptyMVar
623−
624− closeLocalNode node1
625−
626− runProcess node2 $ do
627− ref <- monitorNode (localNodeId node1)
628− receiveWait [
629− match (\(NodeMonitorNotification ref' nid DiedDisconnect) ->
630− return $ ref == ref' && nid == localNodeId node1)
631− ] >>= liftIO . putMVar done
632−
633− verifyClient "Expected NodeMonitorNotification with matching ref & nodeId" done
634−
635−testMonitorLiveNode :: TestTransport -> Assertion
636−testMonitorLiveNode TestTransport{..} = do
637− [node1, node2] <- replicateM 2 $ newLocalNode testTransport initRemoteTable
638− ready <- newEmptyMVar
639− readyr <- newEmptyMVar
640− done <- newEmptyMVar
641−
642− p <- forkProcess node1 $ return ()
643− forkProcess node2 $ do
644− ref <- monitorNode (localNodeId node1)
645− liftIO $ putMVar ready ()
646− liftIO $ takeMVar readyr
647− send p ()
648− receiveWait [
649− match (\(NodeMonitorNotification ref' nid _) ->
650− (return $ ref == ref' && nid == localNodeId node1))
651− ] >>= liftIO . putMVar done
652−
653− takeMVar ready
654− closeLocalNode node1
655− putMVar readyr ()
656−
657− verifyClient "Expected NodeMonitorNotification for LIVE node" done
658−
659−testMonitorChannel :: TestTransport -> Assertion
660−testMonitorChannel TestTransport{..} = do
661− [node1, node2] <- replicateM 2 $ newLocalNode testTransport initRemoteTable
662− gotNotification <- newEmptyMVar
663−
664− pid <- forkProcess node1 $ do
665− sport <- expect :: Process (SendPort ())
666− ref <- monitorPort sport
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
674−
675− runProcess node2 $ do
676− (sport, _) <- newChan :: Process (SendPort (), ReceivePort ())
677− send pid sport
678− liftIO $ threadDelay 100000
679−
680− verifyClient "Expected PortMonitorNotification" gotNotification
681−
682−testRegistry :: TestTransport -> Assertion
683−testRegistry TestTransport{..} = do
684− node <- newLocalNode testTransport initRemoteTable
685− done <- newEmptyMVar
686−
687− pingServer <- forkProcess node ping
688− deadProcess <- forkProcess node (return ())
689−
690− runProcess node $ do
691− register "ping" pingServer
692− whereis "ping" >>= liftIO . assertBool "Unexpected ping" . (== Just pingServer)
693− us <- getSelfPid
694− nsend "ping" (Pong us)
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
701− liftIO $ putMVar done ()
702−
703− takeMVar done
704−
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−
714−testRegistryRemoteProcess :: TestTransport -> Assertion
715−testRegistryRemoteProcess TestTransport{..} = do
716− node1 <- newLocalNode testTransport initRemoteTable
717− node2 <- newLocalNode testTransport initRemoteTable
718− done <- newEmptyMVar
719−
720− pingServer <- forkProcess node1 ping
721−
722− runProcess node2 $ do
723− register "ping" pingServer
724− whereis "ping" >>= liftIO . assertBool "Unexpected ping" . (== Just pingServer)
725− us <- getSelfPid
726− nsend "ping" (Pong us)
727− receiveWait [
728− matchIf (\(Ping pid') -> pingServer == pid')
729− (const $ liftIO $ putMVar done ())
730− ]
731−
732− takeMVar done
733−
734−testRemoteRegistry :: TestTransport -> Assertion
735−testRemoteRegistry TestTransport{..} = do
736− node1 <- newLocalNode testTransport initRemoteTable
737− node2 <- newLocalNode testTransport initRemoteTable
738−
739− pingServer <- forkProcess node1 ping
740− deadProcess <- forkProcess node1 (return ())
741−
742− runProcess node2 $ do
743− let nid1 = localNodeId node1
744− registerRemoteAsync nid1 "ping" pingServer
745− receiveWait [
746− matchIf (\(RegisterReply label' _ (Just pid)) ->
747− "ping" == label' && pid == pingServer)
748− (\(RegisterReply _ _ _) -> return ()) ]
749−
750− pid <- verifyWhereIsRemote nid1 "ping"
751− liftIO $ assertBool "Expected pindServer to match pid" $ pingServer == pid
752−
753− us <- getSelfPid
754− nsendRemote nid1 "ping" (Pong us)
755− receiveWait [
756− match (\(Ping pid') -> return $ pingServer == pid')
757− ] >>= liftIO . assertBool "Expected Ping with ping server's ProcessId"
758−
759− -- test that if process was not registered Nothing is returned
760− -- in owner field.
761− registerRemoteAsync nid1 "dead" deadProcess
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−
766− registerRemoteAsync nid1 "ping" deadProcess
767− receiveWait [
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−
773− unregisterRemoteAsync nid1 "dead"
774− receiveWait [
775− matchIf (\(RegisterReply label' _ _) -> "dead" == label')
776− (\(RegisterReply _ f mPid) -> return (not f && isNothing mPid))
777− ] >>= liftIO . assertBool "Expected False and Nothing in RegisterReply"
778−
779−testRemoteRegistryRemoteProcess :: TestTransport -> Assertion
780−testRemoteRegistryRemoteProcess TestTransport{..} = do
781− node1 <- newLocalNode testTransport initRemoteTable
782− node2 <- newLocalNode testTransport initRemoteTable
783− done <- newEmptyMVar
784−
785− pingServer <- forkProcess node2 ping
786−
787− runProcess node2 $ do
788− let nid1 = localNodeId node1
789− registerRemoteAsync nid1 "ping" pingServer
790− receiveWait [
791− matchIf (\(RegisterReply label' _ _) -> "ping" == label')
792− (\(RegisterReply _ _ _) -> return ()) ]
793− pid <- verifyWhereIsRemote nid1 "ping"
794− liftIO $ assertBool "Expected pingServer to match remote name" $ pingServer == pid
795− us <- getSelfPid
796− nsendRemote nid1 "ping" (Pong us)
797− receiveWait [
798− match (\(Ping pid') -> return $ pingServer == pid')
799− ] >>= liftIO . putMVar done
800−
801− verifyClient "Expected Ping with ping server's ProcessId" done
802−
803−testSpawnLocal :: TestTransport -> Assertion
804−testSpawnLocal TestTransport{..} = do
805− node <- newLocalNode testTransport initRemoteTable
806− done <- newEmptyMVar
807−
808− runProcess node $ do
809− us <- getSelfPid
810−
811− pid <- spawnLocal $ do
812− sport <- expect
813− sendChan sport (1234 :: Int)
814−
815− sport <- spawnChannelLocal $
816− \rport -> (receiveChan rport :: Process Int) >>= send us
817−
818− send pid sport
819− expect >>= liftIO . putMVar done
820−
821− res <- takeMVar done
822− assertBool "Expected 1234 :: Int" $ res == (1234 :: Int)
823−
824−testSpawnAsyncStrictness :: TestTransport -> Assertion
825−testSpawnAsyncStrictness TestTransport{..} = do
826− node <- newLocalNode testTransport initRemoteTable
827− done <- newEmptyMVar
828−
829− runProcess node $ do
830− here <-getSelfNode
831−
832− ev <- try $ spawnAsync here (error "boom")
833− liftIO $ case ev of
834− Right _ -> putMVar done (error "Exception didn't fire")
835− Left (_::SomeException) -> putMVar done (return ())
836−
837− join $ takeMVar done
838−
839−testReconnect :: TestTransport -> Assertion
840−testReconnect TestTransport{..} = do
841− [node1, node2] <- replicateM 2 $ newLocalNode testTransport initRemoteTable
842− let nid1 = localNodeId node1
843− processA <- newEmptyMVar
844− [sendTestOk, registerTestOk] <- replicateM 2 newEmptyMVar
845−
846− forkProcess node1 $ do
847− us <- getSelfPid
848− liftIO $ putMVar processA us
849− msg1 <- expect
850− msg2 <- expect
851− liftIO $ do
852− assertBool "messages did not match" $ msg1 == "message 1" && msg2 == "message 3"
853− putMVar sendTestOk ()
854−
855− forkProcess node2 $ do
856− {-
857− - Make sure there is no implicit reconnect on normal message sending
858− -}
859−
860− them <- liftIO $ readMVar processA
861− send them "message 1" >> liftIO (threadDelay 100000)
862−
863− -- Simulate network failure
864− liftIO $ syncBreakConnection testBreakConnection node1 node2
865−
866−
867− -- Should not arrive
868− send them "message 2"
869−
870− -- Should arrive
871− reconnect them
872− send them "message 3"
873−
874− liftIO $ takeMVar sendTestOk
875−
876− {-
877− - Test that there *is* implicit reconnect on node controller messages
878− -}
879−
880− us <- getSelfPid
881− registerRemoteAsync nid1 "a" us -- registerRemote is asynchronous
882− receiveWait [
883− matchIf (\(RegisterReply label' _ _) -> "a" == label')
884− (\(RegisterReply _ _ _) -> return ()) ]
885−
886− _ <- whereisRemote nid1 "a"
887−
888−
889− -- Simulate network failure
890− liftIO $ syncBreakConnection testBreakConnection node1 node2
891−
892− -- This will happen due to implicit reconnect
893− registerRemoteAsync nid1 "b" us
894− receiveWait [
895− matchIf (\(RegisterReply label' _ _) -> "b" == label')
896− (\(RegisterReply _ _ _) -> return ()) ]
897−
898− -- Should happen
899− registerRemoteAsync nid1 "c" us
900− receiveWait [
901− matchIf (\(RegisterReply label' _ _) -> "c" == label')
902− (\(RegisterReply _ _ _) -> return ()) ]
903−
904− -- Check
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"
909−
910− liftIO $ putMVar registerTestOk ()
911−
912− takeMVar registerTestOk
913−
914−-- | Tests that unreliable messages arrive sorted even when there are connection
915−-- failures.
916−testUSend :: (ProcessId -> Int -> Process ())
917− -> TestTransport -> Int -> Assertion
918−testUSend usendPrim TestTransport{..} numMessages = do
919− [node1, node2] <- replicateM 2 $ newLocalNode testTransport initRemoteTable
920− let nid1 = localNodeId node1
921− nid2 = localNodeId node2
922− processA <- newEmptyMVar
923− usendTestOk <- newEmptyMVar
924−
925− forkProcess node1 $ flip catch (\e -> liftIO $ print (e :: SomeException) ) $ do
926− us <- getSelfPid
927− liftIO $ putMVar processA us
928− them <- expect
929− send them ()
930− _ <- monitor them
931− let -- Collects messages from 'them' until the sender dies.
932− -- Disconnection notifications are ignored.
933− receiveMessages :: Process [Int]
934− receiveMessages = receiveWait
935− [ match $ \mn -> case mn of
936− ProcessMonitorNotification _ _ DiedDisconnect -> do
937− monitor them
938− receiveMessages
939− _ -> return []
940− , match $ \i -> fmap (i :) receiveMessages
941− ]
942− msgs <- receiveMessages
943− let -- Checks that the input list is sorted.
944− isSorted :: [Int] -> Bool
945− isSorted (x : xs@(y : _)) = x <= y && isSorted xs
946− isSorted _ = True
947− -- The list can't be null since there are no failures after sending
948− -- the last message.
949− liftIO $ putMVar usendTestOk $ isSorted msgs && not (null msgs)
950−
951− forkProcess node2 $ do
952− them <- liftIO $ readMVar processA
953− getSelfPid >>= send them
954− expect :: Process ()
955− forM_ [1..numMessages] $ \i -> do
956− liftIO $ testBreakConnection (nodeAddress nid1) (nodeAddress nid2)
957− usendPrim them i
958− liftIO (threadDelay 30000)
959−
960− res <- takeMVar usendTestOk
961− assertBool "Unexpected failure after sending last msg" res
962−
963−-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
964−-- in between
965−testMatchAny :: TestTransport -> Assertion
966−testMatchAny TestTransport{..} = do
967− proxyAddr <- newEmptyMVar
968− clientDone <- newEmptyMVar
969−
970− -- Math server
971− forkIO $ do
972− localNode <- newLocalNode testTransport initRemoteTable
973− mathServer <- forkProcess localNode math
974− proxyServer <- forkProcess localNode $ forever $ do
975− msg <- receiveWait [ matchAny return ]
976− forward msg mathServer
977− putMVar proxyAddr proxyServer
978−
979− -- Client
980− forkIO $ do
981− localNode <- newLocalNode testTransport initRemoteTable
982− mathServer <- readMVar proxyAddr
983−
984− runProcess localNode $ do
985− pid <- getSelfPid
986− send mathServer (Add pid 1 2)
987− three <- expect :: Process Double
988− send mathServer (Divide pid 8 2)
989− four <- expect :: Process Double
990− send mathServer (Divide pid 8 0)
991− divByZ <- expect
992− liftIO $ putMVar clientDone (three, four, divByZ)
993−
994− res <- takeMVar clientDone
995− case res of
996− (3, 4, DivByZero) -> return ()
997− _ -> error "Unexpected result"
998−
999−-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
1000−-- in between, however we block 'Divide' requests ....
1001−testMatchAnyHandle :: TestTransport -> Assertion
1002−testMatchAnyHandle TestTransport{..} = do
1003− proxyAddr <- newEmptyMVar
1004− clientDone <- newEmptyMVar
1005−
1006− -- Math server
1007− forkIO $ do
1008− localNode <- newLocalNode testTransport initRemoteTable
1009− mathServer <- forkProcess localNode math
1010− proxyServer <- forkProcess localNode $ forever $ do
1011− receiveWait [
1012− matchAny (maybeForward mathServer)
1013− ]
1014− putMVar proxyAddr proxyServer
1015−
1016− -- Client
1017− forkIO $ do
1018− localNode <- newLocalNode testTransport initRemoteTable
1019− mathServer <- readMVar proxyAddr
1020−
1021− runProcess localNode $ do
1022− pid <- getSelfPid
1023− send mathServer (Add pid 1 2)
1024− three <- expect :: Process Double
1025− send mathServer (Divide pid 8 2)
1026− res <- (expectTimeout 100000) :: Process (Maybe Double)
1027− liftIO $ putMVar clientDone $ three == 3 && res == Nothing
1028−
1029− verifyClient "Expected Nothing (i.e. timeout)" clientDone
1030−
1031− where maybeForward :: ProcessId -> Message -> Process (Maybe ())
1032− maybeForward s msg =
1033− handleMessage msg (\m@(Add _ _ _) -> send s m)
1034−
1035−testMatchAnyNoHandle :: TestTransport -> Assertion
1036−testMatchAnyNoHandle TestTransport{..} = do
1037− addr <- newEmptyMVar
1038− clientDone <- newEmptyMVar
1039− serverDone <- newEmptyMVar
1040−
1041− -- Math server
1042− forkIO $ do
1043− localNode <- newLocalNode testTransport initRemoteTable
1044− server <- forkProcess localNode $ forever $ do
1045− receiveWait [
1046− matchAnyIf
1047− -- the condition has type `Add -> Bool`
1048− (\(Add _ _ _) -> True)
1049− -- the match `AbstractMessage -> Process ()` will succeed!
1050− (\m -> do
1051− -- `String -> Process ()` does *not* match the input types however
1052− r <- (handleMessage m (\(_ :: String) -> die "NONSENSE" ))
1053− case r of
1054− Nothing -> return ()
1055− Just _ -> die "NONSENSE")
1056− ]
1057− -- we *must* have removed the message from our mailbox though!!!
1058− res <- receiveTimeout 100000 [ match (\(Add _ _ _) -> return ()) ]
1059− liftIO $ do
1060− assertBool "Expected timeout!" $ res == Nothing
1061− putMVar serverDone ()
1062− putMVar addr server
1063−
1064− -- Client
1065− forkIO $ do
1066− localNode <- newLocalNode testTransport initRemoteTable
1067− server <- readMVar addr
1068−
1069− runProcess localNode $ do
1070− pid <- getSelfPid
1071− send server (Add pid 1 2)
1072− -- we only care about the client having sent a message, so we're done
1073− liftIO $ putMVar clientDone ()
1074−
1075− takeMVar clientDone
1076− takeMVar serverDone
1077−
1078−-- | Test 'matchAnyIf'. We provide an /echo/ server, but it ignores requests
1079−-- unless the text body @/= "bar"@ - this case should time out rather than
1080−-- removing the message from the process mailbox.
1081−testMatchAnyIf :: TestTransport -> Assertion
1082−testMatchAnyIf TestTransport{..} = do
1083− echoAddr <- newEmptyMVar
1084− clientDone <- newEmptyMVar
1085−
1086− -- echo server
1087− forkIO $ do
1088− localNode <- newLocalNode testTransport initRemoteTable
1089− echoServer <- forkProcess localNode $ forever $ do
1090− receiveWait [
1091− matchAnyIf (\(_ :: ProcessId, (s :: String)) -> s /= "bar")
1092− tryHandleMessage
1093− ]
1094− putMVar echoAddr echoServer
1095−
1096− -- Client
1097− forkIO $ do
1098− localNode <- newLocalNode testTransport initRemoteTable
1099− server <- readMVar echoAddr
1100−
1101− runProcess localNode $ do
1102− pid <- getSelfPid
1103− send server (pid, "foo")
1104− foo <- expect
1105− -- provoking what would be the wrong ordering is informative here...
1106−
1107− send server (pid, "bar")
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'
1118−
1119− where tryHandleMessage :: Message -> Process (Maybe ())
1120− tryHandleMessage msg =
1121− handleMessage msg (\(pid :: ProcessId, (m :: String))
1122− -> do { send pid m; return () })
1123−
1124−testMatchMessageWithUnwrap :: TestTransport -> Assertion
1125−testMatchMessageWithUnwrap TestTransport{..} = do
1126− echoAddr <- newEmptyMVar
1127− clientDone <- newEmptyMVar
1128−
1129− -- echo server
1130− forkIO $ do
1131− localNode <- newLocalNode testTransport initRemoteTable
1132− echoServer <- forkProcess localNode $ forever $ do
1133− msg <- receiveWait [
1134− matchMessage (\(m :: Message) -> do
1135− return m)
1136− ]
1137− unwrapped <- unwrapMessage msg :: Process (Maybe (ProcessId, Message))
1138− case unwrapped of
1139− (Just (p, msg')) -> forward msg' p
1140− Nothing -> die "unable to unwrap the message"
1141− putMVar echoAddr echoServer
1142−
1143− -- Client
1144− forkIO $ do
1145− localNode <- newLocalNode testTransport initRemoteTable
1146− server <- readMVar echoAddr
1147−
1148− runProcess localNode $ do
1149− pid <- getSelfPid
1150− send server (pid, wrapMessage ("foo" :: String))
1151− foo <- expect
1152− send server (pid, wrapMessage ("baz" :: String))
1153− baz <- expect
1154− liftIO $ putMVar clientDone (foo, baz)
1155−
1156− res <- takeMVar clientDone
1157− assertBool "Unexpected unwrapped results" $ res == ("foo", "baz")
1158−
1159−-- Test 'receiveChanTimeout'
1160−testReceiveChanTimeout :: TestTransport -> Assertion
1161−testReceiveChanTimeout TestTransport{..} = do
1162− done <- newEmptyMVar
1163− mvSender <- newEmptyMVar
1164− sendPort <- newEmptyMVar
1165−
1166− forkTry $ do
1167− localNode <- newLocalNode testTransport initRemoteTable
1168− runProcess localNode $ do
1169− -- Create a typed channel
1170− (sp, rp) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
1171− liftIO $ putMVar sendPort sp
1172−
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
1184−
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")
1188−
1189− -- Let the sender know that it can send a message.
1190− liftIO $ putMVar mvSender ()
1191−
1192− -- Again, but now there is a message available
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
1199−
1200− liftIO $ putMVar done ()
1201−
1202− forkTry $ do
1203− localNode <- newLocalNode testTransport initRemoteTable
1204− runProcess localNode $ do
1205− sp <- liftIO $ readMVar sendPort
1206−
1207− liftIO $ takeMVar mvSender
1208− liftIO $ threadDelay 100000
1209− sendChan sp True
1210−
1211− liftIO $ takeMVar mvSender
1212− sendChan sp False
1213−
1214− takeMVar done
1215−
1216−-- | Test Functor, Applicative, Alternative and Monad instances for ReceiveChan
1217−testReceiveChanFeatures :: TestTransport -> Assertion
1218−testReceiveChanFeatures TestTransport{..} = do
1219− done <- newEmptyMVar
1220−
1221− forkTry $ do
1222− localNode <- newLocalNode testTransport initRemoteTable
1223− runProcess localNode $ do
1224− (spInt, rpInt) <- newChan :: Process (SendPort Int, ReceivePort Int)
1225− (spBool, rpBool) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
1226−
1227− -- Test Functor instance
1228−
1229− sendChan spInt 2
1230− sendChan spBool False
1231−
1232− rp1 <- mergePortsBiased [even <$> rpInt, rpBool]
1233−
1234− receiveChan rp1 >>= liftIO . assertBool "Expected True"
1235− receiveChan rp1 >>= liftIO . assertBool "Expected False" . not
1236−
1237− -- Test Applicative instance
1238−
1239− sendChan spInt 3
1240− sendChan spInt 4
1241−
1242− let rp2 = pure (+) <*> rpInt <*> rpInt
1243−
1244− receiveChan rp2 >>= liftIO . assertBool "Expected 7" . (== 7)
1245−
1246− -- Test Alternative instance
1247−
1248− sendChan spInt 3
1249− sendChan spBool True
1250−
1251− let rp3 = (even <$> rpInt) <|> rpBool
1252−
1253− receiveChan rp3 >>= liftIO . assertBool "Expected False" . not
1254− receiveChan rp3 >>= liftIO . assertBool "Expected True"
1255−
1256− -- Test Monad instance
1257−
1258− sendChan spBool True
1259− sendChan spBool False
1260− sendChan spInt 5
1261−
1262− let rp4 :: ReceivePort Int
1263− rp4 = do b <- rpBool
1264− if b
1265− then rpInt
1266− else return 7
1267−
1268− receiveChan rp4 >>= liftIO . assertBool "Expected 5" . (== 5)
1269− receiveChan rp4 >>= liftIO . assertBool "Expected 7" . (== 7)
1270−
1271− liftIO $ putMVar done ()
1272−
1273− takeMVar done
1274−
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−
1345−testKillLocal :: TestTransport -> Assertion
1346−testKillLocal TestTransport{..} = do
1347− localNode <- newLocalNode testTransport initRemoteTable
1348−
1349− pid <- forkProcess localNode $ do
1350− liftIO $ threadDelay 1000000
1351−
1352− runProcess localNode $ do
1353− ref <- monitor pid
1354− us <- getSelfPid
1355− kill pid "TestKill"
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"
1363−
1364−testKillRemote :: TestTransport -> Assertion
1365−testKillRemote TestTransport{..} = do
1366− node1 <- newLocalNode testTransport initRemoteTable
1367− node2 <- newLocalNode testTransport initRemoteTable
1368−
1369− pid <- forkProcess node1 $ do
1370− liftIO $ threadDelay 1000000
1371−
1372− runProcess node2 $ do
1373− ref <- monitor pid
1374− us <- getSelfPid
1375− kill pid "TestKill"
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"
1387−
1388−testCatchesExit :: TestTransport -> Assertion
1389−testCatchesExit TestTransport{..} = do
1390− localNode <- newLocalNode testTransport initRemoteTable
1391− done <- newEmptyMVar
1392−
1393− _ <- forkProcess localNode $ do
1394− (die ("foobar", 123 :: Int))
1395− `catchesExit` [
1396− (\_ m -> handleMessage m (\(_ :: String) -> return ()))
1397− , (\_ m -> handleMessage m (\(_ :: Maybe Int) -> return ()))
1398− , (\_ m -> handleMessage m (\(_ :: String, _ :: Int)
1399− -> (liftIO $ putMVar done ()) >> return ()))
1400− ]
1401−
1402− takeMVar done
1403−
1404−testHandleMessageIf :: TestTransport -> Assertion
1405−testHandleMessageIf TestTransport{..} = do
1406− localNode <- newLocalNode testTransport initRemoteTable
1407− done <- newEmptyMVar
1408− _ <- forkProcess localNode $ do
1409− self <- getSelfPid
1410− send self (5 :: Integer, 10 :: Integer)
1411− msg <- receiveWait [ matchMessage return ]
1412− handleMessageIf msg
1413− (\() -> True)
1414− (\() -> die "whoops") >>= maybe (return ())
1415− (const $ die "Expected Mismatch")
1416− handleMessageIf msg (\(x :: Integer, y :: Integer) -> x == 5 && y == 10)
1417− (\input -> liftIO $ putMVar done input)
1418− return ()
1419−
1420− result <- takeMVar done
1421− expectThat result $ equalTo (5, 10)
1422−
1423−testCatches :: TestTransport -> Assertion
1424−testCatches TestTransport{..} = do
1425− localNode <- newLocalNode testTransport initRemoteTable
1426− done <- newEmptyMVar
1427−
1428− _ <- forkProcess localNode $ do
1429− node <- getSelfNode
1430− (liftIO $ throwIO (ProcessLinkException (nullProcessId node) DiedNormal))
1431− `catches` [
1432− Handler (\(ProcessLinkException _ _) -> liftIO $ putMVar done ())
1433− ]
1434−
1435− takeMVar done
1436−
1437−testMaskRestoreScope :: TestTransport -> Assertion
1438−testMaskRestoreScope TestTransport{..} = do
1439− localNode <- newLocalNode testTransport initRemoteTable
1440− parentPid <- newEmptyMVar :: IO (MVar ProcessId)
1441− spawnedPid <- newEmptyMVar :: IO (MVar ProcessId)
1442−
1443− void $ runProcess localNode $ mask $ \unmask -> do
1444− getSelfPid >>= liftIO . putMVar parentPid
1445− void $ spawnLocal $ unmask (getSelfPid >>= liftIO . putMVar spawnedPid)
1446−
1447− parent <- liftIO $ takeMVar parentPid
1448− child <- liftIO $ takeMVar spawnedPid
1449− expectThat parent $ isNot $ equalTo child
1450−
1451−testDie :: TestTransport -> Assertion
1452−testDie TestTransport{..} = do
1453− localNode <- newLocalNode testTransport initRemoteTable
1454− done <- newEmptyMVar
1455−
1456− _ <- forkProcess localNode $ do
1457− (die ("foobar", 123 :: Int))
1458− `catchExit` \_from reason -> do
1459− -- TODO: should verify that 'from' has the right value
1460− let res = reason == ("foobar", 123 :: Int)
1461− liftIO $ putMVar done ()
1462− if res
1463− then return ()
1464− else die "Something went horribly wrong"
1465−
1466− takeMVar done
1467−
1468−testPrettyExit :: TestTransport -> Assertion
1469−testPrettyExit TestTransport{..} = do
1470− localNode <- newLocalNode testTransport initRemoteTable
1471− done <- newEmptyMVar
1472−
1473− _ <- forkProcess localNode $ do
1474− (die "timeout")
1475− `catch` \ex@(ProcessExitException from _) ->
1476− let expected = "exit-from=" ++ (show from)
1477− in do
1478− let res = (show ex) == expected
1479− liftIO $ putMVar done ()
1480− if res
1481− then return ()
1482− else die "Something went horribly wrong"
1483−
1484− takeMVar done
1485−
1486−testExitLocal :: TestTransport -> Assertion
1487−testExitLocal TestTransport{..} = do
1488− localNode <- newLocalNode testTransport initRemoteTable
1489− supervisedDone <- newEmptyMVar
1490− supervisorDone <- newEmptyMVar
1491− -- XXX: we guarantee that exception handler will be set up
1492− -- regardless if forkProcess preserve masking state or not.
1493− handlerSetUp <- newEmptyMVar
1494−
1495− pid <- forkProcess localNode $ do
1496− (liftIO (putMVar handlerSetUp ()) >> expect) `catchExit` \_from reason -> do
1497− -- TODO: should verify that 'from' has the right value
1498− res <- return $ reason == "TestExit"
1499− liftIO $ putMVar supervisedDone ()
1500− if res
1501− then return ()
1502− else die "Something went horribly wrong"
1503−
1504− runProcess localNode $ do
1505− liftIO $ takeMVar handlerSetUp
1506− ref <- monitor pid
1507− exit pid "TestExit"
1508− -- This time the client catches the exception, so it dies normally
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"
1518−
1519− takeMVar supervisedDone
1520− takeMVar supervisorDone
1521−
1522−testExitRemote :: TestTransport -> Assertion
1523−testExitRemote TestTransport{..} = do
1524− node1 <- newLocalNode testTransport initRemoteTable
1525− node2 <- newLocalNode testTransport initRemoteTable
1526− supervisedDone <- newEmptyMVar
1527− supervisorDone <- newEmptyMVar
1528−
1529− pid <- forkProcess node1 $ do
1530− (receiveWait [] :: Process ()) -- block forever
1531− `catchExit` \_from reason -> do
1532− -- TODO: should verify that 'from' has the right value
1533− res <- return $ reason == "TestExit"
1534− liftIO $ putMVar supervisedDone ()
1535− if res
1536− then return ()
1537− else die "Something went horribly wrong"
1538−
1539− runProcess node2 $ do
1540− ref <- monitor pid
1541− exit pid "TestExit"
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"
1551−
1552− takeMVar supervisedDone
1553− takeMVar supervisorDone
1554−
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−
1625−testUnsafeSend :: TestTransport -> Assertion
1626−testUnsafeSend TestTransport{..} = do
1627− serverAddr <- newEmptyMVar
1628− clientDone <- newEmptyMVar
1629−
1630− localNode <- newLocalNode testTransport initRemoteTable
1631− void $ forkProcess localNode $ do
1632− self <- getSelfPid
1633− liftIO $ putMVar serverAddr self
1634− clientAddr <- expect
1635− unsafeSend clientAddr ()
1636−
1637− void $ forkProcess localNode $ do
1638− serverPid <- liftIO $ takeMVar serverAddr
1639− getSelfPid >>= unsafeSend serverPid
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
1660−
1661− takeMVar clientDone
1662−
1663−testUnsafeNSend :: TestTransport -> Assertion
1664−testUnsafeNSend TestTransport{..} = do
1665− clientDone <- newEmptyMVar
1666−
1667− localNode <- newLocalNode testTransport initRemoteTable
1668−
1669− pid <- forkProcess localNode $ do
1670− expect >>= liftIO . putMVar clientDone
1671−
1672− void $ runProcess localNode $ do
1673− register "foobar" pid
1674− unsafeNSend "foobar" ()
1675−
1676− takeMVar clientDone
1677−
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−
1696−testUnsafeSendChan :: TestTransport -> Assertion
1697−testUnsafeSendChan TestTransport{..} = do
1698− serverAddr <- newEmptyMVar
1699− clientDone <- newEmptyMVar
1700−
1701− localNode <- newLocalNode testTransport initRemoteTable
1702− void $ forkProcess localNode $ do
1703− self <- getSelfPid
1704− liftIO $ putMVar serverAddr self
1705− sp <- expect
1706− unsafeSendChan sp ()
1707−
1708− void $ forkProcess localNode $ do
1709− serverPid <- liftIO $ takeMVar serverAddr
1710− (sp, rp) <- newChan
1711− unsafeSend serverPid sp
1712− receiveChan rp :: Process ()
1713− liftIO $ putMVar clientDone ()
1714−
1715− takeMVar clientDone
1716−
1717−testCallLocal :: TestTransport -> Assertion
1718−testCallLocal TestTransport{..} = do
1719− node <- newLocalNode testTransport initRemoteTable
1720−
1721− -- Testing that (/=) <$> getSelfPid <*> callLocal getSelfPid.
1722− result <- newEmptyMVar
1723− runProcess node $ do
1724− r <- (/=) <$> getSelfPid <*> callLocal getSelfPid
1725− liftIO $ putMVar result r
1726−
1727− takeMVar result >>= assertBool "Expected 'True'"
1728−
1729− -- Testing that when callLocal is interrupted, the worker is interrupted.
1730− ibox <- newIORef False
1731− runProcess node $ do
1732− keeper <- getSelfPid
1733− spawnLocal $ do
1734− caller <- getSelfPid
1735− send keeper caller
1736− onException
1737− (callLocal $ do
1738− onException (do send keeper caller
1739− expect)
1740− (do liftIO $ writeIORef ibox True))
1741− (send keeper ())
1742− caller <- expect
1743− exit caller "test"
1744− expect :: Process ()
1745−
1746− readIORef ibox >>= assertBool "Expected 'True'"
1747−
1748− -- Testing that when the worker raises an exception, the exception is propagated to the parent.
1749− ibox2 <- newIORef False
1750− runProcess node $ do
1751− r <- try (callLocal $ error "e" >> return ())
1752− liftIO $ writeIORef ibox2 $ case r of
1753− Left (ErrorCall "e") -> True
1754− _ -> False
1755−
1756− readIORef ibox >>= assertBool "Expected 'True'"
1757−
1758− -- Test that caller waits for the worker in correct situation
1759− ibox3 <- newIORef False
1760− result3 <- newEmptyMVar
1761− runProcess node $ do
1762− keeper <- getSelfPid
1763− spawnLocal $ do
1764− callLocal $
1765− (do us <- getSelfPid
1766− send keeper us
1767− () <- expect
1768− liftIO yield)
1769− `finally` (liftIO $ writeIORef ibox3 True)
1770− liftIO $ putMVar result3 =<< readIORef ibox3
1771− worker <- expect
1772− send worker ()
1773−
1774− takeMVar result3 >>= assertBool "Expected 'True'"
1775−
1776− -- Test that caller waits for the worker in case when caller gets an exception
1777− ibox4 <- newIORef False
1778− result4 <- newEmptyMVar
1779− runProcess node $ do
1780− keeper <- getSelfPid
1781− spawnLocal $ do
1782− caller <- getSelfPid
1783− callLocal
1784− ((do send keeper caller
1785− expect)
1786− `finally` (liftIO $ writeIORef ibox4 True))
1787− `finally` (liftIO $ putMVar result4 =<< readIORef ibox4)
1788− caller <- expect
1789− exit caller "hi!"
1790−
1791− takeMVar result4 >>= assertBool "Expected 'True'"
1792− -- XXX: Testing that when mask_ $ callLocal p runs p in masked state.
1793−
1794−tests :: TestTransport -> IO [Test]
1795−tests testtrans = return [
1796− testGroup "Basic features" [
1797− testCase "Ping" (testPing testtrans)
1798− , testCase "Math" (testMath testtrans)
1799− , testCase "Timeout" (testTimeout testtrans)
1800− , testCase "Timeout0" (testTimeout0 testtrans)
1801− , testCase "SendToTerminated" (testSendToTerminated testtrans)
1802− , testCase "TypedChannnels" (testTypedChannels testtrans)
1803− , testCase "Terminate" (testTerminate testtrans)
1804− , testCase "RegistryRemoteProcess" (testRegistryRemoteProcess testtrans)
1805− , testCase "RemoteRegistry" (testRemoteRegistry testtrans)
1806− , testCase "RemoteRegistryRemoteProcess" (testRemoteRegistryRemoteProcess testtrans)
1807− , testCase "SpawnLocal" (testSpawnLocal testtrans)
1808− , testCase "SpawnAsyncStrictness" (testSpawnAsyncStrictness testtrans)
1809− , testCase "HandleMessageIf" (testHandleMessageIf testtrans)
1810− , testCase "MatchAny" (testMatchAny testtrans)
1811− , testCase "MatchAnyHandle" (testMatchAnyHandle testtrans)
1812− , testCase "MatchAnyNoHandle" (testMatchAnyNoHandle testtrans)
1813− , testCase "MatchAnyIf" (testMatchAnyIf testtrans)
1814− , testCase "MatchMessageUnwrap" (testMatchMessageWithUnwrap testtrans)
1815− , testCase "ReceiveChanTimeout" (testReceiveChanTimeout testtrans)
1816− , testCase "ReceiveChanFeatures" (testReceiveChanFeatures testtrans)
1817− , testCase "ChanLifecycle" (testChanLifecycle testtrans)
1818− , testCase "KillLocal" (testKillLocal testtrans)
1819− , testCase "KillRemote" (testKillRemote testtrans)
1820− , testCase "Die" (testDie testtrans)
1821− , testCase "PrettyExit" (testPrettyExit testtrans)
1822− , testCase "CatchesExit" (testCatchesExit testtrans)
1823− , testCase "Catches" (testCatches testtrans)
1824− , testCase "MaskRestoreScope" (testMaskRestoreScope testtrans)
1825− , testCase "ExitLocal" (testExitLocal testtrans)
1826− , testCase "ExitRemote" (testExitRemote testtrans)
1827− , testCase "RegistryMonitoring" (testRegistryMonitoring testtrans)
1828− , testCase "TextCallLocal" (testCallLocal testtrans)
1829− -- Unsafe Primitives
1830− , testCase "TestUnsafeSend" (testUnsafeSend testtrans)
1831− , testCase "TestUnsafeUSend" (testUnsafeUSend testtrans)
1832− , testCase "TestUnsafeNSend" (testUnsafeNSend testtrans)
1833− , testCase "TestUnsafeNSendRemote" (testUnsafeNSendRemote testtrans)
1834− , testCase "TestUnsafeSendChan" (testUnsafeSendChan testtrans)
1835− -- usend
1836− , testCase "USend" (testUSend usend testtrans 50)
1837− , testCase "UForward"
1838− (testUSend (\p m -> uforward (createUnencodedMessage m) p)
1839− testtrans 50
1840− )
1841− ]
1842− , testGroup "Monitoring and Linking" [
1843− -- Monitoring processes
1844− --
1845− -- The "missing" combinations in the list below don't make much sense, as
1846− -- we cannot guarantee that the monitor reply or link exception will not
1847− -- happen before the unmonitor or unlink
1848− testCase "MonitorNormalTermination" (testMonitorNormalTermination testtrans True False)
1849− , testCase "MonitorAbnormalTermination" (testMonitorAbnormalTermination testtrans True False)
1850− , testCase "MonitorLocalDeadProcess" (testMonitorLocalDeadProcess testtrans True False)
1851− , testCase "MonitorRemoteDeadProcess" (testMonitorRemoteDeadProcess testtrans True False)
1852− , testCase "MonitorDisconnect" (testMonitorDisconnect testtrans True False)
1853− , testCase "LinkUnreachable" (testMonitorUnreachable testtrans False False)
1854− , testCase "LinkNormalTermination" (testMonitorNormalTermination testtrans False False)
1855− , testCase "LinkAbnormalTermination" (testMonitorAbnormalTermination testtrans False False)
1856− , testCase "LinkLocalDeadProcess" (testMonitorLocalDeadProcess testtrans False False)
1857− , testCase "LinkRemoteDeadProcess" (testMonitorRemoteDeadProcess testtrans False False)
1858− , testCase "LinkDisconnect" (testMonitorDisconnect testtrans False False)
1859− , testCase "UnmonitorNormalTermination" (testMonitorNormalTermination testtrans True True)
1860− , testCase "UnmonitorAbnormalTermination" (testMonitorAbnormalTermination testtrans True True)
1861− , testCase "UnmonitorDisconnect" (testMonitorDisconnect testtrans True True)
1862− , testCase "UnlinkNormalTermination" (testMonitorNormalTermination testtrans False True)
1863− , testCase "UnlinkAbnormalTermination" (testMonitorAbnormalTermination testtrans False True)
1864− , testCase "UnlinkDisconnect" (testMonitorDisconnect testtrans False True)
1865− -- Monitoring nodes and channels
1866− , testCase "MonitorNode" (testMonitorNode testtrans)
1867− , testCase "MonitorLiveNode" (testMonitorLiveNode testtrans)
1868− , testCase "MonitorChannel" (testMonitorChannel testtrans)
1869− -- Reconnect
1870− ]
1871−
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.hsdeleted−589
@@ -1,589 +0,0 @@
1−{-# LANGUAGE TemplateHaskell, KindSignatures #-}
2−module Control.Distributed.Process.Tests.Closure (tests) where
3−
4−import Network.Transport.Test (TestTransport(..))
5−
6−import Data.ByteString.Lazy (empty)
7−import Data.IORef
8−import Data.Typeable (Typeable)
9−import Data.Maybe
10−import Control.Monad (join, replicateM, forever, replicateM_, void, when, unless)
11−import Control.Exception (IOException, throw)
12−import Control.Concurrent (forkIO, threadDelay)
13−import Control.Concurrent.MVar
14− ( MVar
15− , newEmptyMVar
16− , readMVar
17− , takeMVar
18− , putMVar
19− , modifyMVar_
20− , newMVar
21− )
22−import Control.Applicative ((<$>))
23−import System.Random (randomIO)
24−import Control.Distributed.Process
25−import Control.Distributed.Process.Closure
26−import Control.Distributed.Process.Node
27−import Control.Distributed.Process.Internal.Types
28− ( NodeId(nodeAddress)
29− , createMessage
30− , messageToPayload
31− )
32−import Control.Distributed.Static (staticLabel, staticClosure)
33−import qualified Network.Transport as NT
34−
35−import Test.HUnit (Assertion)
36−import Test.Framework (Test)
37−import Test.Framework.Providers.HUnit (testCase)
38−
39−--------------------------------------------------------------------------------
40−-- Supporting definitions --
41−--------------------------------------------------------------------------------
42−
43−quintuple :: a -> b -> c -> d -> e -> (a, b, c, d, e)
44−quintuple a b c d e = (a, b, c, d, e)
45−
46−sdictInt :: SerializableDict Int
47−sdictInt = SerializableDict
48−
49−factorial :: Int -> Process Int
50−factorial 0 = return 1
51−factorial n = (n *) <$> factorial (n - 1)
52−
53−addInt :: Int -> Int -> Int
54−addInt x y = x + y
55−
56−putInt :: Int -> MVar Int -> IO ()
57−putInt = flip putMVar
58−
59−sendPid :: ProcessId -> Process ()
60−sendPid toPid = do
61− fromPid <- getSelfPid
62− send toPid fromPid
63−
64−wait :: Int -> Process ()
65−wait = liftIO . threadDelay
66−
67−expectUnit :: Process ()
68−expectUnit = expect
69−
70−isPrime :: Integer -> Process Bool
71−isPrime n = return . (n `elem`) . takeWhile (<= n) . sieve $ [2..]
72− where
73− sieve :: [Integer] -> [Integer]
74− sieve (p : xs) = p : sieve [x | x <- xs, x `mod` p > 0]
75− sieve [] = error "Uh oh -- we've run out of primes"
76−
77−-- | First argument indicates empty closure environment
78−typedPingServer :: () -> ReceivePort (SendPort ()) -> Process ()
79−typedPingServer () rport = forever $ do
80− sport <- receiveChan rport
81− sendChan sport ()
82−
83−signal :: ProcessId -> Process ()
84−signal pid = send pid ()
85−
86−remotable [ 'factorial
87− , 'addInt
88− , 'putInt
89− , 'sendPid
90− , 'sdictInt
91− , 'wait
92− , 'expectUnit
93− , 'typedPingServer
94− , 'isPrime
95− , 'quintuple
96− , 'signal
97− ]
98−
99−randomElement :: [a] -> IO a
100−randomElement xs = do
101− ix <- randomIO
102− return (xs !! (ix `mod` length xs))
103−
104−remotableDecl [
105− [d| dfib :: ([NodeId], SendPort Integer, Integer) -> Process () ;
106− dfib (_, reply, 0) = sendChan reply 0
107− dfib (_, reply, 1) = sendChan reply 1
108− dfib (nids, reply, n) = do
109− nid1 <- liftIO $ randomElement nids
110− nid2 <- liftIO $ randomElement nids
111− (sport, rport) <- newChan
112− spawn nid1 $ $(mkClosure 'dfib) (nids, sport, n - 2)
113− spawn nid2 $ $(mkClosure 'dfib) (nids, sport, n - 1)
114− n1 <- receiveChan rport
115− n2 <- receiveChan rport
116− sendChan reply $ n1 + n2
117− |]
118− ]
119−
120−-- Just try creating a static polymorphic value
121−staticQuintuple :: (Typeable a, Typeable b, Typeable c, Typeable d, Typeable e)
122− => Static (a -> b -> c -> d -> e -> (a, b, c, d, e))
123−staticQuintuple = $(mkStatic 'quintuple)
124−
125−factorialClosure :: Int -> Closure (Process Int)
126−factorialClosure = $(mkClosure 'factorial)
127−
128−addIntClosure :: Int -> Closure (Int -> Int)
129−addIntClosure = $(mkClosure 'addInt)
130−
131−putIntClosure :: Int -> Closure (MVar Int -> IO ())
132−putIntClosure = $(mkClosure 'putInt)
133−
134−sendPidClosure :: ProcessId -> Closure (Process ())
135−sendPidClosure = $(mkClosure 'sendPid)
136−
137−sendFac :: Int -> ProcessId -> Closure (Process ())
138−sendFac n pid = factorialClosure n `bindCP` cpSend $(mkStatic 'sdictInt) pid
139−
140−factorialOf :: Closure (Int -> Process Int)
141−factorialOf = staticClosure $(mkStatic 'factorial)
142−
143−factorial' :: Int -> Closure (Process Int)
144−factorial' n = returnCP $(mkStatic 'sdictInt) n `bindCP` factorialOf
145−
146−waitClosure :: Int -> Closure (Process ())
147−waitClosure = $(mkClosure 'wait)
148−
149−simulateNetworkFailure :: TestTransport -> LocalNode -> LocalNode -> Process ()
150−simulateNetworkFailure TestTransport{..} from to = liftIO $ do
151− m <- newEmptyMVar
152− _ <- forkProcess to $ getSelfPid >>= liftIO . putMVar m
153− runProcess from $ do
154− them <- liftIO $ takeMVar m
155− pinger <- spawnLocal $ forever $ send them ()
156− _ <- monitorNode (localNodeId to)
157− liftIO $ testBreakConnection (nodeAddress $ localNodeId from)
158− (nodeAddress $ localNodeId to)
159− NodeMonitorNotification _ _ _ <- expect
160− kill pinger "finished"
161− return ()
162−
163−--------------------------------------------------------------------------------
164−-- The tests proper --
165−--------------------------------------------------------------------------------
166−
167−testUnclosure :: TestTransport -> RemoteTable -> Assertion
168−testUnclosure TestTransport{..} rtable = do
169− node <- newLocalNode testTransport rtable
170− done <- newEmptyMVar
171− forkProcess node $ do
172− i <- join . unClosure $ factorialClosure 5
173− liftIO $ putMVar done ()
174− if i == 720
175− then return ()
176− else error "Something went horribly wrong"
177− takeMVar done
178−
179−testBind :: TestTransport -> RemoteTable -> Assertion
180−testBind TestTransport{..} rtable = do
181− node <- newLocalNode testTransport rtable
182− done <- newEmptyMVar
183− runProcess node $ do
184− us <- getSelfPid
185− join . unClosure $ sendFac 6 us
186− (i :: Int) <- expect
187− liftIO $ putMVar done ()
188− if i == 720
189− then return ()
190− else error "Something went horribly wrong"
191− takeMVar done
192−
193−testSendPureClosure :: TestTransport -> RemoteTable -> Assertion
194−testSendPureClosure TestTransport{..} rtable = do
195− serverAddr <- newEmptyMVar
196− serverDone <- newEmptyMVar
197−
198− forkIO $ do
199− node <- newLocalNode testTransport rtable
200− addr <- forkProcess node $ do
201− cl <- expect
202− fn <- unClosure cl :: Process (Int -> Int)
203− (_ :: Int) <- return $ fn 6
204− liftIO $ putMVar serverDone ()
205− putMVar serverAddr addr
206−
207− forkIO $ do
208− node <- newLocalNode testTransport rtable
209− theirAddr <- readMVar serverAddr
210− runProcess node $ send theirAddr (addIntClosure 7)
211−
212− takeMVar serverDone
213−
214−testSendIOClosure :: TestTransport -> RemoteTable -> Assertion
215−testSendIOClosure TestTransport{..} rtable = do
216− serverAddr <- newEmptyMVar
217− serverDone <- newEmptyMVar
218−
219− forkIO $ do
220− node <- newLocalNode testTransport rtable
221− addr <- forkProcess node $ do
222− cl <- expect
223− io <- unClosure cl :: Process (MVar Int -> IO ())
224− liftIO $ do
225− someMVar <- newEmptyMVar
226− io someMVar
227− i <- readMVar someMVar
228− putMVar serverDone ()
229− if i == 5
230− then return ()
231− else error "Something went horribly wrong"
232− putMVar serverAddr addr
233−
234− forkIO $ do
235− node <- newLocalNode testTransport rtable
236− theirAddr <- readMVar serverAddr
237− runProcess node $ send theirAddr (putIntClosure 5)
238−
239− takeMVar serverDone
240−
241−testSendProcClosure :: TestTransport -> RemoteTable -> Assertion
242−testSendProcClosure TestTransport{..} rtable = do
243− serverAddr <- newEmptyMVar
244− clientDone <- newEmptyMVar
245−
246− forkIO $ do
247− node <- newLocalNode testTransport rtable
248− addr <- forkProcess node $ do
249− cl <- expect
250− pr <- unClosure cl :: Process (Int -> Process ())
251− pr 5
252− putMVar serverAddr addr
253−
254− forkIO $ do
255− node <- newLocalNode testTransport rtable
256− theirAddr <- readMVar serverAddr
257− runProcess node $ do
258− pid <- getSelfPid
259− send theirAddr (cpSend $(mkStatic 'sdictInt) pid)
260− i <- expect :: Process Int
261− if i == 5
262− then liftIO $ putMVar clientDone ()
263− else error "Something went horribly wrong"
264−
265− takeMVar clientDone
266−
267−testSpawn :: TestTransport -> RemoteTable -> Assertion
268−testSpawn TestTransport{..} rtable = do
269− serverNodeAddr <- newEmptyMVar
270− clientDone <- newEmptyMVar
271−
272− forkIO $ do
273− node <- newLocalNode testTransport rtable
274− putMVar serverNodeAddr (localNodeId node)
275−
276− forkIO $ do
277− node <- newLocalNode testTransport rtable
278− nid <- readMVar serverNodeAddr
279− runProcess node $ do
280− pid <- getSelfPid
281− pid' <- spawn nid (sendPidClosure pid)
282− pid'' <- expect
283− if pid' == pid''
284− then liftIO $ putMVar clientDone ()
285− else error "Something went horribly wrong"
286−
287− takeMVar clientDone
288−
289−-- | Tests that spawn executes the supplied closure even if the caller dies
290−-- immediately after calling spawn.
291−--
292−-- This situation is of interest because the implementation of spawn has the
293−-- remote peer monitor the caller. See DP-99.
294−--
295−-- The condition is tested by using a transport which refuses to send to the
296−-- remote peer the message that it is waiting to stop monitoring the caller,
297−-- namely @()@.
298−--
299−testSpawnRace :: TestTransport -> RemoteTable -> Assertion
300−testSpawnRace TestTransport{..} rtable = do
301− node1 <- newLocalNode (wrapTransport testTransport) rtable
302− node2 <- newLocalNode testTransport rtable
303−
304− runProcess node1 $ do
305− pid <- getSelfPid
306− spawnLocal $ spawn (localNodeId node2) (sendPidClosure pid) >>= send pid
307− pid' <- expect :: Process ProcessId
308− pid'' <- expect :: Process ProcessId
309− if pid' == pid''
310− then return ()
311− else error "Something went horribly wrong"
312−
313− where
314−
315− wrapTransport (NT.Transport ne ct) = NT.Transport (fmap (fmap wrapEP) ne) ct
316−
317− wrapEP :: NT.EndPoint -> NT.EndPoint
318− wrapEP e =
319− e { NT.connect = \x y z -> do
320− healthy <- newIORef True
321− fmap (fmap $ wrapConnection healthy e x) $ NT.connect e x y z
322− }
323−
324− wrapConnection :: IORef Bool -> NT.EndPoint -> NT.EndPointAddress
325− -> NT.Connection -> NT.Connection
326− wrapConnection healthy e remoteAddr (NT.Connection s closeC) =
327− flip NT.Connection closeC $ \msg -> do
328− when (msg == messageToPayload (createMessage ())) $ do
329− writeIORef healthy False
330− testBreakConnection (NT.address e) remoteAddr
331− isHealthy <- readIORef healthy
332− if isHealthy then s msg
333− else return $ Left $ NT.TransportError NT.SendFailed ""
334−
335−testCall :: TestTransport -> RemoteTable -> Assertion
336−testCall TestTransport{..} rtable = do
337− serverNodeAddr <- newEmptyMVar
338− clientDone <- newEmptyMVar
339−
340− forkIO $ do
341− node <- newLocalNode testTransport rtable
342− putMVar serverNodeAddr (localNodeId node)
343−
344− forkIO $ do
345− node <- newLocalNode testTransport rtable
346− nid <- readMVar serverNodeAddr
347− runProcess node $ do
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"
352−
353− takeMVar clientDone
354−
355−testCallBind :: TestTransport -> RemoteTable -> Assertion
356−testCallBind TestTransport{..} rtable = do
357− serverNodeAddr <- newEmptyMVar
358− clientDone <- newEmptyMVar
359−
360− forkIO $ do
361− node <- newLocalNode testTransport rtable
362− putMVar serverNodeAddr (localNodeId node)
363−
364− forkIO $ do
365− node <- newLocalNode testTransport rtable
366− nid <- readMVar serverNodeAddr
367− runProcess node $ do
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"
372−
373− takeMVar clientDone
374−
375−testSeq :: TestTransport -> RemoteTable -> Assertion
376−testSeq TestTransport{..} rtable = do
377− node <- newLocalNode testTransport rtable
378− done <- newEmptyMVar
379− runProcess node $ do
380− us <- getSelfPid
381− join . unClosure $ sendFac 5 us `seqCP` sendFac 6 us
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"
387− takeMVar done
388−
389−-- Test 'spawnSupervised'
390−--
391−-- Set up a supervisor, spawn a child, then have a third process monitor the
392−-- child. The supervisor then throws an exception, the child dies because it
393−-- was linked to the supervisor, and the third process notices that the child
394−-- dies.
395−testSpawnSupervised :: TestTransport -> RemoteTable -> Assertion
396−testSpawnSupervised TestTransport{..} rtable = do
397− [node1, node2] <- replicateM 2 $ newLocalNode testTransport rtable
398− [superPid, childPid] <- replicateM 2 $ newEmptyMVar
399− thirdProcessDone <- newEmptyMVar
400− linkUp <- newEmptyMVar
401−
402− forkProcess node1 $ do
403− us <- getSelfPid
404− liftIO $ putMVar superPid us
405− (child, _ref) <- spawnSupervised (localNodeId node2)
406− (sendPidClosure us `seqCP` $(mkStaticClosure 'expectUnit))
407− _ <- expect :: Process ProcessId
408−
409− liftIO $ do putMVar childPid child
410− -- Give the child a chance to link to us
411− takeMVar linkUp
412− throw supervisorDeath
413−
414− forkProcess node2 $ do
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"
442−
443− takeMVar thirdProcessDone
444− where
445− supervisorDeath :: IOException
446− supervisorDeath = userError "Supervisor died"
447−
448−testSpawnInvalid :: TestTransport -> RemoteTable -> Assertion
449−testSpawnInvalid TestTransport{..} rtable = do
450− node <- newLocalNode testTransport rtable
451− done <- newEmptyMVar
452− forkProcess node $ do
453− (pid, ref) <- spawnMonitor (localNodeId node) (closure (staticLabel "ThisDoesNotExist") empty)
454− ProcessMonitorNotification ref' pid' _reason <- expect
455− -- Depending on the exact interleaving, reason might be NoProc or the exception thrown by the absence of the static closure
456− res <- return $ ref' == ref && pid == pid'
457− if res == True
458− then liftIO $ putMVar done ()
459− else error "Something went horribly wrong"
460− takeMVar done
461−
462−testClosureExpect :: TestTransport -> RemoteTable -> Assertion
463−testClosureExpect TestTransport{..} rtable = do
464− node <- newLocalNode testTransport rtable
465− done <- newEmptyMVar
466− runProcess node $ do
467− nodeId <- getSelfNode
468− us <- getSelfPid
469− them <- spawn nodeId $ cpExpect $(mkStatic 'sdictInt) `bindCP` cpSend $(mkStatic 'sdictInt) us
470− send them (1234 :: Int)
471− (res :: Int) <- expect
472− if res == 1234
473− then liftIO $ putMVar done ()
474− else error "Something went horribly wrong"
475− takeMVar done
476−
477−testSpawnChannel :: TestTransport -> RemoteTable -> Assertion
478−testSpawnChannel TestTransport{..} rtable = do
479− done <- newEmptyMVar
480− [node1, node2] <- replicateM 2 $ newLocalNode testTransport rtable
481−
482− forkProcess node1 $ do
483− pingServer <- spawnChannel
484− (sdictSendPort sdictUnit)
485− (localNodeId node2)
486− ($(mkClosure 'typedPingServer) ())
487− (sendReply, receiveReply) <- newChan
488− sendChan pingServer sendReply
489− receiveChan receiveReply
490− liftIO $ putMVar done ()
491−
492− takeMVar done
493−
494−testTDict :: TestTransport -> RemoteTable -> Assertion
495−testTDict TestTransport{..} rtable = do
496− done <- newEmptyMVar
497− [node1, node2] <- replicateM 2 $ newLocalNode testTransport rtable
498− forkProcess node1 $ do
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..."
503− takeMVar done
504−
505−testFib :: TestTransport -> RemoteTable -> Assertion
506−testFib TestTransport{..} rtable = do
507− nodes <- replicateM 4 $ newLocalNode testTransport rtable
508− done <- newEmptyMVar
509−
510− forkProcess (head nodes) $ do
511− (sport, rport) <- newChan
512− spawnLocal $ dfib (map localNodeId nodes, sport, 10)
513− ff <- receiveChan rport :: Process Integer
514− liftIO $ putMVar done ()
515− if ff /= 55
516− then die $ "Something went horribly wrong"
517− else return ()
518−
519− takeMVar done
520−
521−testSpawnReconnect :: TestTransport -> RemoteTable -> Assertion
522−testSpawnReconnect testtrans@TestTransport{..} rtable = do
523− [node1, node2] <- replicateM 2 $ newLocalNode testTransport rtable
524− let nid1 = localNodeId node1
525− -- nid2 = localNodeId node2
526− done <- newEmptyMVar
527− iv <- newMVar (0 :: Int)
528−
529− incr <- forkProcess node1 $ forever $ do
530− () <- expect
531− liftIO $ modifyMVar_ iv (return . (+ 1))
532−
533− forkProcess node2 $ do
534− _pid1 <- spawn nid1 ($(mkClosure 'signal) incr)
535− simulateNetworkFailure testtrans node2 node1
536− _pid2 <- spawn nid1 ($(mkClosure 'signal) incr)
537− _pid3 <- spawn nid1 ($(mkClosure 'signal) incr)
538−
539− liftIO $ threadDelay 100000
540−
541− count <- liftIO $ takeMVar iv
542− res <- return $ count == 2 || count == 3 -- It depends on which message we get first in 'spawn'
543−
544− liftIO $ putMVar done ()
545− if res /= True
546− then error "Something went horribly wrong"
547− else return ()
548−
549− takeMVar done
550−
551−-- | 'spawn' used to ave a race condition which would be triggered if the
552−-- spawning process terminates immediately after spawning
553−testSpawnTerminate :: TestTransport -> RemoteTable -> Assertion
554−testSpawnTerminate TestTransport{..} rtable = do
555− slave <- newLocalNode testTransport rtable
556− master <- newLocalNode testTransport rtable
557− masterDone <- newEmptyMVar
558−
559− runProcess master $ do
560− us <- getSelfPid
561− replicateM_ 1000 . spawnLocal . void . spawn (localNodeId slave) $ $(mkClosure 'signal) us
562− replicateM_ 1000 $ (expect :: Process ())
563− liftIO $ putMVar masterDone ()
564−
565− takeMVar masterDone
566−
567−tests :: TestTransport -> IO [Test]
568−tests testtrans = do
569− let rtable = __remoteTable . __remoteTableDecl $ initRemoteTable
570− return
571− [ testCase "Unclosure" (testUnclosure testtrans rtable)
572− , testCase "Bind" (testBind testtrans rtable)
573− , testCase "SendPureClosure" (testSendPureClosure testtrans rtable)
574− , testCase "SendIOClosure" (testSendIOClosure testtrans rtable)
575− , testCase "SendProcClosure" (testSendProcClosure testtrans rtable)
576− , testCase "Spawn" (testSpawn testtrans rtable)
577− , testCase "SpawnRace" (testSpawnRace testtrans rtable)
578− , testCase "Call" (testCall testtrans rtable)
579− , testCase "CallBind" (testCallBind testtrans rtable)
580− , testCase "Seq" (testSeq testtrans rtable)
581− , testCase "SpawnSupervised" (testSpawnSupervised testtrans rtable)
582− , testCase "SpawnInvalid" (testSpawnInvalid testtrans rtable)
583− , testCase "ClosureExpect" (testClosureExpect testtrans rtable)
584− , testCase "SpawnChannel" (testSpawnChannel testtrans rtable)
585− , testCase "TDict" (testTDict testtrans rtable)
586− , testCase "Fib" (testFib testtrans rtable)
587− , testCase "SpawnTerminate" (testSpawnTerminate testtrans rtable)
588− , testCase "SpawnReconnect" (testSpawnReconnect testtrans rtable)
589− ]
distributed-process-tests/src/Control/Distributed/Process/Tests/Internal/Utils.hsdeleted−243
@@ -1,243 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE DeriveGeneric #-}
3−{-# LANGUAGE TemplateHaskell #-}
4−{-# LANGUAGE CPP #-}
5−
6−-----------------------------------------------------------------------------
7−-- |
8−-- Module : Control.Distributed.Process.Tests.Internal.Utils
9−-- Copyright : (c) Tim Watson, Jeff Epstein 2013
10−-- License : BSD3 (see the file LICENSE)
11−--
12−-- Maintainer : Tim Watson
13−-- Stability : experimental
14−-- Portability : non-portable (requires concurrency)
15−--
16−-- This module provides basic building blocks for testing Cloud Haskell programs.
17−-----------------------------------------------------------------------------
18−module Control.Distributed.Process.Tests.Internal.Utils
19− ( TestResult
20− -- ping !
21− , Ping(Ping)
22− , ping
23− , pause
24− , shouldBe
25− , shouldMatch
26− , shouldContain
27− , shouldNotContain
28− , expectThat
29− , synchronisedAssertion
30− -- test process utilities
31− , TestProcessControl
32− , startTestProcess
33− , runTestProcess
34− , testProcessGo
35− , testProcessStop
36− , testProcessReport
37− , delayedAssertion
38− , assertComplete
39− -- logging
40− , Logger()
41− , newLogger
42− , putLogMsg
43− , stopLogger
44− -- runners
45− , tryRunProcess
46− , tryForkProcess
47− , noop
48− , stash
49− ) where
50−
51−#if ! MIN_VERSION_base(4,6,0)
52−import Prelude hiding (catch)
53−#endif
54−import Control.Concurrent
55− ( ThreadId
56− , myThreadId
57− , forkIO
58− )
59−import Control.Concurrent.STM
60− ( TQueue
61− , newTQueueIO
62− , readTQueue
63− , writeTQueue
64− )
65−import Control.Concurrent.MVar
66− ( MVar
67− , newEmptyMVar
68− , takeMVar
69− )
70−
71−import Control.Concurrent
72− ( throwTo
73− )
74−import Control.Concurrent.MVar
75− ( putMVar
76− )
77−import Control.Distributed.Process hiding (finally, catch)
78−import Control.Distributed.Process.Node
79−import Control.Distributed.Process.Serializable()
80−
81−import Control.Exception (AsyncException(ThreadKilled), SomeException)
82−import Control.Monad (forever, void)
83−import Control.Monad.Catch (finally, catch)
84−import Control.Monad.STM (atomically)
85−import Control.Rematch hiding (match)
86−import Control.Rematch.Run
87−import Data.Binary
88−import Data.Typeable (Typeable)
89−
90−import Test.HUnit (Assertion, assertFailure)
91−import Test.HUnit.Base (assertBool)
92−
93−import GHC.Generics
94−import System.Timeout (timeout)
95−
96−-- | A mutable cell containing a test result.
97−type TestResult a = MVar a
98−
99−-- | A simple @Ping@ signal
100−data Ping = Ping
101− deriving (Typeable, Generic, Eq, Show)
102−instance Binary Ping where
103−
104−ping :: ProcessId -> Process ()
105−ping pid = send pid Ping
106−
107−-- | Control signals used to manage /test processes/
108−data TestProcessControl = Stop | Go | Report ProcessId
109− deriving (Typeable, Generic)
110−
111−instance Binary TestProcessControl where
112−
113−data Private = Private
114− deriving (Typeable, Generic)
115−instance Binary Private where
116−
117−-- | Does exactly what it says on the tin, doing so in the @Process@ monad.
118−noop :: Process ()
119−noop = return ()
120−
121−pause :: Int -> Process ()
122−pause delay =
123− void $ receiveTimeout delay [ match (\Private -> return ()) ]
124−
125−synchronisedAssertion :: Eq a
126− => String
127− -> LocalNode
128− -> a
129− -> (TestResult a -> Process ())
130− -> MVar ()
131− -> Assertion
132−synchronisedAssertion note localNode expected testProc lock = do
133− result <- newEmptyMVar
134− _ <- forkProcess localNode $ do
135− acquire lock
136− finally (testProc result)
137− (release lock)
138− assertComplete note result expected
139− where acquire lock' = liftIO $ takeMVar lock'
140− release lock' = liftIO $ putMVar lock' ()
141−
142−stash :: TestResult a -> a -> Process ()
143−stash mvar x = liftIO $ putMVar mvar x
144−
145−expectThat :: a -> Matcher a -> Process ()
146−expectThat a matcher = case res of
147− MatchSuccess -> return ()
148− (MatchFailure msg) -> liftIO $ assertFailure msg
149− where res = runMatch matcher a
150−
151−shouldBe :: a -> Matcher a -> Process ()
152−shouldBe = expectThat
153−
154−shouldContain :: (Show a, Eq a) => [a] -> a -> Process ()
155−shouldContain xs x = expectThat xs $ hasItem (equalTo x)
156−
157−shouldNotContain :: (Show a, Eq a) => [a] -> a -> Process ()
158−shouldNotContain xs x = expectThat xs $ isNot (hasItem (equalTo x))
159−
160−shouldMatch :: a -> Matcher a -> Process ()
161−shouldMatch = expectThat
162−
163−-- | Run the supplied @testProc@ using an @MVar@ to collect and assert
164−-- against its result. Uses the supplied @note@ if the assertion fails.
165−delayedAssertion :: (Eq a) => String -> LocalNode -> a ->
166− (TestResult a -> Process ()) -> Assertion
167−delayedAssertion note localNode expected testProc = do
168− result <- newEmptyMVar
169− _ <- forkProcess localNode $ testProc result
170− assertComplete note result expected
171−
172−-- | Takes the value of @mv@ (using @takeMVar@) and asserts that it matches @a@
173−assertComplete :: (Eq a) => String -> MVar a -> a -> IO ()
174−assertComplete msg mv a = do
175− b <- takeMVar mv
176− assertBool msg (a == b)
177−
178−-- synchronised logging
179−
180−data Logger = Logger { _tid :: ThreadId, msgs :: TQueue String }
181−
182−-- | Create a new Logger.
183−-- Logger uses a 'TQueue' to receive and process messages on a worker thread.
184−newLogger :: IO Logger
185−newLogger = do
186− tid <- liftIO $ myThreadId
187− q <- liftIO $ newTQueueIO
188− _ <- forkIO $ logger q
189− return $ Logger tid q
190− where logger q' = forever $ do
191− msg <- atomically $ readTQueue q'
192− putStrLn msg
193−
194−-- | Send a message to the Logger
195−putLogMsg :: Logger -> String -> Process ()
196−putLogMsg logger msg = liftIO $ atomically $ writeTQueue (msgs logger) msg
197−
198−-- | Stop the worker thread for the given Logger
199−stopLogger :: Logger -> IO ()
200−stopLogger = (flip throwTo) ThreadKilled . _tid
201−
202−-- | Starts a test process on the local node.
203−startTestProcess :: Process () -> Process ProcessId
204−startTestProcess proc =
205− spawnLocal $ do
206− getSelfPid >>= register "test-process"
207− runTestProcess proc
208−
209−-- | Runs a /test process/ around the supplied @proc@, which is executed
210−-- whenever the outer process loop receives a 'Go' signal.
211−runTestProcess :: Process () -> Process ()
212−runTestProcess proc = do
213− ctl <- expect
214− case ctl of
215− Stop -> return ()
216− Go -> proc >> runTestProcess proc
217− Report p -> receiveWait [matchAny (\m -> forward m p)] >> runTestProcess proc
218−
219−-- | Tell a /test process/ to continue executing
220−testProcessGo :: ProcessId -> Process ()
221−testProcessGo pid = send pid Go
222−
223−-- | Tell a /test process/ to stop (i.e., 'terminate')
224−testProcessStop :: ProcessId -> Process ()
225−testProcessStop pid = send pid Stop
226−
227−-- | Tell a /test process/ to send a report (message)
228−-- back to the calling process
229−testProcessReport :: ProcessId -> Process ()
230−testProcessReport pid = do
231− self <- getSelfPid
232− send pid $ Report self
233−
234−tryRunProcess :: LocalNode -> Process () -> IO ()
235−tryRunProcess node p = do
236− tid <- liftIO myThreadId
237− void $ timeout (1000000 * 60 * 5 :: Int) $
238− runProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
239−
240−tryForkProcess :: LocalNode -> Process () -> IO ProcessId
241−tryForkProcess node p = do
242− tid <- liftIO myThreadId
243− forkProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
distributed-process-tests/src/Control/Distributed/Process/Tests/Mx.hsdeleted−542
@@ -1,542 +0,0 @@
1−{-# LANGUAGE DeriveGeneric #-}
2−{-# LANGUAGE ParallelListComp #-}
3−
4−module Control.Distributed.Process.Tests.Mx (tests) where
5−
6−import Control.Distributed.Process.Tests.Internal.Utils
7−import Network.Transport.Test (TestTransport(..))
8−import Control.Distributed.Process hiding (bracket, finally, try)
9−import Control.Distributed.Process.Internal.Types
10− ( ProcessExitException(..)
11− , unsafeCreateUnencodedMessage
12− )
13−import Control.Distributed.Process.Node
14−import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
15− ( send
16− , nsend
17− , nsendRemote
18− , usend
19− , sendChan
20− )
21−import Control.Distributed.Process.Management
22− ( MxEvent(..)
23− , MxAgentId(..)
24− , mxAgent
25− , mxSink
26− , mxReady
27− , mxReceive
28− , mxDeactivate
29− , liftMX
30− , mxGetLocal
31− , mxSetLocal
32− , mxUpdateLocal
33− , mxNotify
34− , mxBroadcast
35− )
36−import Control.Monad (void, unless)
37−import Control.Monad.Catch(finally, bracket, try)
38−import Control.Rematch (equalTo)
39−import Data.Binary
40−import Data.List (find, sort, intercalate)
41−import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
42−import Data.Typeable
43−import GHC.Generics hiding (from)
44−#if ! MIN_VERSION_base(4,6,0)
45−import Prelude hiding (catch, log)
46−#endif
47−
48−import Test.Framework
49− ( Test
50− , testGroup
51− )
52−import Test.Framework.Providers.HUnit (testCase)
53−
54−data Publish = Publish
55− deriving (Typeable, Generic, Eq)
56−
57−instance Binary Publish where
58−
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 ()
70−testAgentBroadcast result = do
71− (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
72−
73− publisher <- mxAgent (MxAgentId "publisher-agent") () [
74− mxSink $ \() -> mxBroadcast Publish >> mxReady
75− ]
76−
77− consumer <- mxAgent (MxAgentId "consumer-agent") () [
78− mxSink $ \Publish -> (liftMX $ sendChan resultSP ()) >> mxReady
79− ]
80−
81− mxNotify ()
82− -- Once the publisher has seen our message, it will broadcast the Publish
83− -- and the consumer will see that and send the result to our typed channel.
84− stash result =<< receiveChanTimeout 10000000 resultRP
85−
86− kill publisher "finished"
87− kill consumer "finished"
88−
89−testAgentDualInput :: TestResult (Maybe Int) -> Process ()
90−testAgentDualInput result = do
91− (sp, rp) <- newChan
92− s <- mxAgent (MxAgentId "sum-agent") (0 :: Int) [
93− mxSink $ (\(i :: Int) -> do
94− mxSetLocal . (+i) =<< mxGetLocal
95− i' <- mxGetLocal
96− if i' == 15
97− then do mxGetLocal >>= liftMX . sendChan sp
98− mxDeactivate "finished"
99− else mxReady)
100− ]
101−
102− mRef <- monitor s
103−
104− mxNotify (1 :: Int)
105− nsend "sum-agent" (3 :: Int)
106− mxNotify (2 :: Int)
107− nsend "sum-agent" (4 :: Int)
108− mxNotify (5 :: Int)
109−
110− 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)
115−
116−testAgentPrioritisation :: TestResult [String] -> Process ()
117−testAgentPrioritisation result = do
118−
119− -- TODO: this isn't really testing how we /prioritise/ one source
120− -- over another at all, but I've not yet figured out the right way
121− -- to do so, since we're at the whim of the scheduler with regards
122− -- the timeliness of nsend versus mxNotify anyway.
123−
124− let name = "prioritising-agent"
125− (sp, rp) <- newChan
126− s <- mxAgent (MxAgentId name) ["first"] [
127− mxSink (\(s :: String) -> do
128− mxUpdateLocal (s:)
129− st <- mxGetLocal
130− case length st of
131− n | n == 5 -> do liftMX $ sendChan sp (sort st)
132− mxDeactivate "finished"
133− _ -> mxReceive -- go to the mailbox
134− )
135− ]
136−
137− nsend name "second"
138− mxNotify "third"
139− mxNotify "fourth"
140− nsend name "fifth"
141−
142− stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
143− awaitExit s
144−
145−testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
146−testAgentMailboxHandling result = do
147− (sp, rp) <- newChan
148− agent <- mxAgent (MxAgentId "mailbox-agent") () [
149− mxSink $ \() -> (liftMX $ sendChan sp ()) >> mxReady
150− ]
151−
152− nsend "mailbox-agent" ()
153−
154− stash result =<< receiveChanTimeout 1000000 rp
155− kill agent "finished"
156−
157−testAgentEventHandling :: TestResult Bool -> Process ()
158−testAgentEventHandling result = do
159− us <- getSelfPid
160− -- because this test is a bit racy, let's ensure it can't run indefinitely
161− timer <- spawnLocal $ do
162− pause (1000000 * 60 * 5)
163− -- okay we've waited 5 mins, let's kill the test off if it's stuck...
164− stash result False
165− kill us "Test Timed Out"
166−
167− let initState = [] :: [MxEvent]
168− (rc, rs) <- newChan
169− agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
170− (mxSink $ \ev -> do
171− st <- mxGetLocal
172− let act =
173− case ev of
174− (MxSpawned _) -> mxSetLocal (ev:st)
175− (MxProcessDied _ _) -> mxSetLocal (ev:st)
176− _ -> return ()
177− act >> (liftMX $ sendChan rc ()) >> mxReady),
178− (mxSink $ \(ev, sp :: SendPort Bool) -> do
179− st <- mxGetLocal
180− let found =
181− case ev of
182− MxSpawned p ->
183− isJust $ find (\ev' ->
184− case ev' of
185− (MxSpawned p') -> p' == p
186− _ -> False) st
187− MxProcessDied p r ->
188− isJust $ find (\ev' ->
189− case ev' of
190− (MxProcessDied p' r') -> p' == p && r == r'
191− _ -> False) st
192− _ -> False
193− liftMX $ sendChan sp found
194− mxReady)
195− ]
196−
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
203−
204− -- By waiting for a monitor notification, we have a
205− -- higher probably that the agent has seen the spawn and died events
206− monitor pid
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
217−
218− (replyTo, reply) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
219− mxNotify (MxSpawned pid, replyTo)
220− mxNotify (MxProcessDied pid DiedNormal, replyTo)
221−
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− ]
437−
438− case mNode of
439− Nothing -> void $ spawnLocal (proc sp)
440− Just remoteNode -> void $ liftIO $ forkProcess remoteNode $ proc sp
441−
442− p1 <- receiveChanTimeout 2000000 rp
443− unless (isJust p1) $ die "Timed out waiting for ProcessId"
444− res <- try $ test (fromJust p1) sink
445−
446− kill agent "bye"
447− kill (fromJust p1) "bye"
448−
449− case res of
450− Left (ProcessExitException _ m) -> (liftIO $ putStrLn $ "SomeException-" ++ show m) >> die m
451− Right tr -> tr `shouldBe` equalTo True
452−
453−
454− where
455− agentLabel s = "mx-unsafe-check-agent-" ++ show s
456− proc sp' = getSelfPid >>= sendChan sp' >> go Nothing
457−
458− go :: Maybe (ReceivePort ()) -> Process ()
459− go Nothing = receiveTimeout 5000000 [ match replyChannel ] >>= go
460− go c@(Just c') = receiveWait [ matchChan c' return ] >> go c
461−
462− replyChannel p' = do
463− (s, r) <- newChan
464− send p' s
465− return r
466−
467−tests :: TestTransport -> IO [Test]
468−tests TestTransport{..} = do
469− node1 <- newLocalNode testTransport initRemoteTable
470− node2 <- newLocalNode testTransport initRemoteTable
471− return [
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/Network/Transport/Test.hsdeleted−12
@@ -1,12 +0,0 @@
1−module Network.Transport.Test where
2−
3−import qualified Network.Transport as NT
4−import Data.Typeable (Typeable)
5−
6−-- | Extra operations required of transports for the purposes of testing.
7−data TestTransport = TestTransport
8− { -- | The transport to use for testing.
9− testTransport :: NT.Transport
10− -- | IO action to perform to simulate losing a connection.
11− , testBreakConnection :: NT.EndPointAddress -> NT.EndPointAddress -> IO ()
12− } deriving (Typeable)
distributed-process-tests/tests/runInMemory.hsdeleted−30
@@ -1,30 +0,0 @@
1−-- Run tests using the TCP transport.
2−
3−module Main where
4−
5−import TEST_SUITE_MODULE (tests)
6−
7−import Network.Transport.Test (TestTransport(..))
8−import Network.Transport.InMemory
9−import Test.Framework (defaultMainWithArgs)
10−
11−import System.Environment (getArgs)
12−
13−main :: IO ()
14−main = do
15− (transport, internals) <- createTransportExposeInternals
16− ts <- tests TestTransport
17− { testTransport = transport
18− , testBreakConnection = \addr1 addr2 -> breakConnection internals addr1 addr2 "user error"
19− }
20− args <- getArgs
21− -- Tests are time sensitive. Running the tests concurrently can slow them
22− -- down enough that threads using threadDelay would wake up later than
23− -- expected, thus changing the order in which messages were expected.
24− -- Therefore we run the tests sequentially by passing "-j 1" to
25− -- test-framework. This does not solve the issue but makes it less likely.
26− --
27− -- The problem was first detected with
28− -- 'Control.Distributed.Process.Tests.CH.testMergeChannels'
29− -- in particular.
30− defaultMainWithArgs ts ("-j" : "1" : args)
distributed-process-tests/tests/runTCP.hsdeleted−47
@@ -1,47 +0,0 @@
1−-- Run tests using the TCP transport.
2−--
3−module Main where
4−
5−import TEST_SUITE_MODULE (tests)
6−
7−import Network.Transport.Test (TestTransport(..))
8−import Network.Socket (sClose)
9−import Network.Transport.TCP
10− ( createTransportExposeInternals
11− , TransportInternals(socketBetween)
12− , defaultTCPParameters
13− , defaultTCPAddr
14− , TCPParameters(..)
15− )
16−import Test.Framework (defaultMainWithArgs)
17−
18−import Control.Concurrent (threadDelay)
19−import Control.Exception (IOException, try)
20−import System.Environment (getArgs)
21−import System.IO
22−
23−main :: IO ()
24−main = do
25− hSetBuffering stdout LineBuffering
26− hSetBuffering stderr LineBuffering
27− Right (transport, internals) <-
28− createTransportExposeInternals (defaultTCPAddr "127.0.0.1" "8080")
29− defaultTCPParameters { transportConnectTimeout = Just 3000000 }
30− ts <- tests TestTransport
31− { testTransport = transport
32− , testBreakConnection = \addr1 addr2 -> do
33− esock <- try $ socketBetween internals addr1 addr2
34− either (\e -> const (return ()) (e :: IOException)) sClose esock
35− threadDelay 10000
36− }
37− args <- getArgs
38− -- Tests are time sensitive. Running the tests concurrently can slow them
39− -- down enough that threads using threadDelay would wake up later than
40− -- expected, thus changing the order in which messages were expected.
41− -- Therefore we run the tests sequentially by passing "-j 1" to
42− -- test-framework. This does not solve the issue but makes it less likely.
43− --
44− -- The problem was first detected with
45− -- 'Control.Distributed.Process.Tests.CH.testMergeChannels'
46− -- in particular.
47− defaultMainWithArgs ts ("-j" : "1" : args)
distributed-process.cabal+121−114
@@ -1,15 +1,15 @@
11Name: distributed-process
2−Version: 0.7.4
2+Version: 0.4.2
33Cabal-Version: >=1.8
44Build-Type: Simple
55License: BSD3
66License-File: LICENSE
7−Copyright: Well-Typed LLP, Tweag I/O Limited
7+Copyright: Well-Typed LLP
88Author: Duncan Coutts, Nicolas Wu, Edsko de Vries
9−Maintainer: Tim Watson <watson.timothy@gmail.com>
9+Maintainer: watson.timothy@gmail.com, edsko@well-typed.com, duncan@well-typed.com
1010Stability: experimental
1111Homepage: http://haskell-distributed.github.com/
12−Bug-Reports: https://github.com/haskell-distributed/distributed-process/issues
12+Bug-Reports: http://cloud-haskell.atlassian.net
1313Synopsis: Cloud Haskell: Erlang-style concurrency in Haskell
1414Description: This is an implementation of Cloud Haskell, as described in
1515 /Towards Haskell in the Cloud/ by Jeff Epstein, Andrew Black,
@@ -17,13 +17,12 @@ Description: This is an implementation of Cloud Haskell, as described in
1717 (<http://research.microsoft.com/en-us/um/people/simonpj/papers/parallel/>),
1818 although some of the details are different. The precise message
1919 passing semantics are based on /A unified semantics for future Erlang/
20− by Hans Svensson, Lars-&#xc5;ke Fredlund and Clara Benac Earle.
20+ by Hans Svensson, Lars-Åke Fredlund and Clara Benac Earle.
2121
2222 You will probably also want to install a Cloud Haskell backend such
2323 as distributed-process-simplelocalnet.
24−Tested-With: GHC==7.10.3 GHC==8.0.2 GHC==8.2.2 GHC==8.4.4
24+Tested-With: GHC==7.2.2 GHC==7.4.1 GHC==7.4.2
2525Category: Control
26−extra-source-files: ChangeLog
2726
2827Source-Repository head
2928 Type: git
@@ -34,135 +33,143 @@ flag th
3433 description: Build with Template Haskell support
3534 default: True
3635
37−flag old-locale
38− description: If false then depend on time >= 1.5.
39− .
40− If true then depend on time < 1.5 together with old-locale.
41− default: False
36+flag benchmarks
37+ description: Build benchmarks
38+ default: False
39+
40+flag prof
41+ description: Compiling with profiling enabled
42+ default: False
4243
4344Library
44− Build-Depends: base >= 4.6 && < 5,
45− binary >= 0.6.3 && < 0.10,
45+ Build-Depends: base >= 4.4 && < 5,
46+ binary >= 0.5 && < 0.8,
47+ deepseq >= 1.3.0.1 && < 1.4,
4648 hashable >= 1.2.0.5 && < 1.3,
47− network-transport >= 0.4.1.0 && < 0.6,
48− stm >= 2.4 && < 2.6,
49− transformers >= 0.2 && < 0.6,
50− mtl >= 2.0 && < 2.4,
49+ network-transport >= 0.3 && < 0.4,
50+ stm >= 2.4 && < 2.5,
51+ transformers >= 0.2 && < 0.4,
52+ mtl >= 2.0 && < 2.2,
5153 data-accessor >= 0.2 && < 0.3,
5254 bytestring >= 0.9 && < 0.11,
53− random >= 1.0 && < 1.2,
54− distributed-static >= 0.2 && < 0.4,
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
55+ containers >= 0.4 && < 0.6,
56+ old-locale >= 1.0 && < 1.1,
57+ time >= 1.2 && < 1.5,
58+ random >= 1.0 && < 1.1,
59+ ghc-prim >= 0.2 && < 0.4,
60+ distributed-static >= 0.2 && < 0.3,
61+ rank1dynamic >= 0.1 && < 0.2,
62+ syb >= 0.3 && < 0.5
6063 Exposed-modules: Control.Distributed.Process,
6164 Control.Distributed.Process.Closure,
6265 Control.Distributed.Process.Debug,
63− Control.Distributed.Process.Internal.BiMultiMap,
64− Control.Distributed.Process.Internal.Closure.BuiltIn,
65− Control.Distributed.Process.Internal.Closure.Explicit,
66− Control.Distributed.Process.Internal.CQueue,
67− Control.Distributed.Process.Internal.Messaging,
68− Control.Distributed.Process.Internal.Primitives,
69− Control.Distributed.Process.Internal.Spawn,
70− Control.Distributed.Process.Internal.StrictContainerAccessors,
71− Control.Distributed.Process.Internal.StrictList,
72− Control.Distributed.Process.Internal.StrictMVar,
7366 Control.Distributed.Process.Internal.Types,
74− Control.Distributed.Process.Internal.WeakTQueue,
7567 Control.Distributed.Process.Management,
7668 Control.Distributed.Process.Node,
7769 Control.Distributed.Process.Serializable,
7870 Control.Distributed.Process.UnsafePrimitives
79− Control.Distributed.Process.Management.Internal.Agent,
80− Control.Distributed.Process.Management.Internal.Bus,
81− Control.Distributed.Process.Management.Internal.Types,
82− Control.Distributed.Process.Management.Internal.Trace.Primitives,
83− Control.Distributed.Process.Management.Internal.Trace.Remote,
84− Control.Distributed.Process.Management.Internal.Trace.Types,
85− Control.Distributed.Process.Management.Internal.Trace.Tracer
71+ Other-modules: Control.Distributed.Process.Internal.Primitives,
72+ Control.Distributed.Process.Internal.Spawn,
73+ Control.Distributed.Process.Internal.Primitives,
74+ Control.Distributed.Process.Internal.CQueue,
75+ Control.Distributed.Process.Internal.Closure.BuiltIn,
76+ Control.Distributed.Process.Internal.Messaging,
77+ Control.Distributed.Process.Internal.StrictList,
78+ Control.Distributed.Process.Internal.StrictMVar,
79+ Control.Distributed.Process.Internal.WeakTQueue,
80+ Control.Distributed.Process.Internal.StrictContainerAccessors,
81+ Control.Distributed.Process.Management.Agent,
82+ Control.Distributed.Process.Management.Bus,
83+ Control.Distributed.Process.Management.Table,
84+ Control.Distributed.Process.Management.Types,
85+ Control.Distributed.Process.Management.Trace.Primitives,
86+ Control.Distributed.Process.Management.Trace.Remote,
87+ Control.Distributed.Process.Management.Trace.Types,
88+ Control.Distributed.Process.Management.Trace.Tracer
89+ Extensions: RankNTypes,
90+ ScopedTypeVariables,
91+ FlexibleInstances,
92+ UndecidableInstances,
93+ ExistentialQuantification,
94+ GADTs,
95+ GeneralizedNewtypeDeriving,
96+ DeriveDataTypeable,
97+ CPP,
98+ BangPatterns
8699 ghc-options: -Wall
87100 HS-Source-Dirs: src
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
108− if flag(old-locale)
109− Build-Depends: time < 1.5, old-locale >= 1.0 && <1.1
110− else
111− Build-Depends: time >= 1.5
112101 if flag(th)
113− other-extensions: TemplateHaskell
114− Build-Depends: template-haskell >= 2.6
102+ Build-Depends: template-haskell >= 2.6 && < 2.9
115103 Exposed-modules: Control.Distributed.Process.Internal.Closure.TH
116104 CPP-Options: -DTemplateHaskellSupport
117105
118106-- Tests are in distributed-process-test package, for convenience.
119107
120−benchmark distributed-process-throughput
121− Type: exitcode-stdio-1.0
122− Build-Depends: base >= 4.6 && < 5,
123− distributed-process,
124− network-transport-tcp >= 0.3 && < 0.7,
125− bytestring >= 0.9 && < 0.11,
126− binary >= 0.6.3 && < 0.10
127− Main-Is: benchmarks/Throughput.hs
128− ghc-options: -Wall
108+Executable distributed-process-throughput
109+ if flag(benchmarks)
110+ Build-Depends: base >= 4.4 && < 5,
111+ distributed-process,
112+ network-transport-tcp >= 0.3 && < 0.4,
113+ bytestring >= 0.9 && < 0.11,
114+ binary >= 0.5 && < 0.8
115+ else
116+ buildable: False
117+ Main-Is: benchmarks/Throughput.hs
118+ ghc-options: -Wall
119+ Extensions: BangPatterns
129120
130−benchmark distributed-process-latency
131− Type: exitcode-stdio-1.0
132− Build-Depends: base >= 4.6 && < 5,
133− distributed-process,
134− network-transport-tcp >= 0.3 && < 0.7,
135− bytestring >= 0.9 && < 0.11,
136− binary >= 0.6.3 && < 0.10
137− Main-Is: benchmarks/Latency.hs
138− ghc-options: -Wall
121+Executable distributed-process-latency
122+ if flag(benchmarks)
123+ Build-Depends: base >= 4.4 && < 5,
124+ distributed-process,
125+ network-transport-tcp >= 0.3 && < 0.4,
126+ bytestring >= 0.9 && < 0.11,
127+ binary >= 0.5 && < 0.8
128+ else
129+ buildable: False
130+ Main-Is: benchmarks/Latency.hs
131+ ghc-options: -Wall
132+ Extensions: BangPatterns
139133
140−benchmark distributed-process-channels
141− Type: exitcode-stdio-1.0
142− Build-Depends: base >= 4.6 && < 5,
143− distributed-process,
144− network-transport-tcp >= 0.3 && < 0.7,
145− bytestring >= 0.9 && < 0.11,
146− binary >= 0.6.3 && < 0.10
147− Main-Is: benchmarks/Channels.hs
148− ghc-options: -Wall
134+Executable distributed-process-channels
135+ if flag(benchmarks)
136+ Build-Depends: base >= 4.4 && < 5,
137+ distributed-process,
138+ network-transport-tcp >= 0.3 && < 0.4,
139+ bytestring >= 0.9 && < 0.11,
140+ binary >= 0.5 && < 0.8
141+ else
142+ buildable: False
143+ Main-Is: benchmarks/Channels.hs
144+ ghc-options: -Wall
145+ Extensions: BangPatterns
149146
150−benchmark distributed-process-spawns
151− Type: exitcode-stdio-1.0
152− Build-Depends: base >= 4.6 && < 5,
153− distributed-process,
154− network-transport-tcp >= 0.3 && < 0.7,
155− bytestring >= 0.9 && < 0.11,
156− binary >= 0.6.3 && < 0.10
157− Main-Is: benchmarks/Spawns.hs
158− ghc-options: -Wall
147+Executable distributed-process-spawns
148+ if flag(benchmarks)
149+ Build-Depends: base >= 4.4 && < 5,
150+ distributed-process,
151+ network-transport-tcp >= 0.3 && < 0.4,
152+ bytestring >= 0.9 && < 0.11,
153+ binary >= 0.5 && < 0.8
154+ else
155+ buildable: False
156+ Main-Is: benchmarks/Spawns.hs
157+ ghc-options: -Wall
158+ Extensions: BangPatterns
159159
160−benchmark distributed-process-ring
161− Type: exitcode-stdio-1.0
162− Build-Depends: base >= 4.6 && < 5,
163− distributed-process,
164− network-transport-tcp >= 0.3 && < 0.7,
165− bytestring >= 0.9 && < 0.11,
166− binary >= 0.6.3 && < 0.10
167− Main-Is: benchmarks/ProcessRing.hs
168− ghc-options: -Wall -threaded -O2 -rtsopts
160+Executable distributed-process-ring
161+ if flag(benchmarks)
162+ Build-Depends: base >= 4.4 && < 5,
163+ distributed-process,
164+ network-transport-tcp >= 0.3 && < 0.4,
165+ bytestring >= 0.9 && < 0.11,
166+ binary >= 0.5 && < 0.8
167+ else
168+ buildable: False
169+ Main-Is: benchmarks/ProcessRing.hs
170+ if flag(prof)
171+ ghc-options: -Wall -threaded -prof -auto-all -fno-prof-count-entries -rtsopts
172+ else
173+ ghc-options: -Wall -threaded -O2 -rtsopts
174+ Extensions: BangPatterns,
175+ ScopedTypeVariables
doc/semantics/CloudHaskellSemantics.texdeleted−706
@@ -1,706 +0,0 @@
1−\documentclass{article}
2−\usepackage[margin=2.5cm]{geometry}
3−\usepackage{amsmath, amssymb, stmaryrd}
4−\usepackage{mathpazo, times}
5−\usepackage{float}
6−\usepackage{listings}
7−
8−\newcommand{\sLam}[2]{\lambda {#1} \cdot {#2}}
9−\newcommand{\sApp}[2]{{#1} {#2}}
10−\newcommand{\sBind}[2]{{#1} \mathrel{\texttt{>}\!\!\texttt{>}\!\texttt{=}} {#2}}
11−\newcommand{\sReturn}{\mathtt{return}}
12−\newcommand{\sThrow}[1]{\mathtt{throw} \; {#1}}
13−\newcommand{\sCatch}[2]{\mathtt{catch} \; {#1} \; {#2}}
14−
15−\newcommand{\sExpect}{\mathtt{expect}}
16−\newcommand{\sSend}{\mathtt{send}}
17−\newcommand{\sSpawn}{\mathtt{spawn}}
18−\newcommand{\sLink}{\mathtt{link}}
19−\newcommand{\sReconnect}{\mathtt{reconnect}}
20−\newcommand{\sNewChan}{\mathtt{newChan}}
21−\newcommand{\sSendChan}{\mathtt{sendChan}}
22−\newcommand{\sReceiveChan}{\mathtt{receiveChan}}
23−\newcommand{\sMonitor}{\mathtt{monitor}}
24−
25−\DeclareMathOperator{\sNodeOf}{node}
26−\DeclareMathOperator{\sProcessOf}{process}
27−
28−\newcommand{\sSpawned}{\mathtt{spawned}}
29−
30−\newcommand{\sExtend}[1]{\mathrel{\triangleright_{#1}}}
31−
32−\newcommand{\sPar}{\mathrel{\parallel}}
33−\newcommand{\sProc}[2]{{#1}_{#2}}
34−
35−\newcommand{\sNid}{\ensuremath{\mathit{nid}}}
36−\newcommand{\sPid}{\ensuremath{\mathit{pid}}}
37−\newcommand{\sCid}{\ensuremath{\mathit{cid}}}
38−
39−\newcommand{\sId}{\ensuremath{\mathit{id}}}
40−\newcommand{\sRef}{\ensuremath{\mathit{ref}}}
41−
42−\newcommand{\sLinks}{\ensuremath{\mathit{links}}}
43−\newcommand{\sNode}[3]{\left[{#1} ; {#2}\right]_{#3}}
44−\newcommand{\sSystem}[4]{\left\langle #1 ; #2 ; #3 ; #4 \right\rangle}
45−\newcommand{\sNodes}{\mathcal{N}}
46−\newcommand{\sQueue}{\mathcal{Q}}
47−\newcommand{\sProcesses}{\mathcal{P}}
48−\newcommand{\sBlacklist}{\mathcal{B}}
49−\newcommand{\sMonitors}{\mathcal{M}}
50−
51−\newcommand{\sJust}[1]{\mathtt{Just} \; {#1}}
52−\newcommand{\sNothing}{\mathtt{Nothing}}
53−
54−\newcommand{\sCtxt}[1]{\mathbb{#1}}
55−
56−\newcommand{\sSenders}{\mathit{senders}}
57−
58−\newcommand{\OR}{\mathrel{|}}
59−\newcommand{\where}{\mathrel{|}}
60−
61−\floatstyle{boxed}
62−\restylefloat{figure}
63−
64−\lstset{basicstyle=\ttfamily\small}
65−
66−\begin{document}
67−
68−\title{Cloud Haskell Semantics (DRAFT)}
69−\author{Well-Typed LLP}
70−\date{\today}
71−
72−\maketitle
73−
74−\section{Introduction}
75−
76−Cloud Haskell brings Erlang-style concurrency to Haskell in the form of a
77−library.\footnote{\texttt{http://hackage.haskell.org/package/distributed-process}}
78−The original publication \cite{cloudhaskell} is a good introduction to Cloud
79−Haskell, and is accompanied by an ever-growing number of resouces, collected on
80−the Haskell
81−Wiki.\footnote{\texttt{http://www.haskell.org/haskellwiki/Cloud\_Haskell}} The
82−current document augments the original publication about Cloud Haskell by
83−giving a precise semantics to the Cloud Haskell primitives. It is meant as a
84−reference, not an introduction.
85−
86−The original Cloud Haskell paper stipulates that messages are ``asynchronous,
87−reliable, and buffered'', but does not describe how this can be achieved.
88−Understanding ``reliable'' to mean ``reliable ordered'' (or ``TCP-like''),
89−the reliability of message delivery comes from the reliability of the
90−underlying network protocol---up to a point.
91−
92−The problem is that the underlying network protocol is connection-oriented, but
93−Cloud Haskell is not. Intuitively, when $P$ sends a message to $Q$, we open a
94−reliable-ordered connection from $P$ to $Q$. Reliability of message delivery
95−now follows from reliability of the network protocol, until $P$ somehow gets
96−disconnected from $Q$. If $P$ now sends another message to $Q$, the
97−implementation cannot simply reconnect: after all, some messages that were sent
98−on the first connection might not have been delivered. This means that $P$
99−might send $m_1, m_2, m_3$ to $Q$, but $Q$ will receive $m_1,
100−m_3$.\footnote{Indeed, message passing in Erlang is ordered but unreliable for
101−the same reason \cite{erlang}.}
102−
103−One (non-)solution is for $P$ to buffer all messages it sends to $Q$, and
104−remove messages from this buffer only when $Q$ acknowledges that it received
105−them. On a reconnect $P$ must ask which message $Q$ last received, and
106−retransmit the rest. This means that when $P$ gets disconnected from $Q$, it
107−must infinitely buffer all messages sent to $Q$ (until a connection is
108−reestablished). However, infinite buffering is too strong a requirement;
109−moreover, this is unsatisfactory because it means implementing a reliable
110−protocol on top of the underlying reliable network protocol. We would like a
111−different solution.
112−
113−Instead, Cloud Haskell does \emph{not} attempt to reconnect automatically, but
114−provides a $\sReconnect$ primitive which gives programmers the option of
115−reconnecting manually. This is an explicit acknowledgement from the programmer
116−that message loss might occur, and forces them to consider how such loss might
117−be dealt with.
118−
119−The semantics we present is based on \cite{unified}, which we will refer to the
120−as the ``Unified'' semantics. However, we will present the semantics in a more
121−``Haskell'' style following the semantics for STM \cite{stm}. It differs from
122−the Unified semantics in that
123−%
124−\begin{enumerate}
125−\item We introduce an explicit notion of \textit{reconnecting} (with potential
126−message loss)
127−\item We simplify the semantics: we ``flatten'' sets of nodes of processes as
128−sets of processes (but assume a mapping from process identifiers to node
129−identifiers), do not have per-process mailboxes (but only the system queue or
130−``ether'') and do not have an explicit concept of node controllers
131−\end{enumerate}
132−%
133−Our semantics differs from the STM semantics in that we pretend that the Cloud
134−Haskell \texttt{Process} monad is the top-level monad, and do not consider the
135−\texttt{IO} monad at all. Current imprecisions with respect to the ``real''
136−Cloud Haskell are
137−%
138−\begin{enumerate}
139−\item We ignore the issue of serializability, other than to say that the
140−semantics will get stuck when trying to send a non-serializable payload;
141−consequently, we do not formalize $\mathtt{static}$
142−\item We do not formalize all Cloud Haskell primitives (merging of ports,
143−``advanced messaging'', and others)
144−\item Some of the concepts that we do formalize are lower-level concepts; for
145−instance, the primitive $\sSpawn$ that we formalize is asynchronous (following
146−the Unified semantics); a synchronous construct can be derived.
147−\end{enumerate}
148−
149−\section{Preliminaries}
150−
151−Cloud Haskell Processes run on \emph{nodes}. Processes communicate by sending
152−messages to each other (directly or using typed channels). Processes can also
153−send messages to nodes (for instance, a request to spawn or monitor a process).
154−
155−We assume disjoint countable sets $\mathtt{NodeId}$, $\mathtt{ProcessId}$, and
156−$\mathtt{ChannelId}$, changed over by \sNid, \sPid{} and \sCid{} respectively,
157−and representing process identifiers, node identifiers, and (typed) channel
158−identifiers. We assume the existence of total functions
159−%
160−\begin{equation*}
161−\begin{array}{r@{\;:\;}l}
162−\sNodeOf & (\mathtt{ProcessId} \uplus \mathtt{ChannelId}) \rightarrow \mathtt{NodeId} \\
163−\sProcessOf & \mathtt{ChannelId} \rightarrow \mathtt{ProcessId}
164−\end{array}
165−\end{equation*}
166−%
167−and define
168−$$\mathtt{Identifier} = \mathtt{NodeId} \uplus \mathtt{ProcessId} \uplus \mathtt{ChannelId}$$
169−and let $\sId$ range over $\mathtt{Identifier}$.
170−
171−We represent a process as a pair $\sProc{M}{\sPid}$ of a term $M$ and a process
172−ID $\sPid$. We will denote a set of processes as
173−%
174− $$\sProc{M}{\sPid} \sPar \cdots \sPar \sProc{N}{\sPid'}$$
175−%
176−A \emph{system}
177− $\sSystem{\sProcesses}{\sQueue}{\sBlacklist}{\sMonitors}$
178−is a tuple containing a set $\sProcesses$ of processes, a \emph{system
179−queue} $\sQueue$, a \emph{blacklist} $\sBlacklist$, and a set of monitors
180−$\sMonitors$.
181−The set of monitors $\sMonitors$ is a set of tuples
182− $(\sId_\mathit{to}, \sPid_\mathit{fr}, \sNid, \sRef)$
183−which records that node \sNid{} knows that process $\sPid_\mathit{fr}$ is
184−monitoring $\sId_\mathit{to}$ ($\sRef$ is the monitor reference). The system
185−queue is a set of triples $(\sId_\mathit{to}, \sId_\mathit{fr},
186−\mathit{message})$ of messages that have been sent but not yet processed. The
187−blacklist records disconnections and is represented as a of pairs
188−$(\sId_\mathit{to}, \sId_\mathit{fr})$.
189−
190−\section{Semantics}
191−
192−We follow the STM semantics as closely as possible. The language is the same
193−except for the primitives considered, and we use the same concept of evaluation
194−contexts:
195−
196−\begin{equation*}
197−\begin{array}{llll}
198−\text{value} & V & ::= & \sId \OR
199− \sLam{x}{M} \OR
200− \sReturn \; M \OR
201− \sBind{M}{N} \OR
202− \sThrow{M} \OR \sCatch{M}{N} \OR \\
203− &&& \sExpect \OR
204− \sSend \; \sPid \; M \OR
205− \sSpawn \; \sNid \; M \OR
206− \sMonitor \; \sId
207−\\
208−\text{term} & M, N & ::= & x \OR
209− V \OR
210− \sApp{M}{N} \OR
211− \cdots \\
212−\\
213−\text{Evaluation} & \sCtxt{E} & ::= & [] \OR \sBind{\sCtxt{E}}{M} \OR \sCatch{\sCtxt{E}}{M} \\
214−\text{context} & \sCtxt{P}_\sPid & ::= & \sCtxt{E}[]_\sPid \sPar \sProcesses
215−\end{array}
216−\end{equation*}
217−%
218−Indeed, the ``administrative'' transitions are identical
219−(Figure~\ref{fig:administrative}).
220−
221−\begin{figure}
222−\small
223−\begin{equation*}
224−\frac{
225− \llbracket M \rrbracket = V \qquad
226− M \neq V
227−}{
228− M \rightarrow V
229−} \textsc{Eval}
230−\qquad
231−\frac{
232− M \rightarrow N
233−}{
234− \sSystem{\sCtxt{P}[M]_\sPid}
235− {\sQueue}
236− {\sBlacklist}
237− {\sMonitors}
238−\rightarrow
239− \sSystem{\sCtxt{P}[N]_\sPid}
240− {\sQueue}
241− {\sBlacklist}
242− {\sMonitors}
243−} \textsc{Admin}
244−\end{equation*}
245−%
246−\begin{equation*}
247−\begin{array}{r@{\;\rightarrow\;}ll@{\hspace{2em}}r@{\;\rightarrow\;}ll}
248−\sBind{\sReturn \; N}{M} & M \; N & \textsc{Bind} & \sCatch{(\sReturn \; M)}{N} & \sReturn \; M & \textsc{Catch}_1 \\
249−\sBind{\sThrow{N}}{M} & \sThrow{N} & \textsc{Throw} & \sCatch{(\sThrow M)}{N} & N \; M & \textsc{Catch}_2 \\
250−\end{array}
251−\end{equation*}
252−%
253−\caption{\label{fig:administrative}Administrative Transitions}
254−\end{figure}
255−
256−\subsection{Disconnect and Reconnect}
257−
258−Figure~\ref{fig:disconnect} gives the semantics for disconnecting and
259−reconnecting. Rule \textsc{Disconnect} models random network disconnect
260−between nodes $\sNid_1$ and $\sNid_2$. We assume that entire \emph{nodes} get
261−disconnected from each other, not individual processes. \emph{Reconnecting}
262−however is on a per connection basis (\textsc{Recon-Ex}). Connections to and
263−from node controllers can be implicitly reconnected ($\textsc{Recon-Im}_1$ and
264−$\textsc{Recon-Im}_2$).
265−
266−\begin{figure}
267−\small
268−\begin{equation*}
269−\frac{
270− \sNid_1 \neq \sNid_2
271−}{
272− \sSystem{\sProcesses}{\sQueue}{\sBlacklist}{\sMonitors}
273−\rightarrow
274− \sSystem{\sProcesses}{\sQueue}{\sBlacklist \cup (\overline{\sNid_1} \times \overline{\sNid_2})}{\sMonitors}
275−} \textsc{Disconnect}
276−\end{equation*}
277−%
278−\begin{equation*}
279−\frac{
280−}{
281− \sSystem{\sCtxt{P}[ \sReconnect \; \sId_\mathit{to} ]_{\sPid_\mathit{fr}}}
282− {\sQueue}
283− {\sBlacklist}
284− {\sMonitors}
285−\rightarrow
286− \sSystem{\sCtxt{P}[ \sReturn \; () ]_\sPid}
287− {\sQueue}
288− {\sBlacklist \backslash (\sId_\mathit{to}, \sPid_\mathit{fr})}
289− {\sMonitors}
290−} \textsc{Recon-Ex}
291−\end{equation*}
292−%
293−\begin{equation*}
294−\frac{
295−}{
296− \sSystem{\sProcesses}{\sQueue}{\sBlacklist, (\sNid_\mathit{to}, \sId_\mathit{fr})}{\sMonitors}
297−\rightarrow
298− \sSystem{\sProcesses}{\sQueue}{\sBlacklist}{\sMonitors}
299−} \textsc{Recon-Im}_1
300−\qquad
301−\frac{
302−}{
303− \sSystem{\sProcesses}{\sQueue}{\sBlacklist, (\sId_\mathit{to}, \sNid_\mathit{fr})}{\sMonitors}
304−\rightarrow
305− \sSystem{\sProcesses}{\sQueue}{\sBlacklist}{\sMonitors}
306−} \textsc{Recon-Im}_2
307−\end{equation*}
308−%
309−where
310−%
311−\begin{equation*}
312−\overline{\sNid} \subset \mathtt{Identifier}
313− = \{ \sNid \} \cup
314− \{ \sPid \where \sNodeOf(\sPid) = \sNid \} \cup
315− \{ \sCid \where \sNodeOf(\sCid) = \sNid \}
316−\end{equation*}
317−\caption{\label{fig:disconnect}Disconnect and Reconnect}
318−\end{figure}
319−
320−\subsection{Communication}
321−
322−The semantics for the basic primitives are listed in Figure~\ref{fig:basic}.
323−Once a connection has been blacklisted, no further messages can be sent across
324−that connection (until an explicit or implicit reconnect).
325−
326−Message passing is ordered but only for a given sender and receiver; no
327−ordering guarantees exist between messages sent by different processes. For
328−that reason rules \textsc{Expect}, \textsc{ReceiveChan} and \textsc{Spawn-Exec}
329−choose the \emph{first} message of a \emph{randomly chosen} sender.
330−
331−Since the semantics is not type-driven, we represent typed channels simply as
332−an identifier with an annotation whether it is the send-end ($\sCid^s$) or the
333−receive end ($\sCid^r$) of the channel (rules \textsc{NewChan},
334−\textsc{SendChan} and \textsc{ReceiveChan}).
335−
336−Spawning finally is asynchronous. When process $P$ spawns process $Q$ on node
337−$\sNid$ (rule \textsc{Spawn-Async}) a message is sent to node $\sNid$ (which
338−may, of course, never arrive). When the remote node receives the message and
339−actually spawns $Q$ (rule \textsc{Spawn-Exec}) it sends a message back to $P$
340−with $Q$'s process ID. In Cloud Haskell this primitive is called
341−\texttt{spawnAsync}, and the Cloud Haskell \texttt{spawn} primitive is defined
342−in terms of \texttt{spawnAsync} (we do not consider the synchronous version in
343−this document).
344−
345−\begin{figure}
346−\small
347−\begin{equation*}
348−\frac{
349−}{
350− \sSystem{\sCtxt{P}[ \sSend \; \sPid_\mathit{to} \; M ]_{\sPid_\mathit{fr}}}
351− {\sQueue}
352− {\sBlacklist}
353− {\sMonitors}
354−\rightarrow
355− \sSystem{\sCtxt{P}[ \sReturn \; () ]_{\sPid_\mathit{fr}}}
356− {\sQueue \sExtend{\sBlacklist} (\sPid_\mathit{to}, \sPid_\mathit{fr}, M)}
357− {\sBlacklist}
358− {\sMonitors}
359−} \textsc{Send}
360−\end{equation*}
361−%
362−\begin{equation*}
363−\frac{
364− \sId_{\mathit{fr}} \notin \sSenders(\sQueue)
365−}{
366− \sSystem{\sCtxt{P}[ \sExpect ]_{\sPid_\mathit{to}}}
367− {\sQueue, (\sPid_\mathit{to}, \sId_\mathit{fr}, M), \sQueue'}
368− {\sBlacklist}
369− {\sMonitors}
370−\rightarrow
371− \sSystem{\sCtxt{P}[ \sReturn \; M ]_{\sPid_\mathit{to}}}
372− {\sQueue, \sQueue'}
373− {\sBlacklist}
374− {\sMonitors}
375−} \textsc{Expect}
376−\end{equation*}
377−%
378−\begin{equation*}
379−\frac{
380− \sCid \text{ fresh}
381−\qquad
382− \sProcessOf(\sCid) = \sPid
383−}{
384− \sSystem{\sCtxt{P}[\sNewChan]_\sPid}
385− {\sQueue}
386− {\sBlacklist}
387− {\sMonitors}
388−\rightarrow
389− \sSystem{\sCtxt{P}[\sReturn \; (\sCid^s, \sCid^r)]_\sPid}
390− {\sQueue}
391− {\sBlacklist}
392− {\sMonitors}
393−} \textsc{NewChan}
394−\end{equation*}
395−
396−\begin{equation*}
397−\frac{
398−}{
399− \sSystem{\sCtxt{P}[ \sSendChan \; \sCid_\mathit{to}^s \; M ]_{\sPid_\mathit{fr}}}
400− {\sQueue}
401− {\sBlacklist}
402− {\sMonitors}
403−\rightarrow
404− \sSystem{\sCtxt{P}[ \sReturn \; () ]_{\sPid_\mathit{fr}}}
405− {\sQueue \sExtend{\sBlacklist} (\sCid_\mathit{to}, \sPid_\mathit{fr}, M)}
406− {\sBlacklist}
407− {\sMonitors}
408−} \textsc{SendChan}
409−\end{equation*}
410−
411−\begin{equation*}
412−\frac{
413− \sPid_{\mathit{fr}} \notin \sSenders(\sQueue)
414−}{
415− \sSystem{\sCtxt{P}[ \sReceiveChan \; \sCid_\mathit{to}^r ]_{\sPid}}
416− {\sQueue, (\sCid_\mathit{to}, \sPid_\mathit{fr}, M), \sQueue'}
417− {\sBlacklist}
418− {\sMonitors}
419−\rightarrow
420− \sSystem{\sCtxt{P}[ \sReturn \; M ]_{\sPid}}
421− {\sQueue, \sQueue'}
422− {\sBlacklist}
423− {\sMonitors}
424−} \textsc{ReceiveChan}
425−\end{equation*}
426−%
427−\begin{equation*}
428−\frac{
429− \sRef \text{ fresh}
430−}{
431− \sSystem{\sCtxt{P}[ \sSpawn \; \sNid \; M ]_\sPid}
432− {\sQueue}
433− {\sBlacklist}
434− {\sMonitors}
435−\rightarrow
436− \sSystem{\sCtxt{P}[ \sReturn \; \sRef ]_\sPid}
437− {\sQueue \sExtend{\sBlacklist} (\sNid, \sPid, \sSpawn \; \sRef \; M)}
438− {\sBlacklist}
439− {\sMonitors}
440−} \textsc{Spawn-Async}
441−\end{equation*}
442−%
443−\begin{equation*}
444−\frac{
445− \sPid \notin \sSenders(\sQueue)
446−\qquad
447− \sPid' \text{ fresh}
448−\qquad
449− \sNodeOf(\sPid') = \sNid
450−}{
451− \sSystem{\sProcesses}
452− {\sQueue, (\sNid, \sPid, \sSpawn \; \sRef \; M), \sQueue'}
453− {\sBlacklist}
454− {\sMonitors}
455−\rightarrow
456− \sSystem{\sProcesses \sPar M_{\sPid'}}
457− {\sQueue, \sQueue' \sExtend{\sBlacklist} (\sPid, \sNid, \sSpawned \; \sRef \; \sPid')}
458− {\sBlacklist}
459− {\sMonitors}
460−} \textsc{Spawn-Exec}
461−\end{equation*}
462−%
463−where
464−%
465−\begin{equation*}
466−\begin{array}{l@{\;=\;}l@{\hspace{3em}}l}
467− \sQueue \sExtend{\sBlacklist} (\sId_\mathit{to}, \sId_\mathit{fr}, M)
468−&
469− \sQueue, (\sId_\mathit{to}, \sId_\mathit{fr}, M)
470−&
471− \text{if } (\sId_\mathit{to}, \sId_\mathit{fr}) \notin \sBlacklist
472−\\
473− \sQueue \sExtend{\sBlacklist} (\sId_\mathit{to}, \sId_\mathit{fr}, M)
474−&
475− \sQueue
476−&
477− \text{otherwise}
478−\end{array}
479−\end{equation*}
480−%
481−$(\sExtend{\sBlacklist})$ is only defined for serializable payloads.
482−\caption{\label{fig:basic}Basic Primitives}
483−\end{figure}
484−
485−\subsection{Monitoring}
486−
487−When process $P$ on node $\sNid_P$ wants to monitor process $Q$ on node
488−$\sNid_Q$ \emph{both} nodes must be notified. The local node it notified
489−immediately, and a message is sent to to the remote node (rules
490−\textsc{Mon-Loc} and \textsc{Mon-Rem}). As with all messages, the
491−message to the remote node might be lost. When $P$ is disconnected from $Q$ it
492−is the responsibility of $P$'s local node $\sNid_P$ to notify $P$
493−(\textsc{Mon-Dis}); when $Q$ terminates (\textsc{Mon-Ret}) or crashes
494−(\textsc{Mon-Throw}) it is the responsibility of the remote node $\sNid_Q$ to
495−notify $P$.
496−
497−\begin{figure}
498−\small
499−\begin{equation*}
500−\frac{
501− \sNid_\mathit{fr} = \sNodeOf(\sPid_\mathit{fr})
502−\qquad
503− \sNid_\mathit{to} = \sNodeOf(\sId_\mathit{to})
504−\qquad
505− \sRef \text{ fresh}
506−}{
507−\sSystem{\sCtxt{P}[ \sMonitor \; \sId_\mathit{to} ]_{\sPid_\mathit{fr}}}
508− {\sQueue}
509− {\sBlacklist}
510− {\sMonitors}
511−\rightarrow
512− \sSystem{\sCtxt{P}[ \sReturn \; \sRef ]_{\sPid_\mathit{fr}}}
513− {\sQueue \sExtend{\sBlacklist} (\sNid_\mathit{to}, \sPid_\mathit{fr}, \sMonitor \; \sRef \; \sId_\mathit{to})}
514− {\sBlacklist}
515− {\sMonitors, (\sId_\mathit{to}, \sPid_\mathit{fr}, \sNid_\mathit{fr}, \sRef)}
516−} \textsc{Mon-Loc}
517−\end{equation*}
518−%
519−\begin{equation*}
520−\frac{
521− \sPid_\mathit{fr} \notin \sSenders(\sQueue)
522−}{
523− \sSystem{\sProcesses}
524− {\sQueue, (\sNid_\mathit{to}, \sPid_\mathit{fr}, \sMonitor \; \sRef \; \sId_\mathit{to}), \sQueue'}
525− {\sBlacklist}
526− {\sMonitors}
527−\rightarrow
528− \sSystem{\sProcesses}
529− {\sQueue, \sQueue'}
530− {\sBlacklist}
531− {\sMonitors, (\sId_\mathit{to}, \sPid_\mathit{fr}, \sNid_\mathit{to}, \sRef)}
532−} \textsc{Mon-Rem}
533−\end{equation*}
534−%
535−\begin{equation*}
536−\frac{
537− \sNid_\mathit{fr} = \sNodeOf(\sPid_\mathit{fr})
538−\qquad
539− (\sId_\mathit{to}, \sPid_\mathit{fr}) \in \sBlacklist
540−}{
541− \sSystem{\sProcesses}
542− {\sQueue}
543− {\sBlacklist}
544− {\sMonitors, (\sId_\mathit{to}, \sPid_\mathit{fr}, \sNid_\mathit{fr}, \sRef)}
545−\rightarrow
546− \sSystem{\sProcesses}
547− {\sQueue, (\sPid_\mathit{fr}, \sId_\mathit{to}, \mathtt{discon} \; \sRef)}
548− {\sBlacklist}
549− {\sMonitors}
550−} \textsc{Mon-Dis}
551−\end{equation*}
552−%
553−\begin{equation*}
554−\frac{
555− \sNodeOf(\sPid) = \sNid
556−}{
557− \sSystem{{(\sReturn \; ())}_\sPid \sPar \sProcesses}
558− {\sQueue}
559− {\sBlacklist}
560− {\sMonitors, (\sPid, \sPid', \sNid, \sRef)}
561−\rightarrow
562− \sSystem{{(\sReturn \; ())}_\sPid \sPar \sProcesses}
563− {\sQueue \sExtend{\sBlacklist} (\sPid', \sNid, \mathtt{died} \; \sRef)}
564− {\sBlacklist}
565− {\sMonitors}
566−} \textsc{Mon-Ret}
567−\end{equation*}
568−%
569−\begin{equation*}
570−\frac{
571− \sNodeOf(\sPid) = \sNid
572−}{
573− \sSystem{{(\sThrow{M})}_\sPid \sPar \sProcesses}
574− {\sQueue}
575− {\sBlacklist}
576− {\sMonitors, (\sPid, \sPid', \sNid, \sRef)}
577−\rightarrow
578− \sSystem{{(\sThrow{M})}_\sPid \sPar \sProcesses}
579− {\sQueue \sExtend{\sBlacklist} (\sPid', \sNid, \mathtt{exc} \; \sRef \; M)}
580− {\sBlacklist}
581− {\sMonitors}
582−} \textsc{Mon-Throw}
583−\end{equation*}
584−%
585−\begin{equation*}
586−\frac{
587− \sNodeOf(\sPid) = \sNid
588−\qquad
589− \sPid \notin \sProcesses
590−}{
591− \sSystem{\sProcesses}
592− {\sQueue}
593− {\sBlacklist}
594− {\sMonitors, (\sPid, \sPid', \sNid, \sRef)}
595−\rightarrow
596− \sSystem{\sProcesses}
597− {\sQueue \sExtend{\sBlacklist} (\sPid', \sNid, \mathtt{unknown} \; \sRef)}
598− {\sBlacklist}
599− {\sMonitors}
600−} \textsc{Mon-Unknown}
601−\end{equation*}
602−%
603−\caption{Monitoring}
604−\end{figure}
605−
606−\subsection{Process Termination}
607−
608−The rules for normal and abnormal process termination are defined in
609−Figure~\ref{fig:termination}. When a process crashes it dies
610−silently, unless monitors are setup.
611−
612−\begin{figure}
613−\small
614−%
615−\begin{equation*}
616−\frac{
617− \sNodeOf(\sPid) = \sNid
618−\qquad
619− \nexists \; \sPid', \sRef \cdot (\sPid', \sPid, \sNid, \sRef) \in \sMonitors
620−}{
621− \sSystem{{(\sReturn \; ())}_\sPid \sPar \sProcesses}
622− {\sQueue}
623− {\sBlacklist}
624− {\sMonitors}
625−\rightarrow
626− \sSystem{\sProcesses}
627− {\sQueue}
628− {\sBlacklist}
629− {\sMonitors}
630−} \textsc{TermRet}
631−\end{equation*}
632−%
633−\begin{equation*}
634−\frac{
635− \sNodeOf(\sPid) = \sNid
636−\qquad
637− \nexists \; \sPid', \sRef \cdot (\sPid', \sPid, \sNid, \sRef) \in \sMonitors
638−}{
639− \sSystem{{(\sThrow{M})}_\sPid \sPar \sProcesses}
640− {\sQueue}
641− {\sBlacklist}
642− {\sMonitors}
643−\rightarrow
644− \sSystem{\sProcesses}
645− {\sQueue}
646− {\sBlacklist}
647− {\sMonitors}
648−} \textsc{TermThrow}
649−\end{equation*}
650−%
651−\caption{\label{fig:termination}Process Termination}
652−\end{figure}
653−
654−\section{Open Issues}
655−
656−\subsection{Ordering of Monitor/Link Notifications}
657−
658−The semantics as described above, like the original Unified semantics, does not
659−guarantee that messages send from process $P$ to process $Q$ (\textsc{Send})
660−are ordered with respect to the link or monitor notification sent when process
661−$P$ terminates normally or abnormally (\textsc{Mon-Ret}, \textsc{Mon-Throw}). This means that if process $P$ does
662−
663−\begin{lstlisting}
664−receiveWait [
665− match $ \(Reply reply) -> ...
666− , match $ \(ProcessMonitorNotification ..) -> ...
667− ]
668−\end{lstlisting}
669−
670−and process $Q$ does
671−
672−\begin{lstlisting}
673−send pidA (Reply reply)
674−// terminate or indeed throw an exception
675−\end{lstlisting}
676−
677−then the semantics does not guarantee that the reply from process $Q$ will
678−arrive at process $P$ before the monitor notification; hence, this results in
679−an (artificial) race condition in process $P$.
680−
681−One possible solution is to regard such a link notification as a message from
682−process $Q$ to process $P$, which should be ordered along with the other
683−messages.
684−
685−\subsection{Ordering and Typed Channels}
686−
687−The situation is more tricky still than sketched above because we of typed
688−channels. The semantics does not provide ordering guarantees between messages
689−sent directly to the process and messages sent on typed channels. That means
690−that even if we consider a link or monitor notification as a message sent to
691−the process, to be ordered with other messages sent to that process, it is
692−still unordered with respect to messages sent on typed channels. This means
693−that we have similar race conditions\footnote{Even ignoring the fact that we
694−currently don't even provide a way to wait for a message on a typed channel
695−\emph{or} a direct message.}
696−
697−A possible solution is to insist that \emph{all} messages from process $P$ to
698−process $Q$ are ordered, no matter how they are sent. From a implementation
699−point of view, this would entail the use of a single ordered network connection
700−for all messages from $P$ to $Q$, rather than using an ordered connection per
701−typed channel plus one for direct messages.
702−
703−\bibliographystyle{apalike}
704−\bibliography{references}
705−
706−\end{document}
doc/semantics/Makefiledeleted−11
@@ -1,11 +0,0 @@
1−CloudHaskellSemantics.pdf: *.tex *.bib
2− pdflatex CloudHaskellSemantics
3− bibtex CloudHaskellSemantics
4− pdflatex CloudHaskellSemantics
5− pdflatex CloudHaskellSemantics
6−
7−.PHONY: clean
8−clean:
9− rm -f *.aux *.bbl *.blg *.log
10−
11−# vi:set noexpandtab:
doc/semantics/references.bibdeleted−72
@@ -1,72 +0,0 @@
1−@inproceedings{cloudhaskell,
2− author = {Epstein, Jeff and Black, Andrew P. and Peyton-Jones, Simon},
3− title = {Towards {H}askell in the cloud},
4− booktitle = {Proceedings of the 4th ACM symposium on Haskell},
5− series = {Haskell '11},
6− year = {2011},
7− isbn = {978-1-4503-0860-1},
8− location = {Tokyo, Japan},
9− pages = {118--129},
10− numpages = {12},
11− url = {http://doi.acm.org/10.1145/2034675.2034690},
12− doi = {10.1145/2034675.2034690},
13− acmid = {2034690},
14− publisher = {ACM},
15− address = {New York, NY, USA},
16− keywords = {erlang, haskell, message-passing},
17−}
18−
19−@inproceedings{unified,
20− author = {Svensson, Hans and Fredlund, Lars-{\AA}ke and Benac Earle, Clara},
21− title = {A unified semantics for future {E}rlang},
22− booktitle = {Proceedings of the 9th ACM SIGPLAN workshop on Erlang},
23− series = {Erlang '10},
24− year = {2010},
25− isbn = {978-1-4503-0253-1},
26− location = {Baltimore, Maryland, USA},
27− pages = {23--32},
28− numpages = {10},
29− url = {http://doi.acm.org/10.1145/1863509.1863514},
30− doi = {10.1145/1863509.1863514},
31− acmid = {1863514},
32− publisher = {ACM},
33− address = {New York, NY, USA},
34− keywords = {erlang, semantics},
35−}
36−
37−@article{stm,
38− author = {Harris, Tim and Marlow, Simon and Jones, Simon Peyton and Herlihy, Maurice},
39− title = {Composable memory transactions},
40− journal = {Commun. ACM},
41− issue_date = {August 2008},
42− volume = {51},
43− number = {8},
44− month = aug,
45− year = {2008},
46− issn = {0001-0782},
47− pages = {91--100},
48− numpages = {10},
49− url = {http://doi.acm.org/10.1145/1378704.1378725},
50− doi = {10.1145/1378704.1378725},
51− acmid = {1378725},
52− publisher = {ACM},
53− address = {New York, NY, USA},
54−}
55−
56−@inproceedings{erlang,
57− author = {Svensson, Hans and Fredlund, Lars-\AAke},
58− title = {A more accurate semantics for distributed erlang},
59− booktitle = {Proceedings of the 2007 SIGPLAN workshop on ERLANG Workshop},
60− series = {ERLANG '07},
61− year = {2007},
62− isbn = {978-1-59593-675-2},
63− location = {Freiburg, Germany},
64− pages = {43--54},
65− numpages = {12},
66− url = {http://doi.acm.org/10.1145/1292520.1292528},
67− doi = {10.1145/1292520.1292528},
68− acmid = {1292528},
69− publisher = {ACM},
70− address = {New York, NY, USA},
71− keywords = {distributed systems, erlang, model checking, semantics, verification},
72−}
src/Control/Distributed/Process.hs+7−74
@@ -1,4 +1,3 @@
1−{-# LANGUAGE CPP #-}
21{- | [Cloud Haskell]
32
43This is an implementation of Cloud Haskell, as described in
@@ -17,7 +16,7 @@ please see the distributed-process wiki page on github:
1716module Control.Distributed.Process
1817 ( -- * Basic types
1918 ProcessId
20− , NodeId(..)
19+ , NodeId
2120 , Process
2221 , SendPortId
2322 , processNodeId
@@ -25,7 +24,6 @@ module Control.Distributed.Process
2524 , liftIO -- Reexported for convenience
2625 -- * Basic messaging
2726 , send
28− , usend
2927 , expect
3028 , expectTimeout
3129 -- * Channels
@@ -40,10 +38,8 @@ module Control.Distributed.Process
4038 , mergePortsRR
4139 -- * Unsafe messaging variants
4240 , unsafeSend
43− , unsafeUSend
4441 , unsafeSendChan
4542 , unsafeNSend
46− , unsafeNSendRemote
4743 , unsafeWrapMessage
4844 -- * Advanced messaging
4945 , Match
@@ -55,7 +51,6 @@ module Control.Distributed.Process
5551 , matchAny
5652 , matchAnyIf
5753 , matchChan
58− , matchSTM
5954 , Message
6055 , matchMessage
6156 , matchMessageIf
@@ -64,10 +59,7 @@ module Control.Distributed.Process
6459 , unwrapMessage
6560 , handleMessage
6661 , handleMessageIf
67− , handleMessage_
68− , handleMessageIf_
6962 , forward
70− , uforward
7163 , delegate
7264 , relay
7365 , proxy
@@ -87,9 +79,6 @@ module Control.Distributed.Process
8779 , getSelfNode
8880 , ProcessInfo(..)
8981 , getProcessInfo
90− , NodeStats(..)
91− , getNodeStats
92− , getLocalNodeStats
9382 -- * Monitoring and linking
9483 , link
9584 , linkNode
@@ -102,7 +91,6 @@ module Control.Distributed.Process
10291 , monitorPort
10392 , unmonitor
10493 , withMonitor
105− , withMonitor_
10694 , MonitorRef -- opaque
10795 , ProcessLinkException(..)
10896 , NodeLinkException(..)
@@ -139,7 +127,6 @@ module Control.Distributed.Process
139127 , catches
140128 , try
141129 , mask
142− , mask_
143130 , onException
144131 , bracket
145132 , bracket_
@@ -154,22 +141,19 @@ module Control.Distributed.Process
154141 -- * Local versions of 'spawn'
155142 , spawnLocal
156143 , spawnChannelLocal
157− , callLocal
158144 -- * Reconnecting
159145 , reconnect
160146 , reconnectPort
161147 ) where
162148
149+#if ! MIN_VERSION_base(4,6,0)
150+import Prelude hiding (catch)
151+#endif
152+
163153import Control.Monad.IO.Class (liftIO)
164−import Control.Applicative
154+import Control.Applicative ((<$>))
165155import Control.Monad.Reader (ask)
166−import Control.Concurrent (killThread)
167−import Control.Concurrent.MVar
168− ( MVar
169− , newEmptyMVar
170− , takeMVar
171− , putMVar
172− )
156+import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
173157import Control.Distributed.Static
174158 ( Closure
175159 , closure
@@ -198,13 +182,11 @@ import Control.Distributed.Process.Internal.Types
198182 , RegisterReply(..)
199183 , LocalProcess(processNode)
200184 , Message
201− , localProcessWithId
202185 )
203186import Control.Distributed.Process.Serializable (Serializable)
204187import Control.Distributed.Process.Internal.Primitives
205188 ( -- Basic messaging
206189 send
207− , usend
208190 , expect
209191 -- Channels
210192 , newChan
@@ -213,10 +195,8 @@ import Control.Distributed.Process.Internal.Primitives
213195 , mergePortsBiased
214196 , mergePortsRR
215197 , unsafeSend
216− , unsafeUSend
217198 , unsafeSendChan
218199 , unsafeNSend
219− , unsafeNSendRemote
220200 -- Advanced messaging
221201 , Match
222202 , receiveWait
@@ -227,7 +207,6 @@ import Control.Distributed.Process.Internal.Primitives
227207 , matchAny
228208 , matchAnyIf
229209 , matchChan
230− , matchSTM
231210 , matchMessage
232211 , matchMessageIf
233212 , isEncoded
@@ -236,10 +215,7 @@ import Control.Distributed.Process.Internal.Primitives
236215 , unwrapMessage
237216 , handleMessage
238217 , handleMessageIf
239− , handleMessage_
240− , handleMessageIf_
241218 , forward
242− , uforward
243219 , delegate
244220 , relay
245221 , proxy
@@ -255,9 +231,6 @@ import Control.Distributed.Process.Internal.Primitives
255231 , getSelfNode
256232 , ProcessInfo(..)
257233 , getProcessInfo
258− , NodeStats(..)
259− , getNodeStats
260− , getLocalNodeStats
261234 -- Monitoring and linking
262235 , link
263236 , linkNode
@@ -270,7 +243,6 @@ import Control.Distributed.Process.Internal.Primitives
270243 , monitorPort
271244 , unmonitor
272245 , withMonitor
273− , withMonitor_
274246 -- Logging
275247 , say
276248 -- Registry
@@ -293,7 +265,6 @@ import Control.Distributed.Process.Internal.Primitives
293265 , catches
294266 , try
295267 , mask
296− , mask_
297268 , onException
298269 , bracket
299270 , bracket_
@@ -307,10 +278,6 @@ import Control.Distributed.Process.Internal.Primitives
307278 , reconnectPort
308279 )
309280import Control.Distributed.Process.Node (forkProcess)
310−import Control.Distributed.Process.Internal.Types
311− ( processThread
312− , withValidLocalState
313− )
314281import Control.Distributed.Process.Internal.Spawn
315282 ( -- Spawning Processes/Channels
316283 spawn
@@ -320,17 +287,6 @@ import Control.Distributed.Process.Internal.Spawn
320287 , spawnSupervised
321288 , call
322289 )
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−
334290
335291-- INTERNAL NOTES
336292--
@@ -422,26 +378,3 @@ spawnChannelLocal proc = do
422378 proc rport
423379 takeMVar mvar
424380
425−-- | Local version of 'call'. Running a process in this way isolates it from
426−-- messages sent to the caller process, and also allows silently dropping late
427−-- or duplicate messages sent to the isolated process after it exits.
428−-- Silently dropping messages may not always be the best approach.
429−callLocal :: Process a -> Process a
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/Closure.hs−20
@@ -163,8 +163,6 @@ module Control.Distributed.Process.Closure
163163 , sdictUnit
164164 , sdictProcessId
165165 , sdictSendPort
166− , sdictStatic
167− , sdictClosure
168166 -- * The CP type and associated combinators
169167 , CP
170168 , idCP
@@ -179,13 +177,6 @@ module Control.Distributed.Process.Closure
179177 , cpSend
180178 , cpExpect
181179 , cpNewChan
182− -- * Working with static values and closures (without Template Haskell)
183− , RemoteRegister
184− , MkTDict(..)
185− , mkStaticVal
186− , mkClosureValSingle
187− , mkClosureVal
188− , call'
189180#ifdef TemplateHaskellSupport
190181 -- * Template Haskell support for creating static values and closures
191182 , remotable
@@ -205,8 +196,6 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
205196 , sdictUnit
206197 , sdictProcessId
207198 , sdictSendPort
208− , sdictStatic
209− , sdictClosure
210199 -- The CP type and associated combinators
211200 , CP
212201 , idCP
@@ -222,15 +211,6 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
222211 , cpExpect
223212 , cpNewChan
224213 )
225−import Control.Distributed.Process.Internal.Closure.Explicit
226− (
227− RemoteRegister
228− , MkTDict(..)
229− , mkStaticVal
230− , mkClosureValSingle
231− , mkClosureVal
232− , call'
233− )
234214#ifdef TemplateHaskellSupport
235215import Control.Distributed.Process.Internal.Closure.TH
236216 ( remotable
src/Control/Distributed/Process/Debug.hs+14−25
@@ -1,6 +1,3 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE RankNTypes #-}
41-----------------------------------------------------------------------------
52-- |
63-- Module : Control.Distributed.Process.Debug
@@ -24,7 +21,7 @@
2421-- generates /trace events/, describing internal runtime activities such as
2522-- the spawning and death of processes, message sending, delivery and so on.
2623-- See the 'MxEvent' type's documentation for a list of all the published
27−-- event types, which correspond directly to the types of /management/ events.
24+-- event types, which correspond directly to the types of 'Management' event.
2825-- Users can additionally publish custom trace events in the form of
2926-- 'MxLog' log messages or pass custom (i.e., completely user defined)
3027-- event data using the 'traceMessage' function.
@@ -78,19 +75,6 @@
7875-- This is checked for /any/ non-empty value. If set, all internal traces are
7976-- written to the GHC eventlog.
8077--
81−-- By default, the built in tracers will ignore all trace events! In order to
82−-- enable tracing the incoming 'MxEvent' stream, the @DISTRIBUTED_PROCESS_TRACE_FLAGS@
83−-- environment variable accepts the following flags, which enable tracing specific
84−-- event types:
85−--
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
93−--
9478-- Users of the /simplelocalnet/ Cloud Haskell backend should also note that
9579-- because the trace file option only supports trace output from a single node
9680-- (so as to avoid interleaving), a file trace configured for the master node
@@ -141,14 +125,17 @@ module Control.Distributed.Process.Debug
141125 )
142126 where
143127
144−import Control.Applicative
128+import Control.Applicative ((<$>))
145129import Control.Distributed.Process.Internal.Primitives
146130 ( proxy
131+ , finally
147132 , die
148133 , whereis
149134 , send
150135 , receiveWait
151136 , matchIf
137+ , finally
138+ , try
152139 , monitor
153140 )
154141import Control.Distributed.Process.Internal.Types
@@ -157,21 +144,21 @@ import Control.Distributed.Process.Internal.Types
157144 , LocalProcess(..)
158145 , ProcessMonitorNotification(..)
159146 )
160−import Control.Distributed.Process.Management.Internal.Types
147+import Control.Distributed.Process.Management.Types
161148 ( MxEvent(..)
162149 )
163−import Control.Distributed.Process.Management.Internal.Trace.Types
150+import Control.Distributed.Process.Management.Trace.Types
164151 ( TraceArg(..)
165152 , TraceFlags(..)
166153 , TraceSubject(..)
167154 , defaultTraceFlags
168155 )
169−import Control.Distributed.Process.Management.Internal.Trace.Tracer
156+import Control.Distributed.Process.Management.Trace.Tracer
170157 ( systemLoggerTracer
171158 , logfileTracer
172159 , eventLogTracer
173160 )
174−import Control.Distributed.Process.Management.Internal.Trace.Primitives
161+import Control.Distributed.Process.Management.Trace.Primitives
175162 ( withRegisteredTracer
176163 , enableTrace
177164 , enableTraceAsync
@@ -186,18 +173,19 @@ import Control.Distributed.Process.Management.Internal.Trace.Primitives
186173 , traceLogFmt
187174 , traceMessage
188175 )
189−import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Remote
176+import qualified Control.Distributed.Process.Management.Trace.Remote as Remote
190177import Control.Distributed.Process.Node
191178
192179import Control.Exception (SomeException)
193180
194181import Control.Monad.IO.Class (liftIO)
195182import Control.Monad.Reader (ask)
196−import Control.Monad.Catch (finally, try)
197183
198184import Data.Binary()
199185
200−import Prelude
186+#if ! MIN_VERSION_base(4,6,0)
187+import Prelude hiding (catch)
188+#endif
201189
202190--------------------------------------------------------------------------------
203191-- Debugging/Tracing API --
@@ -286,3 +274,4 @@ stopTracer =
286274 case basePid == (Just pid) of
287275 True -> return ()
288276 False -> send pid MxTraceDisable
277+
src/Control/Distributed/Process/Internal/BiMultiMap.hsdeleted−135
@@ -1,135 +0,0 @@
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+16−68
@@ -1,8 +1,5 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE BangPatterns #-}
4−{-# LANGUAGE MagicHash, UnboxedTuples, PatternGuards, ScopedTypeVariables, RankNTypes #-}
51-- | Concurrent queue for single reader, single writer
2+{-# LANGUAGE MagicHash, UnboxedTuples, PatternGuards #-}
63module Control.Distributed.Process.Internal.CQueue
74 ( CQueue
85 , BlockSpec(..)
@@ -12,7 +9,6 @@ module Control.Distributed.Process.Internal.CQueue
129 , enqueueSTM
1310 , dequeue
1411 , mkWeakCQueue
15− , queueSize
1612 ) where
1713
1814import Prelude hiding (length, reverse)
@@ -20,14 +16,10 @@ import Control.Concurrent.STM
2016 ( atomically
2117 , STM
2218 , TChan
23− , TVar
24− , modifyTVar'
2519 , tryReadTChan
2620 , newTChan
27− , newTVarIO
2821 , writeTChan
2922 , readTChan
30− , readTVarIO
3123 , orElse
3224 , retry
3325 )
@@ -45,56 +37,39 @@ import Control.Distributed.Process.Internal.StrictList
4537 , append
4638 )
4739import Data.Maybe (fromJust)
48−import Data.Traversable (traverse)
4940import GHC.MVar (MVar(MVar))
50−import GHC.IO (IO(IO), unIO)
51−import GHC.Exts (mkWeak#)
41+import GHC.IO (IO(IO))
42+import GHC.Prim (mkWeak#)
5243import GHC.Weak (Weak(Weak))
5344
5445-- We use a TCHan rather than a Chan so that we have a non-blocking read
5546data CQueue a = CQueue (StrictMVar (StrictList a)) -- Arrived
5647 (TChan a) -- Incoming
57− (TVar Int) -- Queue size
5848
5949newCQueue :: IO (CQueue a)
60−newCQueue = CQueue <$> newMVar Nil <*> atomically newTChan <*> newTVarIO 0
50+newCQueue = CQueue <$> newMVar Nil <*> atomically newTChan
6151
6252-- | Enqueue an element
6353--
6454-- Enqueue is strict.
6555enqueue :: CQueue a -> a -> IO ()
66−enqueue c !a = atomically (enqueueSTM c a)
56+enqueue (CQueue _arrived incoming) !a = atomically $ writeTChan incoming a
6757
6858-- | Variant of enqueue for use in the STM monad.
6959enqueueSTM :: CQueue a -> a -> STM ()
70−enqueueSTM (CQueue _arrived incoming size) !a = do
71− writeTChan incoming a
72− modifyTVar' size succ
60+enqueueSTM (CQueue _arrived incoming) !a = writeTChan incoming a
7361
7462data BlockSpec =
7563 NonBlocking
7664 | Blocking
7765 | Timeout Int
7866
79−-- Match operations
80−--
81−-- They can be either a message match or a channel match.
8267data MatchOn m a
8368 = MatchMsg (m -> Maybe a)
8469 | MatchChan (STM a)
85− deriving (Functor)
8670
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.
9271type MatchChunks m a = [Either [m -> Maybe a] [STM a]]
9372
94−-- Splits a list of matches into chunks.
95−--
96−-- > concatMap (either (map MatchMsg) (map MatchChan)) . chunkMatches == id
97−--
9873chunkMatches :: [MatchOn m a] -> MatchChunks m a
9974chunkMatches [] = []
10075chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
@@ -102,7 +77,6 @@ chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
10277chunkMatches (MatchChan r : ms) = Right (r : chk) : chunkMatches rest
10378 where (chk, rest) = spanMatchChan ms
10479
105−-- | @spanMatchMsg = first (map (\(MatchMsg x) -> x)) . span isMatchMsg@
10680spanMatchMsg :: [MatchOn m a] -> ([m -> Maybe a], [MatchOn m a])
10781spanMatchMsg [] = ([],[])
10882spanMatchMsg (m : ms)
@@ -110,7 +84,6 @@ spanMatchMsg (m : ms)
11084 | otherwise = ([], m:ms)
11185 where !(msgs,rest) = spanMatchMsg ms
11286
113−-- | @spanMatchMsg = first (map (\(MatchChan x) -> x)) . span isMatchChan@
11487spanMatchChan :: [MatchOn m a] -> ([STM a], [MatchOn m a])
11588spanMatchChan [] = ([],[])
11689spanMatchChan (m : ms)
@@ -127,7 +100,7 @@ dequeue :: forall m a.
127100 -> BlockSpec -- ^ Blocking behaviour
128101 -> [MatchOn m a] -- ^ List of matches
129102 -> IO (Maybe a) -- ^ 'Nothing' only on timeout
130−dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJust $
103+dequeue (CQueue arrived incoming) blockSpec matchons =
131104 case blockSpec of
132105 Timeout n -> timeout n $ fmap fromJust run
133106 _other ->
@@ -139,17 +112,9 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
139112 -- no onException needed
140113 _other -> run
141114 where
142− -- Decrement counter is smth is returned from the queue,
143− -- this is safe to use as method is called under a mask
144− -- and there is no 'unmasked' operation inside
145− decrementJust :: IO (Maybe (Either a a)) -> IO (Maybe a)
146− decrementJust f =
147− traverse (either return (\x -> decrement >> return x)) =<< f
148− decrement = atomically $ modifyTVar' size pred
149−
150115 chunks = chunkMatches matchons
151116
152− run = do
117+ run = mask_ $ do
153118 arr <- takeMVar arrived
154119 let grabNew xs = do
155120 r <- atomically $ tryReadTChan incoming
@@ -159,25 +124,17 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
159124 arr' <- grabNew arr
160125 goCheck chunks arr'
161126
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))
166127 waitChans ports on_block =
167− foldr orElse on_block (map (fmap (Just . Left)) ports)
128+ foldr orElse on_block (map (fmap Just) ports)
168129
169130 --
170131 -- First check the MatchChunks against the messages already in the
171132 -- mailbox. For channel matches, we do a non-blocking check at
172133 -- this point.
173134 --
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− --
178135 goCheck :: MatchChunks m a
179136 -> StrictList m -- messages to check, in this order
180− -> IO (Maybe (Either a a))
137+ -> IO (Maybe a)
181138
182139 goCheck [] old = goWait old
183140
@@ -194,7 +151,7 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
194151 -- of passing around restore and setting up exception handlers is
195152 -- high. So just don't use expensive matchIfs!
196153 case checkArrived matches old of
197− (old', Just r) -> returnOld old' (Just (Right r))
154+ (old', Just r) -> returnOld old' (Just r)
198155 (old', Nothing) -> goCheck rest old'
199156 -- use the result list, which is now left-biased
200157
@@ -223,7 +180,6 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
223180 -- Contents of 'arrived' from now on is (old ++ new), and
224181 -- messages that arrive are snocced onto new.
225182 --
226− goWait :: StrictList m -> IO (Maybe (Either a a))
227183 goWait old = do
228184 r <- waitIncoming `onException` putMVar arrived old
229185 case r of
@@ -241,7 +197,7 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
241197 --
242198 -- Right => message arrived on a channel first
243199 --
244− Right a -> returnOld old (Just (Left a))
200+ Right a -> returnOld old (Just a)
245201
246202 --
247203 -- A message arrived in the process inbox; check the MatchChunks for
@@ -250,7 +206,7 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
250206 goCheck1 :: MatchChunks m a
251207 -> m -- single message to check
252208 -> StrictList m -- old messages we have already checked
253− -> IO (Maybe (Either a a))
209+ -> IO (Maybe a)
254210
255211 goCheck1 [] m old = goWait (Snoc old m)
256212
@@ -263,17 +219,16 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
263219 goCheck1 (Left matches : rest) m old = do
264220 case checkMatches matches m of
265221 Nothing -> goCheck1 rest m old
266− Just p -> returnOld old (Just (Right p))
222+ Just p -> returnOld old (Just p)
267223
268224 -- a common pattern for putting back the arrived queue at the end
269− returnOld :: StrictList m -> Maybe (Either a a) -> IO (Maybe (Either a a))
225+ returnOld :: StrictList m -> Maybe a -> IO (Maybe a)
270226 returnOld old r = do putMVar arrived old; return r
271227
272228 -- as a side-effect, this left-biases the list
273229 checkArrived :: [m -> Maybe a] -> StrictList m -> (StrictList m, Maybe a)
274230 checkArrived matches list = go list Nil
275231 where
276− -- @go xs ys@ searches for a message match in @append xs ys@
277232 go Nil Nil = (Nil, Nothing)
278233 go Nil r = go r Nil
279234 go (Append xs ys) tl = go xs (append ys tl)
@@ -289,12 +244,5 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
289244
290245-- | Weak reference to a CQueue
291246mkWeakCQueue :: CQueue a -> IO () -> IO (Weak (CQueue a))
292−mkWeakCQueue 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
247+mkWeakCQueue m@(CQueue (StrictMVar (MVar m#)) _) f = IO $ \s ->
296248 case mkWeak# m# m f s of (# s1, w #) -> (# s1, Weak w #)
297−#endif
298−
299−queueSize :: CQueue a -> IO Int
300−queueSize (CQueue _ _ size) = readTVarIO size
src/Control/Distributed/Process/Internal/Closure/BuiltIn.hs+8−27
@@ -1,5 +1,3 @@
1−{-# LANGUAGE ScopedTypeVariables #-}
2−{-# LANGUAGE RankNTypes #-}
31module Control.Distributed.Process.Internal.Closure.BuiltIn
42 ( -- * Remote table
53 remoteTable
@@ -8,8 +6,6 @@ module Control.Distributed.Process.Internal.Closure.BuiltIn
86 , sdictUnit
97 , sdictProcessId
108 , sdictSendPort
11− , sdictStatic
12− , sdictClosure
139 -- * Some static values
1410 , sndStatic
1511 -- * The CP type and associated combinators
@@ -28,7 +24,7 @@ module Control.Distributed.Process.Internal.Closure.BuiltIn
2824 , cpExpect
2925 , cpNewChan
3026 -- * Support for some CH operations
31− , cpDelayed
27+ , cpDelay
3228 , cpEnableTraceRemote
3329 ) where
3430
@@ -52,7 +48,6 @@ import Control.Distributed.Static
5248import Control.Distributed.Process.Serializable
5349 ( SerializableDict(..)
5450 , Serializable
55− , TypeableDict(..)
5651 )
5752import Control.Distributed.Process.Internal.Types
5853 ( Process
@@ -85,8 +80,6 @@ remoteTable =
8580 . registerStatic "$sdictUnit" (toDynamic (SerializableDict :: SerializableDict ()))
8681 . registerStatic "$sdictProcessId" (toDynamic (SerializableDict :: SerializableDict ProcessId))
8782 . registerStatic "$sdictSendPort_" (toDynamic (sdictSendPort_ :: SerializableDict ANY -> SerializableDict (SendPort ANY)))
88− . registerStatic "$sdictStatic" (toDynamic (sdictStatic_ :: TypeableDict ANY -> SerializableDict (Static ANY)))
89− . registerStatic "$sdictClosure" (toDynamic (sdictClosure_ :: TypeableDict ANY -> SerializableDict (Closure ANY)))
9083 . registerStatic "$returnProcess" (toDynamic (return :: ANY -> Process ANY))
9184 . registerStatic "$seqProcess" (toDynamic ((>>) :: Process ANY1 -> Process ANY2 -> Process ANY2))
9285 . registerStatic "$bindProcess" (toDynamic ((>>=) :: Process ANY1 -> (ANY1 -> Process ANY2) -> Process ANY2))
@@ -107,12 +100,6 @@ remoteTable =
107100 sdictSendPort_ :: forall a. SerializableDict a -> SerializableDict (SendPort a)
108101 sdictSendPort_ SerializableDict = SerializableDict
109102
110− sdictStatic_ :: forall a. TypeableDict a -> SerializableDict (Static a)
111− sdictStatic_ TypeableDict = SerializableDict
112−
113− sdictClosure_ :: forall a. TypeableDict a -> SerializableDict (Closure a)
114− sdictClosure_ TypeableDict = SerializableDict
115−
116103 sendDict :: forall a. SerializableDict a -> ProcessId -> a -> Process ()
117104 sendDict SerializableDict = send
118105
@@ -155,14 +142,6 @@ sdictSendPort :: Typeable a
155142 => Static (SerializableDict a) -> Static (SerializableDict (SendPort a))
156143sdictSendPort = staticApply (staticLabel "$sdictSendPort_")
157144
158−-- | Serialization dictionary for 'Static'.
159−sdictStatic :: Typeable a => Static (TypeableDict a) -> Static (SerializableDict (Static a))
160−sdictStatic = staticApply (staticLabel "$sdictStatic")
161−
162−-- | Serialization dictionary for 'Closure'.
163−sdictClosure :: Typeable a => Static (TypeableDict a) -> Static (SerializableDict (Closure a))
164−sdictClosure = staticApply (staticLabel "$sdictClosure")
165−
166145--------------------------------------------------------------------------------
167146-- Static values --
168147--------------------------------------------------------------------------------
@@ -295,20 +274,19 @@ cpEnableTraceRemote =
295274-- | @delay them p@ is a process that waits for a signal (a message of type @()@)
296275-- from 'them' (origin is not verified) before proceeding as @p@. In order to
297276-- avoid waiting forever, @delay them p@ monitors 'them'. If it receives a
298−-- monitor message instead, it proceeds as @p@ too.
277+-- monitor message instead it simply terminates.
299278delay :: ProcessId -> Process () -> Process ()
300279delay them p = do
301280 ref <- monitor them
302281 let sameRef (ProcessMonitorNotification ref' _ _) = ref == ref'
303282 receiveWait [
304− match $ \() -> unmonitor ref
283+ match $ \() -> unmonitor ref >> p
305284 , matchIf sameRef $ \_ -> return ()
306285 ]
307− p
308286
309287-- | 'CP' version of 'delay'
310−cpDelayed :: ProcessId -> Closure (Process ()) -> Closure (Process ())
311−cpDelayed = closureApply . cpDelay'
288+cpDelay :: ProcessId -> Closure (Process ()) -> Closure (Process ())
289+cpDelay = closureApply . cpDelay'
312290 where
313291 cpDelay' :: ProcessId -> Closure (Process () -> Process ())
314292 cpDelay' pid = closure decoder (encode pid)
@@ -318,3 +296,6 @@ cpDelayed = closureApply . cpDelay'
318296
319297 delayStatic :: Static (ProcessId -> Process () -> Process ())
320298 delayStatic = staticLabel "$delay"
299+
300+
301+
src/Control/Distributed/Process/Internal/Closure/Explicit.hsdeleted−147
@@ -1,147 +0,0 @@
1−{-# LANGUAGE ScopedTypeVariables
2− , MultiParamTypeClasses
3− , FlexibleInstances
4− , FunctionalDependencies
5− , FlexibleContexts
6− , UndecidableInstances
7− , KindSignatures
8− , GADTs
9− , EmptyDataDecls
10− , DeriveDataTypeable #-}
11−module Control.Distributed.Process.Internal.Closure.Explicit
12− (
13− RemoteRegister
14− , MkTDict(..)
15− , mkStaticVal
16− , mkClosureValSingle
17− , mkClosureVal
18− , call'
19− ) where
20−
21−import Control.Distributed.Static
22−import Control.Distributed.Process.Serializable
23−import Control.Distributed.Process.Internal.Closure.BuiltIn
24− ( -- Static dictionaries and associated operations
25− staticDecode
26− )
27−import Control.Distributed.Process
28−import Data.Rank1Dynamic
29−import Data.Rank1Typeable
30−import Data.Binary(encode,put,get,Binary)
31−import qualified Data.ByteString.Lazy as B
32−
33−-- | A RemoteRegister is a trasformer on a RemoteTable to register additional static values.
34−type RemoteRegister = RemoteTable -> RemoteTable
35−
36−-- | This takes an explicit name and a value, and produces both a static reference to the name and a RemoteRegister for it.
37−mkStaticVal :: Serializable a => String -> a -> (Static a, RemoteRegister)
38−mkStaticVal n v = (staticLabel n_s, registerStatic n_s (toDynamic v))
39− where n_s = n
40−
41−class MkTDict a where
42− mkTDict :: String -> a -> RemoteRegister
43−
44−instance (Serializable b) => MkTDict (Process b) where
45− mkTDict _ _ = registerStatic (show (typeOf (undefined :: b)) ++ "__staticDict") (toDynamic (SerializableDict :: SerializableDict b))
46−
47−instance MkTDict a where
48− mkTDict _ _ = id
49−
50−-- | This takes an explicit name, a function of arity one, and creates a creates a function yielding a closure and a remote register for it.
51−mkClosureValSingle :: forall a b. (Serializable a, Typeable b, MkTDict b) => String -> (a -> b) -> (a -> Closure b, RemoteRegister)
52−mkClosureValSingle n v = (c, registerStatic n_s (toDynamic v) .
53− registerStatic n_sdict (toDynamic sdict) .
54− mkTDict n_tdict (undefined :: b)
55− ) where
56− n_s = n
57− n_sdict = n ++ "__sdict"
58− n_tdict = n ++ "__tdict"
59−
60− c = closure decoder . encode
61−
62− decoder = (staticLabel n_s :: Static (a -> b)) `staticCompose` staticDecode (staticLabel n_sdict :: Static (SerializableDict a))
63−
64− sdict :: (SerializableDict a)
65− sdict = SerializableDict
66−
67−-- | This takes an explict name, a function of any arity, and creates a function yielding a closure and a remote register for it.
68−mkClosureVal :: forall func argTuple result closureFunction.
69− (Curry (argTuple -> Closure result) closureFunction,
70− MkTDict result,
71− Uncurry HTrue argTuple func result,
72− Typeable result, Serializable argTuple, IsFunction func HTrue) =>
73− String -> func -> (closureFunction, RemoteRegister)
74−mkClosureVal n v = (curryFun c, rtable)
75− where
76− uv :: argTuple -> result
77− uv = uncurry' reify v
78−
79− n_s = n
80− n_sdict = n ++ "__sdict"
81− n_tdict = n ++ "__tdict"
82−
83− c :: argTuple -> Closure result
84− c = closure decoder . encode
85−
86− decoder :: Static (B.ByteString -> result)
87− decoder = (staticLabel n_s :: Static (argTuple -> result)) `staticCompose` staticDecode (staticLabel n_sdict :: Static (SerializableDict argTuple))
88−
89− rtable = registerStatic n_s (toDynamic uv) .
90− registerStatic n_sdict (toDynamic sdict) .
91− mkTDict n_tdict (undefined :: result)
92−
93−
94− sdict :: (SerializableDict argTuple)
95− sdict = SerializableDict
96−
97−-- | Works just like standard call, but with a simpler signature.
98−call' :: forall a. Serializable a => NodeId -> Closure (Process a) -> Process a
99−call' = call (staticLabel $ (show $ typeOf $ (undefined :: a)) ++ "__staticDict")
100−
101−
102−data EndOfTuple deriving Typeable
103−instance Binary EndOfTuple where
104− put _ = return ()
105− get = return undefined
106−
107−-- This generic curry is straightforward
108−class Curry a b | a -> b where
109− curryFun :: a -> b
110−
111−instance Curry ((a, EndOfTuple) -> b) (a -> b) where
112− curryFun f = \x -> f (x,undefined)
113−
114−instance Curry (b -> c) r => Curry ((a,b) -> c) (a -> r) where
115− curryFun f = \x -> curryFun (\y -> (f (x,y)))
116−
117−
118−-- This generic uncurry courtesy Andrea Vezzosi
119−data HTrue
120−data HFalse
121−data Fun :: * -> * -> * -> * where
122− Done :: Fun EndOfTuple r r
123− Moar :: Fun xs f r -> Fun (x,xs) (x -> f) r
124−
125−class Uncurry'' args func result | func -> args, func -> result, args result -> func where
126− reify :: Fun args func result
127−
128−class Uncurry flag args func result | flag func -> args, flag func -> result, args result -> func where
129− reify' :: flag -> Fun args func result
130−
131−instance Uncurry'' rest f r => Uncurry HTrue (a,rest) (a -> f) r where
132− reify' _ = Moar reify
133−
134−instance Uncurry HFalse EndOfTuple a a where
135− reify' _ = Done
136−
137−instance (IsFunction func b, Uncurry b args func result) => Uncurry'' args func result where
138− reify = reify' (undefined :: b)
139−
140−uncurry' :: Fun args func result -> func -> args -> result
141−uncurry' Done r _ = r
142−uncurry' (Moar fun) f (x,xs) = uncurry' fun (f x) xs
143−
144−class IsFunction t b | t -> b
145−instance (b ~ HTrue) => IsFunction (a -> c) b
146−instance (b ~ HFalse) => IsFunction a b
147−
src/Control/Distributed/Process/Internal/Closure/TH.hs+8−24
@@ -1,5 +1,5 @@
11-- | Template Haskell support
2−{-# LANGUAGE TemplateHaskell, CPP #-}
2+{-# LANGUAGE TemplateHaskell #-}
33module Control.Distributed.Process.Internal.Closure.TH
44 ( -- * User-level API
55 remotable
@@ -29,14 +29,7 @@ import Language.Haskell.TH
2929 , Type(AppT, ForallT, VarT, ArrowT)
3030 , Info(VarI)
3131 , TyVarBndr(PlainTV, KindedTV)
32− , Pred
33−#if MIN_VERSION_template_haskell(2,10,0)
34− , conT
35− , appT
36−#else
37− , classP
38−#endif
39− , varT
32+ , Pred(ClassP)
4033 -- Lifted constructors
4134 -- .. Literals
4235 , stringL
@@ -251,21 +244,16 @@ generateStatic :: Name -> [TyVarBndr] -> Type -> Q [Dec]
251244generateStatic n xs typ = do
252245 staticTyp <- [t| Static |]
253246 sequence
254− [ sigD (staticName n) $ do
255− txs <- sequence $ map typeable xs
247+ [ sigD (staticName n) $
256248 return (ForallT xs
257− txs
258− (staticTyp `AppT` typ))
249+ (map typeable xs)
250+ (staticTyp `AppT` typ)
251+ )
259252 , sfnD (staticName n) [| staticLabel $(showFQN n) |]
260253 ]
261254 where
262− typeable :: TyVarBndr -> Q Pred
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
255+ typeable :: TyVarBndr -> Pred
256+ typeable tv = ClassP (mkName "Typeable") [VarT (tyVarBndrName tv)]
269257
270258-- | Generate a serialization dictionary with name 'n' for type 'typ'
271259generateDict :: Name -> Type -> Q [Dec]
@@ -303,11 +291,7 @@ getType :: Name -> Q (Name, Type)
303291getType name = do
304292 info <- reify name
305293 case info of
306−#if MIN_VERSION_template_haskell(2,11,0)
307− VarI origName typ _ -> return (origName, typ)
308−#else
309294 VarI origName typ _ _ -> return (origName, typ)
310−#endif
311295 _ -> fail $ show name ++ " not found"
312296
313297-- | Variation on 'funD' which takes a single expression to define the function
src/Control/Distributed/Process/Internal/Messaging.hs+28−37
@@ -13,13 +13,12 @@ import Data.Binary (Binary, encode)
1313import qualified Data.Map as Map (partitionWithKey, elems)
1414import qualified Data.ByteString.Lazy as BSL (toChunks)
1515import qualified Data.ByteString as BSS (ByteString)
16+import Control.Distributed.Process.Internal.StrictMVar (withMVar, modifyMVar_)
1617import Control.Distributed.Process.Serializable ()
1718
18−import Control.Concurrent (forkIO)
1919import Control.Concurrent.Chan (writeChan)
20−import Control.Exception (mask_)
2120import Control.Monad (unless)
22−import Control.Monad.IO.Class (liftIO)
21+import Control.Monad.IO.Class (MonadIO, liftIO)
2322import Control.Monad.Reader (ask)
2423import qualified Network.Transport as NT
2524 ( Connection
@@ -30,10 +29,7 @@ import qualified Network.Transport as NT
3029 , close
3130 )
3231import Control.Distributed.Process.Internal.Types
33− ( LocalNode(localEndPoint, localCtrlChan)
34− , withValidLocalState
35− , modifyValidLocalState
36− , modifyValidLocalState_
32+ ( LocalNode(localState, localEndPoint, localCtrlChan)
3733 , Identifier
3834 , localConnections
3935 , localConnectionBetween
@@ -54,7 +50,6 @@ import Control.Distributed.Process.Internal.Types
5450 , Identifier(NodeIdentifier, ProcessIdentifier, SendPortIdentifier)
5551 )
5652import Control.Distributed.Process.Serializable (Serializable)
57−import Data.Foldable (forM_)
5853
5954--------------------------------------------------------------------------------
6055-- Message sending --
@@ -78,7 +73,7 @@ sendPayload node from to implicitReconnect payload = do
7873 unless didSend $ do
7974 writeChan (localCtrlChan node) NCMsg
8075 { ctrlMsgSender = to
81− , ctrlMsgSignal = Died (NodeIdentifier $ nodeOf to) DiedDisconnect
76+ , ctrlMsgSignal = Died to DiedDisconnect
8277 }
8378
8479sendBinary :: Binary a
@@ -107,7 +102,7 @@ setupConnBetween :: LocalNode
107102 -> ImplicitReconnect
108103 -> IO (Maybe NT.Connection)
109104setupConnBetween node from to implicitReconnect = do
110− mConn <- NT.connect (localEndPoint node)
105+ mConn <- NT.connect endPoint
111106 (nodeAddress . nodeOf $ to)
112107 NT.ReliableOrdered
113108 NT.defaultConnectHints
@@ -118,11 +113,14 @@ setupConnBetween node from to implicitReconnect = do
118113 Left _ ->
119114 return Nothing
120115 Right () -> do
121− modifyValidLocalState_ node $
122− return . (localConnectionBetween from to ^= Just (conn, implicitReconnect))
116+ modifyMVar_ nodeState $ return .
117+ (localConnectionBetween from to ^= Just (conn, implicitReconnect))
123118 return $ Just conn
124119 Left _ ->
125120 return Nothing
121+ where
122+ endPoint = localEndPoint node
123+ nodeState = localState node
126124
127125connBetween :: LocalNode
128126 -> Identifier
@@ -130,37 +128,33 @@ connBetween :: LocalNode
130128 -> ImplicitReconnect
131129 -> IO (Maybe NT.Connection)
132130connBetween node from to implicitReconnect = do
133− mConn <- withValidLocalState node $
134− return . (^. localConnectionBetween from to)
131+ mConn <- withMVar nodeState $ return . (^. localConnectionBetween from to)
135132 case mConn of
136133 Just (conn, _) ->
137134 return $ Just conn
138135 Nothing ->
139136 setupConnBetween node from to implicitReconnect
137+ where
138+ nodeState = localState node
140139
141140disconnect :: LocalNode -> Identifier -> Identifier -> IO ()
142−disconnect node from to = mask_ $ do
143− mio <- modifyValidLocalState node $ \vst ->
144− case vst ^. localConnectionBetween from to of
141+disconnect node from to =
142+ modifyMVar_ (localState node) $ \st ->
143+ case st ^. localConnectionBetween from to of
145144 Nothing ->
146− return (vst, return ())
145+ return st
147146 Just (conn, _) -> do
148− return ( localConnectionBetween from to ^= Nothing $ vst
149− , NT.close conn
150− )
151− forM_ mio forkIO
147+ NT.close conn
148+ return (localConnectionBetween from to ^= Nothing $ st)
152149
153150closeImplicitReconnections :: LocalNode -> Identifier -> IO ()
154−closeImplicitReconnections node to = mask_ $ do
155− mconns <- modifyValidLocalState node $ \vst -> do
151+closeImplicitReconnections node to =
152+ modifyMVar_ (localState node) $ \st -> do
156153 let shouldClose (_, to') (_, WithImplicitReconnect) = to `impliesDeathOf` to'
157154 shouldClose _ _ = False
158− let (affected, unaffected) =
159− Map.partitionWithKey shouldClose (vst ^. localConnections)
160− return ( localConnections ^= unaffected $ vst
161− , map fst $ Map.elems affected
162− )
163− forM_ mconns $ forkIO . mapM_ NT.close
155+ let (affected, unaffected) = Map.partitionWithKey shouldClose (st ^. localConnections)
156+ mapM_ (NT.close . fst) (Map.elems affected)
157+ return (localConnections ^= unaffected $ st)
164158
165159-- | @a `impliesDeathOf` b@ is true if the death of @a@ (for instance, a node)
166160-- implies the death of @b@ (for instance, a process on that node)
@@ -183,11 +177,7 @@ _ `impliesDeathOf` _ =
183177 False
184178
185179
186−-- Send a control message. Evaluates the message to HNF before sending it.
187−--
188−-- The message shouldn't produce more errors when further evaluated. If
189−-- evaluation threw errors the node controller or the receiver would crash when
190−-- inspecting it.
180+-- Send a control message
191181sendCtrlMsg :: Maybe NodeId -- ^ Nothing for the local node
192182 -> ProcessSignal -- ^ Message to send
193183 -> Process ()
@@ -198,10 +188,11 @@ sendCtrlMsg mNid signal = do
198188 }
199189 case mNid of
200190 Nothing -> do
201− liftIO $ writeChan (localCtrlChan (processNode proc)) $! msg
191+ liftIO $ writeChan (localCtrlChan (processNode proc)) msg
202192 Just nid ->
203193 liftIO $ sendBinary (processNode proc)
204− (NodeIdentifier (processNodeId $ processId proc))
194+ (ProcessIdentifier (processId proc))
205195 (NodeIdentifier nid)
206196 WithImplicitReconnect
207197 msg
198+
src/Control/Distributed/Process/Internal/Primitives.hs+106−324
@@ -1,9 +1,3 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE RankNTypes #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveFunctor #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE ExistentialQuantification #-}
71{-# LANGUAGE BangPatterns #-}
82
93-- | Cloud Haskell primitives
@@ -13,7 +7,6 @@
137module Control.Distributed.Process.Internal.Primitives
148 ( -- * Basic messaging
159 send
16− , usend
1710 , expect
1811 -- * Channels
1912 , newChan
@@ -23,10 +16,8 @@ module Control.Distributed.Process.Internal.Primitives
2316 , mergePortsRR
2417 -- * Unsafe messaging variants
2518 , unsafeSend
26− , unsafeUSend
2719 , unsafeSendChan
2820 , unsafeNSend
29− , unsafeNSendRemote
3021 -- * Advanced messaging
3122 , Match
3223 , receiveWait
@@ -37,7 +28,6 @@ module Control.Distributed.Process.Internal.Primitives
3728 , matchAny
3829 , matchAnyIf
3930 , matchChan
40− , matchSTM
4131 , matchMessage
4232 , matchMessageIf
4333 , isEncoded
@@ -46,10 +36,7 @@ module Control.Distributed.Process.Internal.Primitives
4636 , unwrapMessage
4737 , handleMessage
4838 , handleMessageIf
49− , handleMessage_
50− , handleMessageIf_
5139 , forward
52− , uforward
5340 , delegate
5441 , relay
5542 , proxy
@@ -68,19 +55,13 @@ module Control.Distributed.Process.Internal.Primitives
6855 , getSelfNode
6956 , ProcessInfo(..)
7057 , getProcessInfo
71− , NodeStats(..)
72− , getNodeStats
73− , getLocalNodeStats
7458 -- * Monitoring and linking
7559 , link
7660 , unlink
7761 , monitor
7862 , unmonitor
79− , unmonitorAsync
8063 , withMonitor
81− , withMonitor_
8264 -- * Logging
83− , SayMessage(..)
8465 , say
8566 -- * Registry
8667 , register
@@ -102,7 +83,6 @@ module Control.Distributed.Process.Internal.Primitives
10283 , catches
10384 , try
10485 , mask
105− , mask_
10686 , onException
10787 , bracket
10888 , bracket_
@@ -128,27 +108,17 @@ module Control.Distributed.Process.Internal.Primitives
128108import Prelude hiding (catch)
129109#endif
130110
131−import Data.Binary (Binary(..), Put, Get, decode)
132−import Data.Time.Clock (getCurrentTime, UTCTime(..))
133−import Data.Time.Calendar (Day(..))
111+import Data.Binary (decode)
112+import Data.Time.Clock (getCurrentTime)
134113import Data.Time.Format (formatTime)
135−#if MIN_VERSION_time(1,5,0)
136−import Data.Time.Format (defaultTimeLocale)
137−#else
138114import System.Locale (defaultTimeLocale)
139−#endif
140115import System.Timeout (timeout)
141−import Control.Monad (when, void)
116+import Control.Monad (when)
142117import Control.Monad.Reader (ask)
143−import Control.Monad.IO.Class (liftIO)
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
118+import Control.Monad.IO.Class (MonadIO, liftIO)
119+import Control.Applicative ((<$>))
120+import Control.Exception (Exception(..), throw, throwIO, SomeException)
121+import qualified Control.Exception as Ex (catch, mask, try)
152122import Control.Distributed.Process.Internal.StrictMVar
153123 ( StrictMVar
154124 , modifyMVar
@@ -187,8 +157,6 @@ import Control.Distributed.Process.Internal.Types
187157 , MonitorRef(..)
188158 , SpawnRef(..)
189159 , ProcessSignal(..)
190− , NodeMonitorNotification(..)
191− , ProcessMonitorNotification(..)
192160 , monitorCounter
193161 , spawnCounter
194162 , SendPort(..)
@@ -199,7 +167,6 @@ import Control.Distributed.Process.Internal.Types
199167 , SendPortId(..)
200168 , Identifier(..)
201169 , ProcessExitException(..)
202− , DiedReason(..)
203170 , DidUnmonitor(..)
204171 , DidUnlinkProcess(..)
205172 , DidUnlinkNode(..)
@@ -209,10 +176,10 @@ import Control.Distributed.Process.Internal.Types
209176 , ProcessRegistrationException(..)
210177 , ProcessInfo(..)
211178 , ProcessInfoNone(..)
212− , NodeStats(..)
213179 , isEncoded
214180 , createMessage
215181 , createUnencodedMessage
182+ , runLocalProcess
216183 , ImplicitReconnect( NoImplicitReconnect)
217184 , LocalProcessState
218185 , LocalSendPortId
@@ -225,10 +192,10 @@ import Control.Distributed.Process.Internal.Messaging
225192 , disconnect
226193 , sendCtrlMsg
227194 )
228−import Control.Distributed.Process.Management.Internal.Types
195+import Control.Distributed.Process.Management.Types
229196 ( MxEvent(..)
230197 )
231−import Control.Distributed.Process.Management.Internal.Trace.Types
198+import Control.Distributed.Process.Management.Trace.Types
232199 ( traceEvent
233200 )
234201import Control.Distributed.Process.Internal.WeakTQueue
@@ -236,7 +203,6 @@ import Control.Distributed.Process.Internal.WeakTQueue
236203 , readTQueue
237204 , mkWeakTQueue
238205 )
239−import Prelude
240206
241207import Unsafe.Coerce
242208
@@ -254,15 +220,17 @@ send them msg = do
254220 node = processNode proc
255221 nodeId = localNodeId node
256222 destNode = (processNodeId them) in do
223+ case destNode == nodeId of
224+ True -> sendLocal them msg
225+ False -> liftIO $ sendMessage (processNode proc)
226+ (ProcessIdentifier (processId proc))
227+ (ProcessIdentifier them)
228+ NoImplicitReconnect
229+ msg
230+ -- We do not fire the trace event until after the sending is complete;
231+ -- In the remote case, 'sendMessage' can block in the networking stack.
257232 liftIO $ traceEvent (localEventBus node)
258233 (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
266234
267235-- | /Unsafe/ variant of 'send'. This function makes /no/ attempt to serialize
268236-- and (in the case when the destination process resides on the same local
@@ -271,34 +239,6 @@ send them msg = do
271239unsafeSend :: Serializable a => ProcessId -> a -> Process ()
272240unsafeSend = Unsafe.send
273241
274−-- | Send a message unreliably.
275−--
276−-- Unlike 'send', this function is insensitive to 'reconnect'. It will
277−-- try to send the message regardless of the history of connection failures
278−-- between the nodes.
279−--
280−-- Message passing with 'usend' is ordered for a given sender and receiver
281−-- if the messages arrive at all.
282−--
283−usend :: Serializable a => ProcessId -> a -> Process ()
284−usend them msg = do
285− proc <- ask
286− let there = processNodeId them
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
291− then sendLocal them msg
292− else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
293− (createMessage msg)
294−
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−
302242-- | Wait for a message of a specific type
303243expect :: forall a. Serializable a => Process a
304244expect = receiveWait [match return]
@@ -307,13 +247,7 @@ expect = receiveWait [match return]
307247-- Channels --
308248--------------------------------------------------------------------------------
309249
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−--
250+-- | Create a new typed channel
317251newChan :: Serializable a => Process (SendPort a, ReceivePort a)
318252newChan = do
319253 proc <- ask
@@ -341,16 +275,13 @@ newChan = do
341275sendChan :: Serializable a => SendPort a -> a -> Process ()
342276sendChan (SendPort cid) msg = do
343277 proc <- ask
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
278+ let node = localNodeId (processNode proc)
279+ destNode = processNodeId (sendPortProcessId cid) in do
280+ case destNode == node of
350281 True -> sendChanLocal cid msg
351282 False -> do
352− liftIO $ sendBinary node
353− (ProcessIdentifier pid)
283+ liftIO $ sendBinary (processNode proc)
284+ (ProcessIdentifier (processId proc))
354285 (SendPortIdentifier cid)
355286 NoImplicitReconnect
356287 msg
@@ -405,17 +336,13 @@ mergePortsRR = \ps -> do
405336
406337-- | Opaque type used in 'receiveWait' and 'receiveTimeout'
407338newtype Match b = Match { unMatch :: MatchOn Message (Process b) }
408− deriving (Functor)
409339
410340-- | Test the matches in order against each message in the queue
411341receiveWait :: [Match b] -> Process b
412342receiveWait ms = do
413343 queue <- processQueue <$> ask
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."
344+ Just proc <- liftIO $ dequeue queue Blocking (map unMatch ms)
345+ proc
419346
420347-- | Like 'receiveWait' but with a timeout.
421348--
@@ -431,26 +358,9 @@ receiveTimeout t ms = do
431358 Nothing -> return Nothing
432359 Just proc -> Just <$> proc
433360
434−-- | Match on a typed channel
435361matchChan :: ReceivePort a -> (a -> Process b) -> Match b
436362matchChan p fn = Match $ MatchChan (fmap fn (receiveSTM p))
437363
438−-- | Match on an arbitrary STM action.
439−--
440−-- This rather unusaul /match primitive/ allows us to compose arbitrary STM
441−-- actions with checks against our process' mailbox and/or any typed channel
442−-- @ReceivePort@s we may hold.
443−--
444−-- This allows us to process multiple input streams /along with our mailbox/,
445−-- in just the same way that 'matchChan' supports checking both the mailbox
446−-- /and/ an arbitrary set of typed channels in one atomic transaction.
447−--
448−-- Note there are no ordering guarnatees with respect to these disparate input
449−-- sources.
450−--
451−matchSTM :: STM a -> (a -> Process b) -> Match b
452−matchSTM stm fn = Match $ MatchChan (fmap fn stm)
453−
454364-- | Match against any message of the right type
455365match :: forall a b. Serializable a => (a -> Process b) -> Match b
456366match = matchIf (const True)
@@ -494,31 +404,18 @@ forward msg them = do
494404 us = processId proc
495405 nid = localNodeId node
496406 destNode = (processNodeId them) in do
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)
407+ case destNode == nid of
408+ True -> sendCtrlMsg Nothing (LocalSend them msg)
409+ False -> liftIO $ sendPayload (processNode proc)
410+ (ProcessIdentifier (processId proc))
411+ (ProcessIdentifier them)
412+ NoImplicitReconnect
413+ (messageToPayload msg)
414+ -- We do not fire the trace event until after the sending is complete;
415+ -- In the remote case, 'sendMessage' can block in the networking stack.
416+ liftIO $ traceEvent (localEventBus node)
417+ (MxSent them us msg)
505418
506−-- | Forward a raw 'Message' to the given 'ProcessId'.
507−--
508−-- Unlike 'forward', this function is insensitive to 'reconnect'. It will
509−-- try to send the message regardless of the history of connection failures
510−-- between the nodes.
511−uforward :: Message -> ProcessId -> Process ()
512−uforward msg them = do
513− proc <- ask
514− let node = processNode proc
515− us = processId proc
516− nid = localNodeId node
517− destNode = (processNodeId them) in do
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
522419
523420-- | Wrap a 'Serializable' value in a 'Message'. Note that 'Message's are
524421-- 'Serializable' - like the datum they contain - but also note, deserialising
@@ -585,11 +482,6 @@ handleMessage :: forall m a b. (Monad m, Serializable a)
585482 => Message -> (a -> m b) -> m (Maybe b)
586483handleMessage msg proc = handleMessageIf msg (const True) proc
587484
588−-- | Conditionally handle a raw 'Message'.
589−-- If the predicate @(a -> Bool)@ evaluates to @True@, invokes the supplied
590−-- handler, other returns @Nothing@ to indicate failure. See 'handleMessage'
591−-- for further information about runtime type checking.
592−--
593485handleMessageIf :: forall m a b . (Monad m, Serializable a)
594486 => Message
595487 -> (a -> Bool)
@@ -612,22 +504,6 @@ handleMessageIf msg c proc = do
612504 decoded :: a -- note [decoding]
613505 !decoded = decode (messageEncoding msg)
614506
615−-- | As 'handleMessage' but ignores result, which is useful if you don't
616−-- care whether or not the handler succeeded.
617−--
618−handleMessage_ :: forall m a . (Monad m, Serializable a)
619− => Message -> (a -> m ()) -> m ()
620−handleMessage_ msg proc = handleMessageIf_ msg (const True) proc
621−
622−-- | Conditional version of 'handleMessage_'.
623−--
624−handleMessageIf_ :: forall m a . (Monad m, Serializable a)
625− => Message
626− -> (a -> Bool)
627− -> (a -> m ())
628− -> m ()
629−handleMessageIf_ msg c proc = handleMessageIf msg c proc >> return ()
630−
631507-- | Match against an arbitrary message. 'matchAny' removes the first available
632508-- message from the process mailbox. To handle arbitrary /raw/ messages once
633509-- removed from the mailbox, see 'handleMessage' and 'unwrapMessage'.
@@ -715,7 +591,7 @@ instance Exception ProcessTerminationException
715591
716592-- | Terminate immediately (throws a ProcessTerminationException)
717593terminate :: Process a
718−terminate = throwM ProcessTerminationException
594+terminate = liftIO $ throwIO ProcessTerminationException
719595
720596-- [Issue #110]
721597-- | Die immediately - throws a 'ProcessExitException' with the given @reason@.
@@ -725,7 +601,7 @@ die reason = do
725601-- could be decoded by a handler passed to 'catchExit', re-thrown or even
726602-- passed to another process via the tracing mechanism.
727603 pid <- getSelfPid
728− throwM (ProcessExitException pid (createMessage reason))
604+ liftIO $ throwIO (ProcessExitException pid (createMessage reason))
729605
730606-- | Forceful request to kill a process. Where 'exit' provides an exception
731607-- that can be caught and handled, 'kill' throws an unexposed exception type
@@ -758,12 +634,12 @@ catchExit :: forall a b . (Show a, Serializable a)
758634 => Process b
759635 -> (ProcessId -> a -> Process b)
760636 -> Process b
761−catchExit act exitHandler = Catch.catch act handleExit
637+catchExit act exitHandler = catch act handleExit
762638 where
763639 handleExit ex@(ProcessExitException from msg) =
764640 if messageFingerprint msg == fingerprint (undefined :: a)
765641 then exitHandler from decoded
766− else throwM ex
642+ else liftIO $ throwIO ex
767643 where
768644 decoded :: a
769645 -- Make sure the value is fully decoded so that we don't hang to
@@ -782,12 +658,12 @@ catchExit act exitHandler = Catch.catch act handleExit
782658catchesExit :: Process b
783659 -> [(ProcessId -> Message -> (Process (Maybe b)))]
784660 -> Process b
785−catchesExit act handlers = Catch.catch act ((flip handleExit) handlers)
661+catchesExit act handlers = catch act ((flip handleExit) handlers)
786662 where
787663 handleExit :: ProcessExitException
788664 -> [(ProcessId -> Message -> Process (Maybe b))]
789665 -> Process b
790− handleExit ex [] = throwM ex
666+ handleExit ex [] = liftIO $ throwIO ex
791667 handleExit ex@(ProcessExitException from msg) (h:hs) = do
792668 r <- h from msg
793669 case r of
@@ -802,31 +678,6 @@ getSelfPid = processId <$> ask
802678getSelfNode :: Process NodeId
803679getSelfNode = localNodeId . processNode <$> ask
804680
805−
806−-- | Get statistics about the specified node
807−getNodeStats :: NodeId -> Process (Either DiedReason NodeStats)
808−getNodeStats nid = do
809− selfNode <- getSelfNode
810− if nid == selfNode
811− then Right `fmap` getLocalNodeStats -- optimisation
812− else getNodeStatsRemote selfNode
813− where
814− getNodeStatsRemote :: NodeId -> Process (Either DiedReason NodeStats)
815− getNodeStatsRemote selfNode = do
816− sendCtrlMsg (Just nid) $ GetNodeStats selfNode
817− bracket (monitorNode nid) unmonitor $ \mRef ->
818− receiveWait [ match (\(stats :: NodeStats) -> return $ Right stats)
819− , matchIf (\(NodeMonitorNotification ref _ _) -> ref == mRef)
820− (\(NodeMonitorNotification _ _ dr) -> return $ Left dr)
821− ]
822−
823−-- | Get statistics about our local node
824−getLocalNodeStats :: Process NodeStats
825−getLocalNodeStats = do
826− self <- getSelfNode
827− sendCtrlMsg Nothing $ GetNodeStats self
828− receiveWait [ match (\(stats :: NodeStats) -> return stats) ]
829−
830681-- | Get information about the specified process
831682getProcessInfo :: ProcessId -> Process (Maybe ProcessInfo)
832683getProcessInfo pid =
@@ -896,19 +747,12 @@ monitor = monitor' . ProcessIdentifier
896747-- @withMonitor@ returns, there might still be unreceived monitor
897748-- messages in the queue.
898749--
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
750+withMonitor :: ProcessId -> Process a -> Process a
751+withMonitor pid code = bracket (monitor pid) unmonitor (\_ -> code)
752+ -- unmonitor blocks waiting for the response, so there's a possibility
753+ -- that an exception might interrupt withMonitor before the unmonitor
754+ -- has completed. I think that's better than making the unmonitor
755+ -- uninterruptible.
912756
913757-- | Remove a link
914758--
@@ -946,21 +790,12 @@ unlinkPort sport = do
946790-- | Remove a monitor
947791--
948792-- This has the same synchronous/asynchronous nature as 'unlink'.
949−--
950−-- ProcessMonitorNotification messages for the given MonitorRef are removed from
951−-- the mailbox.
952793unmonitor :: MonitorRef -> Process ()
953794unmonitor ref = do
954795 unmonitorAsync ref
955796 receiveWait [ matchIf (\(DidUnmonitor ref') -> ref' == ref)
956797 (\_ -> return ())
957798 ]
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− ]
964799
965800--------------------------------------------------------------------------------
966801-- Exception handling --
@@ -968,43 +803,50 @@ unmonitor ref = do
968803
969804-- | Lift 'Control.Exception.catch'
970805catch :: Exception e => Process a -> (e -> Process a) -> Process a
971−catch = Catch.catch
972−{-# DEPRECATED catch "Use Control.Monad.Catch.catch instead" #-}
806+catch p h = do
807+ lproc <- ask
808+ liftIO $ Ex.catch (runLocalProcess lproc p) (runLocalProcess lproc . h)
973809
974810-- | Lift 'Control.Exception.try'
975811try :: Exception e => Process a -> Process (Either e a)
976−try = Catch.try
977−{-# DEPRECATED try "Use Control.Monad.Catch.try instead" #-}
812+try p = do
813+ lproc <- ask
814+ liftIO $ Ex.try (runLocalProcess lproc p)
978815
979816-- | Lift 'Control.Exception.mask'
980817mask :: ((forall a. Process a -> Process a) -> Process b) -> Process b
981−mask = Catch.mask
982−{-# DEPRECATED mask "Use Control.Monad.Catch.mask_ instead" #-}
983−
984−-- | Lift 'Control.Exception.mask_'
985−mask_ :: Process a -> Process a
986−mask_ = Catch.mask_
987−{-# DEPRECATED mask_ "Use Control.Monad.Catch.mask_ instead" #-}
818+mask p = do
819+ lproc <- ask
820+ liftIO $ Ex.mask $ \restore ->
821+ runLocalProcess lproc (p (liftRestore restore))
822+ where
823+ liftRestore :: (forall a. IO a -> IO a)
824+ -> (forall a. Process a -> Process a)
825+ liftRestore restoreIO = \p2 -> do
826+ ourLocalProc <- ask
827+ liftIO $ restoreIO $ runLocalProcess ourLocalProc p2
988828
989829-- | Lift 'Control.Exception.onException'
990830onException :: Process a -> Process b -> Process a
991−onException = Catch.onException
992−{-# DEPRECATED onException "Use Control.Monad.Catch.onException instead" #-}
831+onException p what = p `catch` \e -> do _ <- what
832+ liftIO $ throwIO (e :: SomeException)
993833
994834-- | Lift 'Control.Exception.bracket'
995835bracket :: Process a -> (a -> Process b) -> (a -> Process c) -> Process c
996−bracket = Catch.bracket
997−{-# DEPRECATED bracket "Use Control.Monad.Catch.bracket instead" #-}
836+bracket before after thing =
837+ mask $ \restore -> do
838+ a <- before
839+ r <- restore (thing a) `onException` after a
840+ _ <- after a
841+ return r
998842
999843-- | Lift 'Control.Exception.bracket_'
1000844bracket_ :: Process a -> Process b -> Process c -> Process c
1001−bracket_ = Catch.bracket_
1002−{-# DEPRECATED bracket_ "Use Control.Monad.Catch.bracket_ instead" #-}
845+bracket_ before after thing = bracket before (const after) (const thing)
1003846
1004847-- | Lift 'Control.Exception.finally'
1005848finally :: Process a -> Process b -> Process a
1006−finally = Catch.finally
1007−{-# DEPRECATED finally "Use Control.Monad.Catch.finally instead" #-}
849+finally a sequel = bracket_ (return ()) sequel a
1008850
1009851-- | You need this when using 'catches'
1010852data Handler a = forall e . Exception e => Handler (e -> Process a)
@@ -1014,10 +856,10 @@ instance Functor Handler where
1014856
1015857-- | Lift 'Control.Exception.catches'
1016858catches :: Process a -> [Handler a] -> Process a
1017−catches proc handlers = proc `Catch.catch` catchesHandler handlers
859+catches proc handlers = proc `catch` catchesHandler handlers
1018860
1019861catchesHandler :: [Handler a] -> SomeException -> Process a
1020−catchesHandler handlers e = foldr tryHandler (throwM e) handlers
862+catchesHandler handlers e = foldr tryHandler (throw e) handlers
1021863 where tryHandler (Handler handler) res
1022864 = case fromException e of
1023865 Just e' -> handler e'
@@ -1037,10 +879,7 @@ expectTimeout n = receiveTimeout n [match return]
1037879spawnAsync :: NodeId -> Closure (Process ()) -> Process SpawnRef
1038880spawnAsync nid proc = do
1039881 spawnRef <- getSpawnRef
1040− node <- getSelfNode
1041− if nid == node
1042− then sendCtrlMsg Nothing $ Spawn proc spawnRef
1043− else sendCtrlMsg (Just nid) $ Spawn proc spawnRef
882+ sendCtrlMsg (Just nid) $ Spawn proc spawnRef
1044883 return spawnRef
1045884
1046885-- | Monitor a node (asynchronous)
@@ -1086,60 +925,27 @@ unlinkPortAsync (SendPort cid) =
1086925-- Logging --
1087926--------------------------------------------------------------------------------
1088927
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−
1124928-- | Log a string
1125929--
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.
930+-- @say message@ sends a message (time, pid of the current process, message)
931+-- to the process registered as 'logger'. By default, this process simply
932+-- sends the string to 'stderr'. Individual Cloud Haskell backends might
933+-- replace this with a different logger process, however.
1130934say :: String -> Process ()
1131935say string = do
1132936 now <- liftIO getCurrentTime
1133937 us <- getSelfPid
1134− nsend "logger" (SayMessage now us string)
938+ nsend "logger" (formatTime defaultTimeLocale "%c" now, us, string)
1135939
1136940--------------------------------------------------------------------------------
1137941-- Registry --
1138942--------------------------------------------------------------------------------
1139943
1140−-- | Register a process with the local registry (synchronous). The name must not
1141−-- already be registered. The process need not be on this node. A bad
1142−-- registration will result in a 'ProcessRegistrationException'
944+-- | Register a process with the local registry (asynchronous).
945+-- This version will wait until a response is gotten from the
946+-- management process. The name must not already be registered.
947+-- The process need not be on this node.
948+-- A bad registration will result in a 'ProcessRegistrationException'
1143949--
1144950-- The process to be registered does not have to be local itself.
1145951register :: String -> ProcessId -> Process ()
@@ -1154,10 +960,9 @@ registerImpl :: Bool -> String -> ProcessId -> Process ()
1154960registerImpl force label pid = do
1155961 mynid <- getSelfNode
1156962 sendCtrlMsg Nothing (Register label mynid (Just pid) force)
1157− receiveWait
1158− [ matchIf (\(RegisterReply label' _ _) -> label == label')
1159− (\(RegisterReply _ ok owner) -> handleRegistrationReply label ok owner)
1160− ]
963+ receiveWait [ matchIf (\(RegisterReply label' _) -> label == label')
964+ (\(RegisterReply _ ok) -> handleRegistrationReply label ok)
965+ ]
1161966
1162967-- | Register a process with a remote registry (asynchronous).
1163968--
@@ -1166,10 +971,8 @@ registerImpl force label pid = do
1166971--
1167972-- See comments in 'whereisRemoteAsync'
1168973registerRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
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)
974+registerRemoteAsync nid label pid =
975+ sendCtrlMsg (Just nid) (Register label nid (Just pid) False)
1173976
1174977reregisterRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
1175978reregisterRemoteAsync nid label pid =
@@ -1182,17 +985,16 @@ unregister :: String -> Process ()
1182985unregister label = do
1183986 mynid <- getSelfNode
1184987 sendCtrlMsg Nothing (Register label mynid Nothing False)
1185− receiveWait
1186− [ matchIf (\(RegisterReply label' _ _) -> label == label')
1187− (\(RegisterReply _ ok owner) -> handleRegistrationReply label ok owner)
1188− ]
988+ receiveWait [ matchIf (\(RegisterReply label' _) -> label == label')
989+ (\(RegisterReply _ ok) -> handleRegistrationReply label ok)
990+ ]
1189991
1190992-- | Deal with the result from an attempted registration or unregistration
1191993-- by throwing an exception if necessary
1192−handleRegistrationReply :: String -> Bool -> Maybe ProcessId -> Process ()
1193−handleRegistrationReply label ok owner =
994+handleRegistrationReply :: String -> Bool -> Process ()
995+handleRegistrationReply label ok =
1194996 when (not ok) $
1195− throwM $ ProcessRegistrationException label owner
997+ liftIO $ throwIO $ ProcessRegistrationException label
1196998
1197999-- | Remove a process from a remote registry (asynchronous).
11981000--
@@ -1221,18 +1023,13 @@ whereis label = do
12211023-- use 'monitorNode' and take appropriate action when you receive a
12221024-- 'NodeMonitorNotification').
12231025whereisRemoteAsync :: NodeId -> String -> Process ()
1224−whereisRemoteAsync nid label = do
1225− here <- getSelfNode
1226− sendCtrlMsg (if nid == here then Nothing else Just nid) (WhereIs label)
1026+whereisRemoteAsync nid label =
1027+ sendCtrlMsg (Just nid) (WhereIs label)
12271028
12281029-- | Named send to a process in the local registry (asynchronous)
12291030nsend :: Serializable a => String -> a -> Process ()
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')
1031+nsend label msg =
1032+ sendCtrlMsg Nothing (NamedSend label (createUnencodedMessage msg))
12361033
12371034-- | Named send to a process in the local registry (asynchronous).
12381035-- This function makes /no/ attempt to serialize and (in the case when the
@@ -1243,23 +1040,8 @@ unsafeNSend = Unsafe.nsend
12431040
12441041-- | Named send to a process in a remote registry (asynchronous)
12451042nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
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
1043+nsendRemote nid label msg =
1044+ sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
12631045
12641046--------------------------------------------------------------------------------
12651047-- Closures --
src/Control/Distributed/Process/Internal/Spawn.hs+10−14
@@ -1,4 +1,3 @@
1−{-# LANGUAGE RankNTypes #-}
21module Control.Distributed.Process.Internal.Spawn
32 ( spawn
43 , spawnLink
@@ -37,13 +36,11 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
3736 , cpLink
3837 , cpSend
3938 , cpNewChan
40− , cpDelayed
41− , returnCP
42− , sdictUnit
39+ , cpDelay
4340 )
4441import Control.Distributed.Process.Internal.Primitives
4542 ( -- Basic messaging
46− usend
43+ send
4744 , expect
4845 , receiveWait
4946 , match
@@ -67,11 +64,11 @@ spawn :: NodeId -> Closure (Process ()) -> Process ProcessId
6764spawn nid proc = do
6865 us <- getSelfPid
6966 mRef <- monitorNode nid
70− sRef <- spawnAsync nid (cpDelayed us proc)
67+ sRef <- spawnAsync nid (cpDelay us proc)
7168 receiveWait [
7269 matchIf (\(DidSpawn ref _) -> ref == sRef) $ \(DidSpawn _ pid) -> do
7370 unmonitor mRef
74− usend pid ()
71+ send pid ()
7572 return pid
7673 , matchIf (\(NodeMonitorNotification ref _ _) -> ref == mRef) $ \_ ->
7774 return (nullProcessId nid)
@@ -111,14 +108,12 @@ call :: Serializable a
111108 -> Process a
112109call dict nid proc = do
113110 us <- getSelfPid
114− (pid, mRef) <- spawnMonitor nid (proc `bindCP`
115− cpSend dict us `seqCP`
116− -- Delay so the process does not terminate
117− -- before the response arrives.
118− cpDelayed us (returnCP sdictUnit ())
119− )
111+ (pid, mRef) <- spawnMonitor nid (proc `bindCP` cpSend dict us)
112+ -- We are guaranteed to receive the reply before the monitor notification
113+ -- (if a reply is sent at all)
114+ -- NOTE: This might not be true if we switch to unreliable delivery.
120115 mResult <- receiveWait
121− [ match $ \a -> usend pid () >> return (Right a)
116+ [ match (return . Right)
122117 , matchIf (\(ProcessMonitorNotification ref _ _) -> ref == mRef)
123118 (\(ProcessMonitorNotification _ _ reason) -> return (Left reason))
124119 ]
@@ -163,3 +158,4 @@ spawnChannel dict nid proc = do
163158 (cpSend (sdictSendPort dict) pid `splitCP` proc)
164159 `bindCP`
165160 (idCP `closureCompose` staticClosure sndStatic)
161+
src/Control/Distributed/Process/Internal/StrictMVar.hs+5−37
@@ -1,43 +1,33 @@
11-- | Like Control.Concurrent.MVar.Strict but reduce to HNF, not NF
2−{-# LANGUAGE CPP, MagicHash, UnboxedTuples #-}
2+{-# LANGUAGE MagicHash, UnboxedTuples #-}
33module Control.Distributed.Process.Internal.StrictMVar
44 ( StrictMVar(StrictMVar)
55 , newEmptyMVar
66 , newMVar
77 , takeMVar
88 , putMVar
9− , readMVar
109 , withMVar
1110 , modifyMVar_
1211 , modifyMVar
13− , modifyMVarMasked
1412 , mkWeakMVar
1513 ) where
1614
1715import Control.Applicative ((<$>))
1816import Control.Monad ((>=>))
19−#if MIN_VERSION_base(4,6,0)
2017import Control.Exception (evaluate)
21−#else
22−import Control.Exception (evaluate, mask_, onException)
23−#endif
2418import qualified Control.Concurrent.MVar as MVar
2519 ( MVar
2620 , newEmptyMVar
2721 , newMVar
2822 , takeMVar
2923 , putMVar
30− , readMVar
3124 , withMVar
3225 , modifyMVar_
3326 , modifyMVar
34−#if MIN_VERSION_base(4,6,0)
35− , modifyMVarMasked
36−#endif
3727 )
3828import GHC.MVar (MVar(MVar))
39−import GHC.IO (IO(IO), unIO)
40−import GHC.Exts (mkWeak#)
29+import GHC.IO (IO(IO))
30+import GHC.Prim (mkWeak#)
4131import GHC.Weak (Weak(Weak))
4232
4333newtype StrictMVar a = StrictMVar (MVar.MVar a)
@@ -54,9 +44,6 @@ takeMVar (StrictMVar v) = MVar.takeMVar v
5444putMVar :: StrictMVar a -> a -> IO ()
5545putMVar (StrictMVar v) x = evaluate x >> MVar.putMVar v x
5646
57−readMVar :: StrictMVar a -> IO a
58−readMVar (StrictMVar v) = MVar.readMVar v
59−
6047withMVar :: StrictMVar a -> (a -> IO b) -> IO b
6148withMVar (StrictMVar v) = MVar.withMVar v
6249
@@ -69,25 +56,6 @@ modifyMVar (StrictMVar v) f = MVar.modifyMVar v (f >=> evaluateFst)
6956 evaluateFst :: (a, b) -> IO (a, b)
7057 evaluateFst (x, y) = evaluate x >> return (x, y)
7158
72−modifyMVarMasked :: StrictMVar a -> (a -> IO (a, b)) -> IO b
73−modifyMVarMasked (StrictMVar v) f =
74−#if MIN_VERSION_base(4,6,0)
75− MVar.modifyMVarMasked v (f >=> evaluateFst)
76−#else
77− mask_ $ do
78− a <- MVar.takeMVar v
79− (a',b) <- (f a >>= evaluate) `onException` MVar.putMVar v a
80− MVar.putMVar v a'
81− return b
82−#endif
83− where
84− evaluateFst :: (a, b) -> IO (a, b)
85− evaluateFst (x, y) = evaluate x >> return (x, y)
86−
8759mkWeakMVar :: StrictMVar a -> IO () -> IO (Weak (StrictMVar a))
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
60+mkWeakMVar m@(StrictMVar (MVar m#)) f = IO $ \s ->
61+ case mkWeak# m# m f s of (# s1, w #) -> (# s1, Weak w #)
src/Control/Distributed/Process/Internal/Types.hs+33−181
@@ -1,12 +1,4 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE ExistentialQuantification #-}
3−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4−{-# LANGUAGE GADTs #-}
51{-# LANGUAGE DeriveGeneric #-}
6−{-# LANGUAGE CPP #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE TypeFamilies #-}
9−{-# LANGUAGE Rank2Types #-}
102
113-- | Types used throughout the Cloud Haskell framework
124--
@@ -24,14 +16,9 @@ module Control.Distributed.Process.Internal.Types
2416 , nullProcessId
2517 -- * Local nodes and processes
2618 , LocalNode(..)
27− , LocalNodeState(..)
28− , ValidLocalNodeState(..)
29− , NodeClosedException(..)
30− , withValidLocalState
31− , modifyValidLocalState
32− , modifyValidLocalState_
3319 , Tracer(..)
3420 , MxEventBus(..)
21+ , LocalNodeState(..)
3522 , LocalProcess(..)
3623 , LocalProcessState(..)
3724 , Process(..)
@@ -72,7 +59,6 @@ module Control.Distributed.Process.Internal.Types
7259 , RegisterReply(..)
7360 , ProcessInfo(..)
7461 , ProcessInfoNone(..)
75− , NodeStats(..)
7662 -- * Node controller internal data types
7763 , NCMsg(..)
7864 , ProcessSignal(..)
@@ -95,7 +81,6 @@ module Control.Distributed.Process.Internal.Types
9581import System.Mem.Weak (Weak)
9682import Data.Map (Map)
9783import Data.Int (Int32)
98−import Data.Data (Data)
9984import Data.Typeable (Typeable, typeOf)
10085import Data.Binary (Binary(put, get), putWord8, getWord8, encode)
10186import qualified Data.ByteString as BSS (ByteString, concat, copy)
@@ -110,17 +95,15 @@ import qualified Data.ByteString.Lazy.Internal as BSL (ByteString(..))
11095import Data.Accessor (Accessor, accessor)
11196import Control.Category ((>>>))
11297import Control.DeepSeq (NFData(..))
113−import Control.Exception (Exception, throwIO)
98+import Control.Exception (Exception)
11499import Control.Concurrent (ThreadId)
115100import Control.Concurrent.Chan (Chan)
116101import Control.Concurrent.STM (STM)
117102import Control.Concurrent.STM.TChan (TChan)
118−import Control.Monad.Catch (MonadThrow(..), MonadCatch(..), MonadMask(..))
119103import qualified Network.Transport as NT (EndPoint, EndPointAddress, Connection)
120−import Control.Applicative
121−import Control.Monad.Fix (MonadFix)
104+import Control.Applicative (Applicative, Alternative, (<$>), (<*>))
122105import Control.Monad.Reader (MonadReader(..), ReaderT, runReaderT)
123−import Control.Monad.IO.Class (MonadIO(..))
106+import Control.Monad.IO.Class (MonadIO)
124107import Control.Distributed.Process.Serializable
125108 ( Fingerprint
126109 , Serializable
@@ -131,19 +114,13 @@ import Control.Distributed.Process.Serializable
131114 , showFingerprint
132115 )
133116import Control.Distributed.Process.Internal.CQueue (CQueue)
134−import Control.Distributed.Process.Internal.StrictMVar
135− ( StrictMVar
136− , withMVar
137− , modifyMVar
138− , modifyMVar_
139− )
117+import Control.Distributed.Process.Internal.StrictMVar (StrictMVar)
140118import Control.Distributed.Process.Internal.WeakTQueue (TQueue)
141119import Control.Distributed.Static (RemoteTable, Closure)
142120import qualified Control.Distributed.Process.Internal.StrictContainerAccessors as DAC (mapMaybe)
143121
144122import Data.Hashable
145123import GHC.Generics
146−import Prelude
147124
148125--------------------------------------------------------------------------------
149126-- Node and process identifiers --
@@ -151,9 +128,9 @@ import Prelude
151128
152129-- | Node identifier
153130newtype NodeId = NodeId { nodeAddress :: NT.EndPointAddress }
154− deriving (Eq, Ord, Typeable, Data, Generic)
131+ deriving (Eq, Ord, Typeable, Generic)
155132instance Binary NodeId where
156−instance NFData NodeId where rnf (NodeId a) = rnf a `seq` ()
133+instance NFData NodeId
157134instance Hashable NodeId where
158135instance Show NodeId where
159136 show (NodeId addr) = "nid://" ++ show addr
@@ -164,7 +141,7 @@ data LocalProcessId = LocalProcessId
164141 { lpidUnique :: {-# UNPACK #-} !Int32
165142 , lpidCounter :: {-# UNPACK #-} !Int32
166143 }
167− deriving (Eq, Ord, Typeable, Data, Generic, Show)
144+ deriving (Eq, Ord, Typeable, Generic, Show)
168145
169146instance Hashable LocalProcessId where
170147
@@ -175,10 +152,10 @@ data ProcessId = ProcessId
175152 -- | Node-local identifier for the process
176153 , processLocalId :: {-# UNPACK #-} !LocalProcessId
177154 }
178− deriving (Eq, Ord, Typeable, Data, Generic)
155+ deriving (Eq, Ord, Typeable, Generic)
179156
180157instance Binary ProcessId where
181−instance NFData ProcessId where rnf (ProcessId n _) = rnf n `seq` ()
158+instance NFData ProcessId where
182159instance Hashable ProcessId where
183160
184161instance Show ProcessId where
@@ -193,10 +170,6 @@ data Identifier =
193170 deriving (Eq, Ord, Generic)
194171
195172instance Hashable Identifier where
196−instance NFData Identifier where
197− rnf (NodeIdentifier n) = rnf n `seq` ()
198− rnf (ProcessIdentifier n) = rnf n `seq` ()
199− rnf n@SendPortIdentifier{} = n `seq` ()
200173
201174instance Show Identifier where
202175 show (NodeIdentifier nid) = show nid
@@ -273,11 +246,7 @@ data ImplicitReconnect = WithImplicitReconnect | NoImplicitReconnect
273246 deriving (Eq, Show)
274247
275248-- | Local node state
276−data LocalNodeState =
277− LocalNodeValid {-# UNPACK #-} !ValidLocalNodeState
278− | LocalNodeClosed
279−
280−data ValidLocalNodeState = ValidLocalNodeState
249+data LocalNodeState = LocalNodeState
281250 { -- | Processes running on this node
282251 _localProcesses :: !(Map LocalProcessId LocalProcess)
283252 -- | Counter to assign PIDs
@@ -290,40 +259,6 @@ data ValidLocalNodeState = ValidLocalNodeState
290259 (NT.Connection, ImplicitReconnect))
291260 }
292261
293−-- | Thrown by some primitives when they notice the node has been closed.
294−data NodeClosedException = NodeClosedException NodeId
295− deriving (Show, Typeable)
296−
297−instance Exception NodeClosedException
298−
299−-- | Wrapper around 'withMVar' that checks that the local node is still in
300−-- a valid state.
301−withValidLocalState :: LocalNode
302− -> (ValidLocalNodeState -> IO r)
303− -> IO r
304−withValidLocalState node f = withMVar (localState node) $ \st -> case st of
305− LocalNodeValid vst -> f vst
306− LocalNodeClosed -> throwIO $ NodeClosedException (localNodeId node)
307−
308−-- | Wrapper around 'modifyMVar' that checks that the local node is still in
309−-- a valid state.
310−modifyValidLocalState :: LocalNode
311− -> (ValidLocalNodeState -> IO (ValidLocalNodeState, a))
312− -> IO (Maybe a)
313−modifyValidLocalState node f = modifyMVar (localState node) $ \st -> case st of
314− LocalNodeValid vst -> do (vst', a) <- f vst
315− return (LocalNodeValid vst', Just a)
316− LocalNodeClosed -> return (LocalNodeClosed, Nothing)
317−
318−-- | Wrapper around 'modifyMVar_' that checks that the local node is still in
319−-- a valid state.
320−modifyValidLocalState_ :: LocalNode
321− -> (ValidLocalNodeState -> IO ValidLocalNodeState)
322− -> IO ()
323−modifyValidLocalState_ node f = modifyMVar_ (localState node) $ \st -> case st of
324− LocalNodeValid vst -> LocalNodeValid <$> f vst
325− LocalNodeClosed -> return LocalNodeClosed
326−
327262-- | Processes running on our local node
328263data LocalProcess = LocalProcess
329264 { processQueue :: !(CQueue Message)
@@ -350,50 +285,7 @@ data LocalProcessState = LocalProcessState
350285newtype Process a = Process {
351286 unProcess :: ReaderT LocalProcess IO a
352287 }
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
288+ deriving (Functor, Monad, MonadIO, MonadReader LocalProcess, Typeable, Applicative)
397289
398290--------------------------------------------------------------------------------
399291-- Typed channels --
@@ -418,9 +310,6 @@ instance Show SendPortId where
418310 show (SendPortId (ProcessId (NodeId addr) (LocalProcessId _ plid)) clid)
419311 = "cid://" ++ show addr ++ ":" ++ show plid ++ ":" ++ show clid
420312
421−instance NFData SendPortId where
422− rnf (SendPortId p _) = rnf p `seq` ()
423−
424313data TypedChannel = forall a. Serializable a => TypedChannel (Weak (TQueue a))
425314
426315-- | The send send of a typed channel (serializable)
@@ -432,7 +321,7 @@ newtype SendPort a = SendPort {
432321
433322instance (Serializable a) => Binary (SendPort a) where
434323instance (Hashable a) => Hashable (SendPort a) where
435−instance (NFData a) => NFData (SendPort a) where rnf (SendPort x) = x `seq` ()
324+instance (NFData a) => NFData (SendPort a) where
436325
437326-- | The receive end of a typed channel (not serializable)
438327--
@@ -470,15 +359,6 @@ data Message =
470359 }
471360 deriving (Typeable)
472361
473−instance NFData Message where
474−#if MIN_VERSION_bytestring(0,10,0)
475− rnf (EncodedMessage _ e) = rnf e `seq` ()
476−#else
477− rnf (EncodedMessage _ e) = BSL.length e `seq` ()
478−#endif
479− rnf (UnencodedMessage _ a) = e `seq` ()
480− where e = BSL.length (encode a)
481−
482362instance Show Message where
483363 show (EncodedMessage fp enc) = show enc ++ " :: " ++ showFingerprint fp []
484364 show (UnencodedMessage _ uenc) = "[unencoded message] :: " ++ (show $ typeOf uenc)
@@ -505,7 +385,7 @@ createUnencodedMessage a =
505385 let encoded = encode a in BSL.length encoded `seq` UnencodedMessage (fingerprint a) a
506386
507387-- | Turn any serializable term into an unencodede/local message, without
508−-- evalutaing it! This is a dangerous business.
388+-- evalutaing it!
509389unsafeCreateUnencodedMessage :: Serializable a => a -> Message
510390unsafeCreateUnencodedMessage a = UnencodedMessage (fingerprint a) a
511391
@@ -541,11 +421,8 @@ data MonitorRef = MonitorRef
541421 -- | Unique to distinguish multiple monitor requests by the same process
542422 , monitorRefCounter :: !Int32
543423 }
544− deriving (Eq, Ord, Show, Typeable, Generic)
545−instance Hashable MonitorRef
546−
547−instance NFData MonitorRef where
548− rnf (MonitorRef i _) = rnf i `seq` ()
424+ deriving (Eq, Ord, Show, Generic)
425+instance Hashable MonitorRef where
549426
550427-- | Message sent by process monitors
551428data ProcessMonitorNotification =
@@ -579,11 +456,9 @@ data PortLinkException =
579456
580457-- | Exception thrown when a process attempts to register
581458-- a process under an already-registered name or to
582−-- unregister a name that hasn't been registered. Returns
583−-- the name and the identifier of the process that owns it,
584−-- if any.
459+-- unregister a name that hasn't been registered
585460data ProcessRegistrationException =
586− ProcessRegistrationException !String !(Maybe ProcessId)
461+ ProcessRegistrationException !String
587462 deriving (Typeable, Show)
588463
589464-- | Internal exception thrown indirectly by 'exit'
@@ -615,10 +490,6 @@ data DiedReason =
615490 | DiedUnknownId
616491 deriving (Show, Eq)
617492
618−instance NFData DiedReason where
619− rnf (DiedException s) = rnf s `seq` ()
620− rnf x = x `seq` ()
621−
622493-- | (Asynchronous) reply from unmonitor
623494newtype DidUnmonitor = DidUnmonitor MonitorRef
624495 deriving (Typeable, Binary)
@@ -637,7 +508,7 @@ newtype DidUnlinkPort = DidUnlinkPort SendPortId
637508
638509-- | 'SpawnRef' are used to return pids of spawned processes
639510newtype SpawnRef = SpawnRef Int32
640− deriving (Show, Binary, Typeable, Eq, Ord)
511+ deriving (Show, Binary, Typeable, Eq)
641512
642513-- | (Asynchronius) reply from 'spawn'
643514data DidSpawn = DidSpawn SpawnRef ProcessId
@@ -648,23 +519,14 @@ data WhereIsReply = WhereIsReply String (Maybe ProcessId)
648519 deriving (Show, Typeable)
649520
650521-- | (Asynchronous) reply from 'register' and 'unregister'
651−data RegisterReply = RegisterReply String Bool (Maybe ProcessId)
522+data RegisterReply = RegisterReply String Bool
652523 deriving (Show, Typeable)
653524
654−data NodeStats = NodeStats {
655− nodeStatsNode :: NodeId
656− , nodeStatsRegisteredNames :: Int
657− , nodeStatsMonitors :: Int
658− , nodeStatsLinks :: Int
659− , nodeStatsProcesses :: Int
660− }
661− deriving (Show, Eq, Typeable)
662−
663525-- | Provide information about a running process
664526data ProcessInfo = ProcessInfo {
665527 infoNode :: NodeId
666528 , infoRegisteredNames :: [String]
667− , infoMessageQueueLength :: Int
529+ , infoMessageQueueLength :: Maybe Int
668530 , infoMonitors :: [(ProcessId, MonitorRef)]
669531 , infoLinks :: [ProcessId]
670532 } deriving (Show, Eq, Typeable)
@@ -694,14 +556,12 @@ data ProcessSignal =
694556 | WhereIs !String
695557 | Register !String !NodeId !(Maybe ProcessId) !Bool -- Use 'Nothing' to unregister, use True to force reregister
696558 | NamedSend !String !Message
697− | UnreliableSend !LocalProcessId !Message
698559 | LocalSend !ProcessId !Message
699560 | LocalPortSend !SendPortId !Message
700561 | Kill !ProcessId !String
701562 | Exit !ProcessId !Message
702563 | GetInfo !ProcessId
703564 | SigShutdown
704− | GetNodeStats !NodeId
705565 deriving Show
706566
707567--------------------------------------------------------------------------------
@@ -750,10 +610,8 @@ instance Binary ProcessSignal where
750610 put (Exit pid reason) = putWord8 10 >> put pid >> put (messageToPayload reason)
751611 put (LocalSend to' msg) = putWord8 11 >> put to' >> put (messageToPayload msg)
752612 put (LocalPortSend sid msg) = putWord8 12 >> put sid >> put (messageToPayload msg)
753− put (UnreliableSend lpid msg) = putWord8 13 >> put lpid >> put (messageToPayload msg)
754613 put (GetInfo about) = putWord8 30 >> put about
755614 put (SigShutdown) = putWord8 31
756− put (GetNodeStats nid) = putWord8 32 >> put nid
757615 get = do
758616 header <- getWord8
759617 case header of
@@ -770,10 +628,8 @@ instance Binary ProcessSignal where
770628 10 -> Exit <$> get <*> (payloadToMessage <$> get)
771629 11 -> LocalSend <$> get <*> (payloadToMessage <$> get)
772630 12 -> LocalPortSend <$> get <*> (payloadToMessage <$> get)
773− 13 -> UnreliableSend <$> get <*> (payloadToMessage <$> get)
774631 30 -> GetInfo <$> get
775632 31 -> return SigShutdown
776− 32 -> GetNodeStats <$> get
777633 _ -> fail "ProcessSignal.get: invalid"
778634
779635instance Binary DiedReason where
@@ -800,6 +656,9 @@ instance Binary SendPortId where
800656 put cid = put (sendPortProcessId cid) >> put (sendPortLocalId cid)
801657 get = SendPortId <$> get <*> get
802658
659+instance NFData SendPortId where
660+ rnf cid = (sendPortProcessId cid) `seq` (sendPortLocalId cid) `seq` ()
661+
803662instance Binary Identifier where
804663 put (ProcessIdentifier pid) = putWord8 0 >> put pid
805664 put (NodeIdentifier nid) = putWord8 1 >> put nid
@@ -817,8 +676,8 @@ instance Binary WhereIsReply where
817676 get = WhereIsReply <$> get <*> get
818677
819678instance Binary RegisterReply where
820− put (RegisterReply label ok owner) = put label >> put ok >> put owner
821− get = RegisterReply <$> get <*> get <*> get
679+ put (RegisterReply label ok) = put label >> put ok
680+ get = RegisterReply <$> get <*> get
822681
823682instance Binary ProcessInfo where
824683 get = ProcessInfo <$> get <*> get <*> get <*> get <*> get
@@ -828,14 +687,6 @@ instance Binary ProcessInfo where
828687 >> put (infoMonitors pInfo)
829688 >> put (infoLinks pInfo)
830689
831−instance Binary NodeStats where
832− get = NodeStats <$> get <*> get <*> get <*> get <*> get
833− put nStats = put (nodeStatsNode nStats)
834− >> put (nodeStatsRegisteredNames nStats)
835− >> put (nodeStatsMonitors nStats)
836− >> put (nodeStatsLinks nStats)
837− >> put (nodeStatsProcesses nStats)
838−
839690instance Binary ProcessInfoNone where
840691 get = ProcessInfoNone <$> get
841692 put (ProcessInfoNone r) = put r
@@ -844,22 +695,22 @@ instance Binary ProcessInfoNone where
844695-- Accessors --
845696--------------------------------------------------------------------------------
846697
847−localProcesses :: Accessor ValidLocalNodeState (Map LocalProcessId LocalProcess)
698+localProcesses :: Accessor LocalNodeState (Map LocalProcessId LocalProcess)
848699localProcesses = accessor _localProcesses (\procs st -> st { _localProcesses = procs })
849700
850−localPidCounter :: Accessor ValidLocalNodeState Int32
701+localPidCounter :: Accessor LocalNodeState Int32
851702localPidCounter = accessor _localPidCounter (\ctr st -> st { _localPidCounter = ctr })
852703
853−localPidUnique :: Accessor ValidLocalNodeState Int32
704+localPidUnique :: Accessor LocalNodeState Int32
854705localPidUnique = accessor _localPidUnique (\unq st -> st { _localPidUnique = unq })
855706
856−localConnections :: Accessor ValidLocalNodeState (Map (Identifier, Identifier) (NT.Connection, ImplicitReconnect))
707+localConnections :: Accessor LocalNodeState (Map (Identifier, Identifier) (NT.Connection, ImplicitReconnect))
857708localConnections = accessor _localConnections (\conns st -> st { _localConnections = conns })
858709
859−localProcessWithId :: LocalProcessId -> Accessor ValidLocalNodeState (Maybe LocalProcess)
710+localProcessWithId :: LocalProcessId -> Accessor LocalNodeState (Maybe LocalProcess)
860711localProcessWithId lpid = localProcesses >>> DAC.mapMaybe lpid
861712
862−localConnectionBetween :: Identifier -> Identifier -> Accessor ValidLocalNodeState (Maybe (NT.Connection, ImplicitReconnect))
713+localConnectionBetween :: Identifier -> Identifier -> Accessor LocalNodeState (Maybe (NT.Connection, ImplicitReconnect))
863714localConnectionBetween from' to' = localConnections >>> DAC.mapMaybe (from', to')
864715
865716monitorCounter :: Accessor LocalProcessState Int32
@@ -885,3 +736,4 @@ typedChannelWithId cid = typedChannels >>> DAC.mapMaybe cid
885736{-# INLINE forever' #-}
886737forever' :: Monad m => m a -> m b
887738forever' a = let a' = a >> a' in a'
739+
src/Control/Distributed/Process/Internal/WeakTQueue.hs+3−9
@@ -1,12 +1,10 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE MagicHash, UnboxedTuples #-}
41-- | Clone of Control.Concurrent.STM.TQueue with support for mkWeakTQueue
52--
63-- Not all functionality from the original module is available: unGetTQueue,
74-- peekTQueue and tryPeekTQueue are missing. In order to implement these we'd
85-- need to be able to touch# the write end of the queue inside unGetTQueue, but
96-- that means we need a version of touch# that works within the STM monad.
7+{-# LANGUAGE MagicHash, UnboxedTuples #-}
108module Control.Distributed.Process.Internal.WeakTQueue (
119 -- * Original functionality
1210 TQueue,
@@ -23,8 +21,8 @@ module Control.Distributed.Process.Internal.WeakTQueue (
2321import Prelude hiding (read)
2422import GHC.Conc
2523import Data.Typeable (Typeable)
26−import GHC.IO (IO(IO), unIO)
27−import GHC.Exts (mkWeak#)
24+import GHC.IO (IO(IO))
25+import GHC.Prim (mkWeak#)
2826import GHC.Weak (Weak(Weak))
2927
3028--------------------------------------------------------------------------------
@@ -100,8 +98,4 @@ isEmptyTQueue (TQueue read write) = do
10098
10199mkWeakTQueue :: TQueue a -> IO () -> IO (Weak (TQueue a))
102100mkWeakTQueue 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
106101 case mkWeak# write# q f s of (# s', w #) -> (# s', Weak w #)
107−#endif
src/Control/Distributed/Process/Management.hs+92−352
@@ -4,7 +4,6 @@
44{-# LANGUAGE ExistentialQuantification #-}
55{-# LANGUAGE ScopedTypeVariables #-}
66{-# LANGUAGE RecordWildCards #-}
7−{-# LANGUAGE PatternGuards #-}
87{-# LANGUAGE FlexibleInstances #-}
98{-# LANGUAGE UndecidableInstances #-}
109
@@ -18,234 +17,24 @@
1817-- Stability : experimental
1918-- Portability : non-portable (requires concurrency)
2019--
21−-- [Management Extensions API]
20+-- /Management Extensions/ for Cloud Haskell.
2221--
23−-- This module presents an API for creating /Management Agents/:
24−-- special processes that are capable of receiving and responding to
25−-- a node's internal system events. These /system events/ are delivered by
26−-- the management event bus: An internal subsystem maintained for each
27−-- running node, to which all agents are automatically subscribed.
28−--
29−-- /Agents/ are defined in terms of /event sinks/, taking a particular
30−-- @Serializable@ type and evaluating to an action in the 'MxAgent' monad in
31−-- response. Each 'MxSink' evaluates to an 'MxAction' that specifies whether
32−-- the agent should continue processing it's inputs or stop. If the type of a
33−-- message cannot be matched to any of the agent's sinks, it will be discarded.
34−-- A sink can also deliberately skip processing a message, deferring to the
35−-- remaining handlers. This is the /only/ way that more than one event sink
36−-- can handle the same data type, since otherwise the first /type match/ will
37−-- /win/ every time a message arrives. See 'mxSkip' for details.
38−--
39−-- Various events are published to the management event bus automatically,
40−-- the full list of which can be found in the definition of the 'MxEvent' data
41−-- type. Additionally, clients of the /Management API/ can publish arbitrary
42−-- @Serializable@ data to the event bus using 'mxNotify'. All running agents
43−-- receive all events (from the primary event bus to which they're subscribed).
44−--
45−-- Agent processes are automatically registered on the local node, and can
46−-- receive messages via their mailbox just like ordinary processes. Unlike
47−-- ordinary @Process@ code however, it is unnecessary (though possible) for
48−-- agents to use the base @expect@ and @receiveX@ primitives to do this, since
49−-- the management infrastructure will continuously read from both the primary
50−-- event bus /and/ the process' own mailbox. Messages are transparently passed
51−-- to the agent's event sinks from both sources, so an agent need only concern
52−-- itself with how to respond to its inputs.
53−--
54−-- Some agents may wish to prioritise messages from their mailbox over traffic
55−-- on the management event bus, or vice versa. The 'mxReceive' and
56−-- 'mxReceiveChan' API calls do this for the mailbox and event bus,
57−-- respectively. The /prioritisation/ these APIs offer is simply that the chosen
58−-- data stream will be checked first. No blocking will occur if the chosen
59−-- (prioritised) source is devoid of input messages, instead the agent handling
60−-- code will revert to switching between the alternatives in /round-robin/ as
61−-- usual. If messages exist in one or more channels, they will be consumed as
62−-- soon as they're available, priority is effectively a hint about which
63−-- channel to consume from, should messages be available in both.
64−--
65−-- Prioritisation then, is a /hint/ about the preference of data source from
66−-- which the next input should be chosen. No guarantee can be made that the
67−-- chosen source will in fact be selected at runtime.
68−--
69−-- [Management API Semantics]
70−--
71−-- The management API provides /no guarantees whatsoever/, viz:
72−--
73−-- * The ordering of messages delivered to the event bus.
74−--
75−-- * The order in which agents will be executed.
76−--
77−-- * Whether messages will be taken from the mailbox first, or the event bus.
78−--
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−--
113−-- [Management Data API]
114−--
115−-- Both management agents and clients of the API have access to a variety of
116−-- data storage capabilities, to facilitate publishing and consuming useful
117−-- system information. Agents maintain their own internal state privately (via a
118−-- state transformer - see 'mxGetLocal' et al), however it is possible for
119−-- agents to share additional data with each other (and the outside world)
120−-- using whatever mechanism the user wishes, e.g., acidstate, or shared memory
121−-- primitives.
122−--
123−-- [Defining Agents]
124−--
125−-- New agents are defined with 'mxAgent' and require a unique 'MxAgentId', an
126−-- initial state - 'MxAgent' runs in a state transformer - and a list of the
127−-- agent's event sinks. Each 'MxSink' is defined in terms of a specific
128−-- @Serializable@ type, via the 'mxSink' function, binding the event handler
129−-- expression to inputs of only that type.
130−--
131−-- Apart from modifying its own local state, an agent can execute arbitrary
132−-- @Process a@ code via lifting (see 'liftMX') and even publish its own messages
133−-- back to the primary event bus (see 'mxBroadcast').
134−--
135−-- Since messages are delivered to agents from both the management event bus and
136−-- the agent processes mailbox, agents (i.e., event sinks) will generally have
137−-- no idea as to their origin. An agent can, however, choose to prioritise the
138−-- choice of input (source) each time one of its event sinks runs. The /standard/
139−-- way for an event sink to indicate that the agent is ready for its next input
140−-- is to evaluate 'mxReady'. When this happens, the management infrastructure
141−-- will obtain data from the event bus and process' mailbox in a round robbin
142−-- fashion, i.e., one after the other, changing each time.
143−--
144−-- [Example Code]
145−--
146−-- What follows is a grossly over-simplified example of a management agent that
147−-- provides a basic name monitoring facility. Whenever a process name is
148−-- registered or unregistered, clients are informed of the fact.
149−--
150−-- > -- simple notification data type
151−-- >
152−-- > data Registration = Reg { added :: Bool
153−-- > , procId :: ProcessId
154−-- > , name :: String
155−-- > }
156−-- >
157−-- > -- start a /name monitoring agent/
158−-- > nameMonitorAgent = do
159−-- > mxAgent (MxAgentId "name-monitor") Set.empty [
160−-- > (mxSink $ \(pid :: ProcessId) -> do
161−-- > mxUpdateState $ Set.insert pid
162−-- > mxReady)
163−-- > , (mxSink $
164−-- > let act =
165−-- > case ev of
166−-- > (MxRegistered p n) -> notify True n p
167−-- > (MxUnRegistered p n) -> notify False n p
168−-- > _ -> return ()
169−-- > act >> mxReady)
170−-- > ]
171−-- > where
172−-- > notify a n p = do
173−-- > Foldable.mapM_ (liftMX . deliver (Reg a n p)) =<< mxGetLocal
174−-- >
175−--
176−-- The client interface (for sending their pid) can take one of two forms:
177−--
178−-- > monitorNames = getSelfPid >>= nsend "name-monitor"
179−-- > monitorNames2 = getSelfPid >>= mxNotify
180−--
181−-- [Performance, Stablity and Scalability]
182−--
183−-- /Management Agents/ offer numerous advantages over regular processes:
184−-- broadcast communication with them can have a lower latency, they offer
185−-- simplified messgage (i.e., input type) handling and they have access to
186−-- internal system information that would be otherwise unobtainable.
187−--
188−-- Do not be tempted to implement everything (e.g., the kitchen sink) using the
189−-- management API though. There are overheads associated with management agents
190−-- which is why they're presented as tools for consuming low level system
191−-- information, instead of as /application level/ development tools.
192−--
193−-- Agents that rely heavily on a busy mailbox can cause the management event
194−-- bus to backlog un-GC'ed data, leading to increased heap space. Producers that
195−-- do not take care to avoid passing unevaluated thunks to the API can crash
196−-- /all/ the agents in the system. Agents are not monitored or managed in any
197−-- way, and those that crash will not be restarted.
198−--
199−-- The management event bus can receive a great deal of traffic. Every time
200−-- a message is sent and/or received, an event is passed to the agent controller
201−-- and broadcast to all agents (plus the trace controller, if tracing is enabled
202−-- for the node). This is already a significant overhead - though profiling and
203−-- benchmarks have demonstrated that it does not adversely affect performance
204−-- if few agents are installed. Agents will typically use more cycles than plain
205−-- processes, since they perform additional work: selecting input data from both
206−-- the event bus /and/ their own mailboxes, plus searching through the set of
207−-- event sinks (for each agent) to determine the right handler for the event.
22+-- This module provides a standard API for receiving and/or responding to
23+-- system events in a Cloud Haskell node.
20824--
20925-- [Architecture Overview]
21026--
211−-- The architecture of the management event bus is internal and subject to
212−-- change without prior notice. The description that follows is provided for
213−-- informational purposes only.
27+-- /Management Extensions/ can be used by infrastructure or application code
28+-- to provide access to runtime instrumentation data, expose control planes
29+-- and/or provide remote access to external clients.
21430--
215−-- When a node initially starts, two special, internal system processes are
216−-- started to support the management infrastructure. The first, known as the
217−-- /trace controller/, is responsible for consuming 'MxEvent's and forwarding
218−-- them to the configured tracer - see "Control.Distributed.Process.Debug" for
219−-- further details. The second is the /management agent controller/, and is the
220−-- primary worker process underpinning the management infrastructure. All
221−-- published management events are routed to this process, which places them
222−-- onto a system wide /event bus/ and additionally passes them directly to the
223−-- /trace controller/.
31+-- The management infrastructure is broken down into three components, which
32+-- roughly correspond to the modules it exposes:
22433--
225−-- There are several reasons for segregating the tracing and management control
226−-- planes in this fashion. Tracing can be enabled or disabled by clients, whilst
227−-- the management event bus cannot, since in addition to providing
228−-- runtime instrumentation, its intended use-cases include node monitoring, peer
229−-- discovery (via topology providing backends) and other essential system
230−-- services that require knowledge of otherwise hidden system internals. Tracing
231−-- is also subject to /trace flags/ that limit the specific 'MxEvent's delivered
232−-- to trace clients - an overhead/complexity not shared by management agents.
233−-- Finally, tracing and management agents are implemented using completely
234−-- different signalling techniques - more on this later - which would introduce
235−-- considerable complexity if the shared the same /event loop/.
34+-- 1. @Agent@ - registration and management of /Management Agents/
35+-- 2. @Instrumentation@ - provides an API for publishing /instrumentation data/
36+-- 3. @Remote@ - provides an API for remote management and administration
23637--
237−-- The management control plane is driven by a shared broadcast channel, which
238−-- is written to by the agent controller and subscribed to by all agent
239−-- processes. Agents are spawned as regular processes, whose primary
240−-- implementation (i.e., /server loop/) is responsible for consuming
241−-- messages from both the broadcast channel and their own mailbox. Once
242−-- consumed, messages are applied to the agent's /event sinks/ until one
243−-- matches the input, at which point it is applied and the loop continues.
244−-- The implementation chooses from the event bus and the mailbox in a
245−-- round-robin fashion, until a message is received. This polling activity would
246−-- lead to management agents consuming considerable system resources if left
247−-- unchecked, therefore the implementation will poll for a limitted number of
248−-- retries, after which it will perform a blocking read on the event bus.
24938--
25039-----------------------------------------------------------------------------
25140module Control.Distributed.Process.Management
@@ -258,37 +47,36 @@ module Control.Distributed.Process.Management
25847 , MxAgentId(..)
25948 , MxAgent()
26049 , mxAgent
261− , mxAgentWithFinalize
262− , MxSink()
50+ , MxSink
26351 , mxSink
26452 , mxGetId
26553 , mxDeactivate
26654 , mxReady
267− , mxSkip
268− , mxReceive
269− , mxReceiveChan
27055 , mxBroadcast
27156 , mxSetLocal
27257 , mxGetLocal
273− , mxUpdateLocal
27458 , liftMX
59+ -- * Mx Data API
60+ , mxPublish
61+ , mxSet
62+ , mxGet
63+ , mxClear
64+ , mxPurgeTable
65+ , mxDropTable
27566 ) where
27667
277−import Control.Applicative
68+import Control.Applicative ((<$>))
27869import Control.Concurrent.STM (atomically)
27970import Control.Concurrent.STM.TChan
28071 ( readTChan
28172 , writeTChan
282− , TChan
28373 )
28474import Control.Distributed.Process.Internal.Primitives
285− ( receiveWait
286− , matchAny
287− , matchSTM
75+ ( newChan
76+ , nsend
77+ , receiveWait
78+ , matchChan
28879 , unwrapMessage
289− , register
290− , whereis
291− , die
29280 )
29381import Control.Distributed.Process.Internal.Types
29482 ( Process
@@ -299,27 +87,28 @@ import Control.Distributed.Process.Internal.Types
29987 , MxEventBus(..)
30088 , unsafeCreateUnencodedMessage
30189 )
302−import Control.Distributed.Process.Management.Internal.Bus (publishEvent)
303−import Control.Distributed.Process.Management.Internal.Types
90+import Control.Distributed.Process.Management.Bus (publishEvent)
91+import qualified Control.Distributed.Process.Management.Table as Table
92+import Control.Distributed.Process.Management.Types
30493 ( MxAgentId(..)
30594 , MxAgent(..)
30695 , MxAction(..)
307− , ChannelSelector(..)
30896 , MxAgentState(..)
97+ , MxAgentStart(..)
30998 , MxSink
31099 , MxEvent(..)
311100 )
312101import Control.Distributed.Process.Serializable (Serializable)
313102import Control.Monad.IO.Class (liftIO)
314103import Control.Monad.Reader (ask)
315−import Control.Monad.Catch (onException)
316104import qualified Control.Monad.State as ST
317− ( get
105+ ( MonadState
106+ , StateT
107+ , get
318108 , modify
319109 , lift
320110 , runStateT
321111 )
322−import Prelude
323112
324113-- | Publishes an arbitrary @Serializable@ message to the management event bus.
325114-- Note that /no attempt is made to force the argument/, therefore it is very
@@ -331,76 +120,71 @@ mxNotify msg = do
331120 bus <- localEventBus . processNode <$> ask
332121 liftIO $ publishEvent bus $ unsafeCreateUnencodedMessage msg
333122
123+-- | Publish an arbitrary @Message@ as a property in the management database.
124+--
125+-- For publishing @Serializable@ data, use 'mxSet' instead. For publishing
126+-- properties efficiently within an agent, use 'mxAgentPublish' instead,
127+-- since it will be more efficient in that context.
128+mxPublish :: MxAgentId -> String -> Message -> Process ()
129+mxPublish a k v = Table.set k v (Table.MxForAgent a)
130+
131+-- | Sets an arbitrary @Serializable@ datum against a key in the management
132+-- database. Note that /no attempt is made to force the argument/, therefore
133+-- it is very important that you do not pass unevaluated thunks that might
134+-- crash some other, arbitrary process (or management agent!) that obtains
135+-- and attempts to force the value later on.
136+--
137+mxSet :: Serializable a => MxAgentId -> String -> a -> Process ()
138+mxSet mxId key msg = do
139+ Table.set key (unsafeCreateUnencodedMessage msg) (Table.MxForAgent mxId)
140+
141+-- | Fetches a property from the management database for the given key.
142+-- If the property is not set, or does not match the expected type when
143+-- typechecked (at runtime), returns @Nothing@.
144+mxGet :: Serializable a => MxAgentId -> String -> Process (Maybe a)
145+mxGet = Table.fetch . Table.MxForAgent
146+
147+-- | Clears a property from the management database using the given key.
148+-- If the key does not exist in the database, this is a noop.
149+mxClear :: MxAgentId -> String -> Process ()
150+mxClear mxId key = Table.clear key (Table.MxForAgent mxId)
151+
152+-- | Purges a table in the management database of all its stored properties.
153+mxPurgeTable :: MxAgentId -> Process ()
154+mxPurgeTable = Table.purge . Table.MxForAgent
155+
156+-- | Deletes a table from the management database.
157+mxDropTable :: MxAgentId -> Process ()
158+mxDropTable = Table.delete . Table.MxForAgent
159+
334160--------------------------------------------------------------------------------
335161-- API for writing user defined management extensions (i.e., agents) --
336162--------------------------------------------------------------------------------
337163
338−-- | Return the 'MxAgentId' for the currently executing agent.
339−--
340164mxGetId :: MxAgent s MxAgentId
341165mxGetId = ST.get >>= return . mxAgentId
342166
343−-- | The 'MxAgent' version of 'mxNotify'.
344−--
345167mxBroadcast :: (Serializable m) => m -> MxAgent s ()
346168mxBroadcast msg = do
347169 state <- ST.get
348170 liftMX $ liftIO $ atomically $ do
349171 writeTChan (mxBus state) (unsafeCreateUnencodedMessage msg)
350172
351−-- | Gracefully terminate an agent.
352−--
353173mxDeactivate :: forall s. String -> MxAgent s MxAction
354174mxDeactivate = return . MxAgentDeactivate
355175
356−-- | Continue executing (i.e., receiving and processing messages).
357−--
358176mxReady :: forall s. MxAgent s MxAction
359177mxReady = return MxAgentReady
360178
361−-- | Causes the currently executing /event sink/ to be skipped.
362−-- The remaining declared event sinks will be evaluated to find
363−-- a matching handler. Can be used to allow multiple event sinks
364−-- to process data of the same type.
365−--
366−mxSkip :: forall s. MxAgent s MxAction
367−mxSkip = return MxAgentSkip
368−
369−-- | Continue exeucting, prioritising inputs from the process' own
370−-- /mailbox/ ahead of data from the management event bus.
371−--
372−mxReceive :: forall s. MxAgent s MxAction
373−mxReceive = return $ MxAgentPrioritise Mailbox
374−
375−-- | Continue exeucting, prioritising inputs from the management event bus
376−-- over the process' own /mailbox/.
377−--
378−mxReceiveChan :: forall s. MxAgent s MxAction
379−mxReceiveChan = return $ MxAgentPrioritise InputChan
380−
381−-- | Lift a @Process@ action.
382−--
383179liftMX :: Process a -> MxAgent s a
384180liftMX p = MxAgent $ ST.lift p
385181
386−-- | Set the agent's local state.
387−--
388182mxSetLocal :: s -> MxAgent s ()
389183mxSetLocal s = ST.modify $ \st -> st { mxLocalState = s }
390184
391−-- | Update the agent's local state.
392−--
393−mxUpdateLocal :: (s -> s) -> MxAgent s ()
394−mxUpdateLocal f = ST.modify $ \st -> st { mxLocalState = (f $ mxLocalState st) }
395−
396−-- | Fetch the agent's local state.
397−--
398185mxGetLocal :: MxAgent s s
399186mxGetLocal = ST.get >>= return . mxLocalState
400187
401−-- | Create an 'MxSink' from an expression taking a @Serializable@ type @m@,
402−-- that yields an 'MxAction' in the 'MxAgent' monad.
403−--
404188mxSink :: forall s m . (Serializable m)
405189 => (m -> MxAgent s MxAction)
406190 -> MxSink s
@@ -408,88 +192,43 @@ mxSink act msg = do
408192 msg' <- liftMX $ (unwrapMessage msg :: Process (Maybe m))
409193 case msg' of
410194 Nothing -> return Nothing
411− Just m -> do
412− r <- act m
413− case r of
414− MxAgentSkip -> return Nothing
415− _ -> return $ Just r
195+ Just m -> act m >>= return . Just
416196
417−-- private ADT: a linked list of event sinks
418197data MxPipeline s =
419198 MxPipeline
420199 {
421− current :: !(MxSink s)
422− , next :: !(MxPipeline s)
200+ current :: !(MxSink s)
201+ , next :: !(MxPipeline s)
423202 } | MxStop
424203
425204-- | Activates a new agent.
426205--
427−mxAgent :: MxAgentId -> s -> [MxSink s] -> Process ProcessId
428−mxAgent mxId st hs = mxAgentWithFinalize mxId st hs $ return ()
429−
430−-- | Activates a new agent. This variant takes a /finalizer/ expression,
431−-- that is run once the agent shuts down (even in case of failure/exceptions).
432−-- The /finalizer/ expression runs in the mx monad - @MxAgent s ()@ - such
433−-- that the agent's internal state remains accessible to the shutdown/cleanup
434−-- code.
435−--
436−mxAgentWithFinalize :: MxAgentId
206+mxAgent :: MxAgentId
437207 -> s
438208 -> [MxSink s]
439− -> MxAgent s ()
440209 -> Process ProcessId
441−mxAgentWithFinalize mxId initState handlers dtor = do
442− let name = agentId mxId
443− existing <- whereis name
444− case existing of
445− Just _ -> die "DuplicateAgentId" -- TODO: better error handling policy
446− Nothing -> do
447− node <- processNode <$> ask
448− pid <- liftIO $ mxNew (localEventBus node) $ start
449− register name pid
450− return pid
210+mxAgent mxId initState handlers = do
211+ node <- processNode <$> ask
212+ pid <- liftIO $ mxNew (localEventBus node) $ start
213+ return pid
451214 where
452215 start (sendTChan, recvTChan) = do
453− let nState = MxAgentState mxId sendTChan initState
454− runAgent dtor handlers InputChan recvTChan nState
455−
456− runAgent :: MxAgent s ()
457− -> [MxSink s]
458− -> ChannelSelector
459− -> TChan Message
460− -> MxAgentState s
461− -> Process ()
462− runAgent eh hs cs c s =
463− runAgentWithFinalizer eh hs cs c s
464− `onException` runAgentFinalizer eh s
465−
466− runAgentWithFinalizer :: MxAgent s ()
467− -> [MxSink s]
468− -> ChannelSelector
469− -> TChan Message
470− -> MxAgentState s
471− -> Process ()
472− runAgentWithFinalizer eh' hs' cs' c' s' = do
473− msg <- getNextInput cs' c'
474− (action, state) <- runPipeline msg s' $ pipeline hs'
216+ (sp, rp) <- newChan
217+ nsend Table.mxTableCoordinator (MxAgentStart sp mxId)
218+ -- liftIO $ putStrLn $ "waiting on table coordinator " ++ Table.mxTableCoordinator
219+ -- p <- whereis Table.mxTableCoordinator
220+ -- liftIO $ putStrLn $ "registration == " ++ (show p)
221+ tablePid <- receiveWait [ matchChan rp (\(p :: ProcessId) -> return p) ]
222+ -- liftIO $ putStrLn "starting agent listener..."
223+ runAgent handlers recvTChan $ MxAgentState mxId sendTChan tablePid initState
224+
225+ runAgent hs c s = do
226+ msg <- (liftIO $ atomically $ readTChan c)
227+ (action, state) <- runPipeline msg s $ pipeline hs
475228 case action of
476− MxAgentReady -> runAgent eh' hs' InputChan c' state
477− MxAgentPrioritise priority -> runAgent eh' hs' priority c' state
478− MxAgentDeactivate _ -> runAgentFinalizer eh' state
479− MxAgentSkip -> error "IllegalState"
480−-- MxAgentBecome h' -> runAgent h' c state
481−
482− getNextInput sel chan =
483− let matches =
484− case sel of
485− Mailbox -> [ matchAny return
486− , matchSTM (readTChan chan) return]
487− InputChan -> [ matchSTM (readTChan chan) return
488− , matchAny return]
489− in receiveWait matches
490−
491− runAgentFinalizer :: MxAgent s () -> MxAgentState s -> Process ()
492− runAgentFinalizer f s = ST.runStateT (unAgent f) s >>= return . fst
229+ MxAgentReady -> runAgent hs c state
230+ MxAgentDeactivate _ -> {- TODO: log r -} return ()
231+-- MxAgentBecome h' -> runAgent h' c state
493232
494233 pipeline :: forall s . [MxSink s] -> MxPipeline s
495234 pipeline [] = MxStop
@@ -507,3 +246,4 @@ mxAgentWithFinalize mxId initState handlers dtor = do
507246 case pass of
508247 Nothing -> runPipeline msg state next
509248 Just result -> return (result, state')
249+
src/Control/Distributed/Process/Management/Internal/Agent.hs → src/Control/Distributed/Process/Management/Agent.hsrenamed+5−29
@@ -1,16 +1,13 @@
1−{-# LANGUAGE ScopedTypeVariables #-}
21{-# LANGUAGE RecordWildCards #-}
32
4−module Control.Distributed.Process.Management.Internal.Agent where
3+module Control.Distributed.Process.Management.Agent where
54
6−import Control.Applicative
7−import Control.Concurrent (forkIO)
5+import Control.Applicative ((<$>))
86import Control.Concurrent.MVar (MVar, newEmptyMVar, putMVar, takeMVar)
97import Control.Concurrent.STM (atomically)
108import Control.Concurrent.STM.TChan
119 ( TChan
1210 , newBroadcastTChanIO
13− , readTChan
1411 , writeTChan
1512 , dupTChan
1613 )
@@ -25,10 +22,10 @@ import Control.Distributed.Process.Internal.CQueue
2522 ( enqueueSTM
2623 , CQueue
2724 )
28−import Control.Distributed.Process.Management.Internal.Types
25+import Control.Distributed.Process.Management.Types
2926 ( Fork
3027 )
31−import Control.Distributed.Process.Management.Internal.Trace.Tracer
28+import Control.Distributed.Process.Management.Trace.Tracer
3229 ( traceController
3330 )
3431import Control.Distributed.Process.Internal.Types
@@ -44,7 +41,6 @@ import Control.Monad (void)
4441import Control.Monad.IO.Class (liftIO)
4542import Control.Monad.Reader (ask)
4643import GHC.Weak (Weak, deRefWeak)
47−import Prelude
4844
4945--------------------------------------------------------------------------------
5046-- Agent Controller Implementation --
@@ -77,7 +73,6 @@ mxAgentController :: Fork
7773mxAgentController forkProcess mv = do
7874 trc <- liftIO $ startTracing forkProcess
7975 sigbus <- liftIO $ newBroadcastTChanIO
80− liftIO $ startDeadLetterQueue sigbus
8176 weakQueue <- processWeakQ <$> ask
8277 liftIO $ putMVar mv (trc, weakQueue, mxStartAgent forkProcess sigbus)
8378 go sigbus trc
@@ -99,7 +94,7 @@ mxAgentController forkProcess mv = do
9994 -- (e.g., passing unevaluated thunks that will crash when
10095 -- they're eventually forced) are thus silently ignored.
10196 --
102− matchAny (liftIO . broadcast bus tracer)
97+ matchAny (\msg -> liftIO $ broadcast bus tracer msg)
10398 ] `catches` [Handler (\ThreadKilled -> die "Killed"),
10499 Handler (\(_ :: SomeException) -> return ())]
105100
@@ -120,7 +115,6 @@ mxAgentController forkProcess mv = do
120115 liftIO $ atomically $ enqueueSTM q msg >> writeTChan ch msg
121116
122117-- | Forks a new process in which an mxAgent is run.
123−--
124118mxStartAgent :: Fork
125119 -> TChan Message
126120 -> ((TChan Message, TChan Message) -> Process ())
@@ -130,8 +124,6 @@ mxStartAgent fork chan handler = do
130124 let proc = handler (chan, chan')
131125 fork proc
132126
133−-- | Start the tracer controller.
134−--
135127startTracing :: Fork -> IO Tracer
136128startTracing forkProcess = do
137129 mv <- newEmptyMVar
@@ -139,19 +131,3 @@ startTracing forkProcess = do
139131 wQ <- liftIO $ takeMVar mv
140132 return $ Tracer pid wQ
141133
142−-- | Start a dead letter (agent) queue.
143−--
144−-- If no agents are registered on the system, the management
145−-- event bus will fill up and its data won't be GC'ed until someone
146−-- comes along and reads from the broadcast channel (via dupTChan
147−-- of course). This is effectively a leak, so to mitigate it, we
148−-- start a /dead letter queue/ that drains the event bus continuously,
149−-- thus ensuring if there are no other consumers that we won't use
150−-- up heap space unnecessarily.
151−--
152−startDeadLetterQueue :: TChan Message
153− -> IO ()
154−startDeadLetterQueue sigbus = do
155− chan' <- atomically (dupTChan sigbus)
156− void $ forkIO $ forever' $ do
157− void $ atomically $ readTChan chan'
src/Control/Distributed/Process/Management/Internal/Bus.hs → src/Control/Distributed/Process/Management/Bus.hsrenamed+1−1
@@ -1,5 +1,5 @@
11-- | Interface to the management event bus.
2−module Control.Distributed.Process.Management.Internal.Bus
2+module Control.Distributed.Process.Management.Bus
33 ( publishEvent
44 ) where
55
src/Control/Distributed/Process/Management/Table.hsnew file+219
@@ -0,0 +1,219 @@
1+{-# LANGUAGE DeriveGeneric #-}
2+{-# LANGUAGE RecordWildCards #-}
3+
4+module Control.Distributed.Process.Management.Table
5+ ( MxTableRequest(..)
6+ , MxTableId(..)
7+ , mxTableCoordinator
8+ , startTableCoordinator
9+ , delete
10+ , purge
11+ , clear
12+ , set
13+ , get
14+ , fetch
15+ ) where
16+
17+import Control.Distributed.Process.Internal.Primitives
18+ ( receiveWait
19+ , receiveChan
20+ , match
21+ , matchAny
22+ , matchIf
23+ , matchChan
24+ , send
25+ , nsend
26+ , sendChan
27+ , getSelfPid
28+ , link
29+ , monitor
30+ , unwrapMessage
31+ , newChan
32+ , withMonitor
33+ )
34+import Control.Distributed.Process.Internal.Types
35+ ( Process
36+ , ProcessId
37+ , ProcessMonitorNotification(..)
38+ , SendPort
39+ , ReceivePort
40+ , Message
41+ , unsafeCreateUnencodedMessage
42+ )
43+import Control.Distributed.Process.Management.Types
44+ ( MxTableId(..)
45+ , MxAgentId(..)
46+ , MxAgentStart(..)
47+ , Fork)
48+import Control.Distributed.Process.Serializable (Serializable)
49+import Control.Monad.IO.Class (liftIO)
50+import Data.Accessor (Accessor, accessor, (^=), (^:))
51+import Data.Binary (Binary)
52+import Data.Map.Strict (Map)
53+import qualified Data.Map.Strict as Map
54+import Data.Typeable (Typeable)
55+
56+import GHC.Generics
57+
58+-- An extremely lightweight shared Map implementation, for use
59+-- by /management agents/ and their cohorts. Each agent is assigned
60+-- a table, into which any serializable @Message@ can be inserted.
61+-- Data are inserted, removed and searched for via their key, which
62+-- is a string. Tables can be purged, values can be set, fetched or
63+-- cleared/removed.
64+--
65+
66+data MxTableRequest =
67+ Delete
68+ | Purge
69+ | Clear !String
70+ | Set !String !Message
71+ | Get !String !(SendPort (Maybe Message)) -- see [note: un-typed send port]
72+ deriving (Typeable, Generic)
73+instance Binary MxTableRequest where
74+
75+data MxTableState =
76+ MxTableState { _name :: !String, _entries :: !(Map String Message) }
77+
78+type MxTables = Map MxAgentId ProcessId
79+
80+mxTableCoordinator :: String
81+mxTableCoordinator = "mx.table.coordinator"
82+
83+delete :: MxTableId -> Process ()
84+delete = sendReq Delete
85+
86+purge :: MxTableId -> Process ()
87+purge = sendReq Purge
88+
89+clear :: String -> MxTableId -> Process ()
90+clear k = sendReq (Clear k)
91+
92+set :: String -> Message -> MxTableId -> Process ()
93+set k v = sendReq (Set k v)
94+
95+fetch :: forall a. (Serializable a)
96+ => MxTableId
97+ -> String
98+ -> Process (Maybe a)
99+fetch (MxForPid pid) key = get pid key
100+fetch mxId@(MxForAgent _) key = do
101+ (sp, rp) <- newChan :: Process (SendPort (Maybe Message),
102+ ReceivePort (Maybe Message))
103+ sendReq (Get key sp) mxId
104+ receiveChan rp >>= maybe (return Nothing)
105+ (unwrapMessage :: Message -> Process (Maybe a))
106+
107+-- [note: un-typed send port]
108+-- Here, fetch uses a typed channel over a raw Message to obtain
109+-- its result, so type checking is deferred until receipt and will
110+-- be handled in the caller's thread. This is necessary because
111+-- the server portion of the code knows nothing about the types
112+-- involved, nor should it, since these tables can be used to
113+-- store arbitrary serializable data.
114+
115+get :: forall a. (Serializable a)
116+ => ProcessId
117+ -> String
118+ -> Process (Maybe a)
119+get pid key = do
120+ safeFetch pid key >>= maybe (return Nothing)
121+ (unwrapMessage :: Message -> Process (Maybe a))
122+
123+safeFetch :: ProcessId -> String -> Process (Maybe Message)
124+safeFetch pid key = do
125+ (sp, rp) <- newChan
126+ send pid $ Get key sp
127+ withMonitor pid $ do
128+ receiveWait [
129+ matchChan rp return
130+ , matchIf (\(ProcessMonitorNotification _ pid' _) -> pid' == pid)
131+ (\_ -> return $ Just (unsafeCreateUnencodedMessage ()))
132+ ]
133+
134+sendReq :: MxTableRequest -> MxTableId -> Process ()
135+sendReq req tid = (resolve tid) req
136+
137+resolve :: Serializable a => MxTableId -> (a -> Process ())
138+resolve (MxForAgent agent) = \msg -> nsend mxTableCoordinator (agent, msg)
139+resolve (MxForPid pid) = \msg -> send pid msg
140+
141+startTableCoordinator :: Fork -> Process ()
142+startTableCoordinator fork = run Map.empty
143+ where
144+ run :: MxTables -> Process ()
145+ run tables =
146+ receiveWait [
147+ -- note that this state change can race with MxAgentStart requests
148+ match (\(ProcessMonitorNotification _ pid _) -> do
149+ return $ Map.filter (/= pid) tables)
150+ , match (\(MxAgentStart ch agent) -> do
151+ lookupAgent tables agent >>= \(p, t) -> do
152+ sendChan ch p >> return t)
153+ , match (\req@(agent, tReq :: MxTableRequest) -> do
154+ case tReq of
155+ Get k sp -> do
156+ lookupAgent tables agent >>= \(p, t) -> do
157+ safeFetch p k >>= sendChan sp >> return t
158+ _ -> do
159+ handleRequest tables req)
160+ , matchAny (\_ -> return tables) -- unrecognised messages are dropped
161+ ] >>= run
162+
163+ handleRequest :: MxTables
164+ -> (MxAgentId, MxTableRequest)
165+ -> Process MxTables
166+ handleRequest tables' (agent, req) = do
167+ lookupAgent tables' agent >>= \(p, t) -> send p req >> return t
168+
169+ lookupAgent :: MxTables -> MxAgentId -> Process (ProcessId, MxTables)
170+ lookupAgent tables' agentId' = do
171+ case Map.lookup agentId' tables' of
172+ Nothing -> launchNew agentId' tables'
173+ Just p -> return (p, tables')
174+
175+ launchNew :: MxAgentId
176+ -> MxTables
177+ -> Process (ProcessId, MxTables)
178+ launchNew mxId tblMap = do
179+ let initState = MxTableState { _name = (agentId mxId)
180+ , _entries = Map.empty
181+ }
182+ (pid, _) <- spawnSup $ tableHandler initState
183+ return $ (pid, Map.insert mxId pid tblMap)
184+
185+ spawnSup proc = do
186+ us <- getSelfPid
187+ -- we need to use that passed in "fork", in order to
188+ -- break an import cycle with Node.hs via the management
189+ -- agent, management API and the tracing modules
190+ them <- liftIO $ fork $ link us >> proc
191+ ref <- monitor them
192+ return (them, ref)
193+
194+tableHandler :: MxTableState -> Process ()
195+tableHandler state = do
196+ ns <- receiveWait [
197+ match (handleTableRequest state)
198+ , matchAny (\_ -> return (Just state))
199+ ]
200+ case ns of
201+ Nothing -> return ()
202+ Just s' -> tableHandler s'
203+ where
204+ handleTableRequest _ Delete = return Nothing
205+ handleTableRequest st Purge = return $ Just $ (entries ^= Map.empty) $ st
206+ handleTableRequest st (Clear k) = return $ Just $ (entries ^: Map.delete k) $ st
207+ handleTableRequest st (Set k v) = return $ Just $ (entries ^: Map.insert k v) st
208+ handleTableRequest st (Get k c) = getEntry k c st >> return (Just st)
209+
210+getEntry :: String
211+ -> SendPort (Maybe Message)
212+ -> MxTableState
213+ -> Process ()
214+getEntry k m MxTableState{..} = do
215+ sendChan m =<< return (Map.lookup k _entries)
216+
217+entries :: Accessor MxTableState (Map String Message)
218+entries = accessor _entries (\ls st -> st { _entries = ls })
219+
src/Control/Distributed/Process/Management/Internal/Trace/Primitives.hs → src/Control/Distributed/Process/Management/Trace/Primitives.hsrenamed+6−15
@@ -1,5 +1,3 @@
1−{-# LANGUAGE FlexibleInstances #-}
2−{-# LANGUAGE TypeSynonymInstances #-}
31-- | Keeps the tracing API calls separate from the Tracer implementation,
42-- which allows us to avoid a nasty import cycle between tracing and
53-- the messaging primitives that rely on it, and also between the node
@@ -7,7 +5,7 @@
75-- our RemoteTable) and the Debug module, which requires @forkProcess@.
86-- This module is also used by the management agent, which relies on the
97-- tracing infrastructure's messaging fabric.
10−module Control.Distributed.Process.Management.Internal.Trace.Primitives
8+module Control.Distributed.Process.Management.Trace.Primitives
119 ( -- * Sending Trace Data
1210 traceLog
1311 , traceLogFmt
@@ -28,21 +26,20 @@ module Control.Distributed.Process.Management.Internal.Trace.Primitives
2826 , withRegisteredTracer
2927 ) where
3028
31−import Control.Applicative
29+import Control.Applicative ((<$>))
3230import Control.Distributed.Process.Internal.Primitives
3331 ( whereis
3432 , newChan
3533 , receiveChan
36− , die
3734 )
38−import Control.Distributed.Process.Management.Internal.Trace.Types
35+import Control.Distributed.Process.Management.Trace.Types
3936 ( TraceArg(..)
4037 , TraceFlags(..)
4138 , TraceOk(..)
4239 , TraceSubject(..)
4340 , defaultTraceFlags
4441 )
45−import qualified Control.Distributed.Process.Management.Internal.Trace.Types as Tracer
42+import qualified Control.Distributed.Process.Management.Trace.Types as Tracer
4643 ( traceLog
4744 , traceLogFmt
4845 , traceMessage
@@ -68,7 +65,6 @@ import Control.Monad.IO.Class (liftIO)
6865import Control.Monad.Reader (ask)
6966
7067import qualified Data.Set as Set (fromList)
71−import Prelude
7268
7369--------------------------------------------------------------------------------
7470-- Main API --
@@ -169,11 +165,6 @@ withRegisteredTracer act = do
169165 withLocalTracer $ \t -> liftIO $ Tracer.getCurrentTraceClient t sp
170166 currentTracer <- receiveChan rp
171167 case currentTracer of
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)"
168+ Nothing -> do { (Just p') <- whereis "tracer.initial"; act p' }
179169 (Just p) -> act p
170+
src/Control/Distributed/Process/Management/Internal/Trace/Remote.hs → src/Control/Distributed/Process/Management/Trace/Remote.hsrenamed+3−3
@@ -1,4 +1,4 @@
1−module Control.Distributed.Process.Management.Internal.Trace.Remote
1+module Control.Distributed.Process.Management.Trace.Remote
22 ( -- * Configuring A Remote Tracer
33 setTraceFlagsRemote
44 , startTraceRelay
@@ -14,11 +14,11 @@ import Control.Distributed.Process.Internal.Primitives
1414 , relay
1515 , nsendRemote
1616 )
17−import Control.Distributed.Process.Management.Internal.Trace.Types
17+import Control.Distributed.Process.Management.Trace.Types
1818 ( TraceFlags(..)
1919 , TraceOk(..)
2020 )
21−import Control.Distributed.Process.Management.Internal.Trace.Primitives
21+import Control.Distributed.Process.Management.Trace.Primitives
2222 ( withRegisteredTracer
2323 , enableTrace
2424 )
src/Control/Distributed/Process/Management/Internal/Trace/Tracer.hs → src/Control/Distributed/Process/Management/Trace/Tracer.hsrenamed+10−18
@@ -1,7 +1,5 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
31-- | Tracing/Debugging support - Trace Implementation
4−module Control.Distributed.Process.Management.Internal.Trace.Tracer
2+module Control.Distributed.Process.Management.Trace.Tracer
53 ( -- * API for the Management Agent
64 traceController
75 -- * Built in tracers
@@ -11,7 +9,7 @@ module Control.Distributed.Process.Management.Internal.Trace.Tracer
119 , eventLogTracer
1210 ) where
1311
14−import Control.Applicative
12+import Control.Applicative ((<$>))
1513import Control.Concurrent.Chan (writeChan)
1614import Control.Concurrent.MVar
1715 ( MVar
@@ -21,7 +19,9 @@ import Control.Distributed.Process.Internal.CQueue
2119 ( CQueue
2220 )
2321import Control.Distributed.Process.Internal.Primitives
24− ( die
22+ ( catch
23+ , finally
24+ , die
2525 , receiveWait
2626 , forward
2727 , sendChan
@@ -31,18 +31,18 @@ import Control.Distributed.Process.Internal.Primitives
3131 , handleMessage
3232 , matchUnknown
3333 )
34−import Control.Distributed.Process.Management.Internal.Types
34+import Control.Distributed.Process.Management.Types
3535 ( MxEvent(..)
3636 , Addressable(..)
3737 )
38−import Control.Distributed.Process.Management.Internal.Trace.Types
38+import Control.Distributed.Process.Management.Trace.Types
3939 ( SetTrace(..)
4040 , TraceSubject(..)
4141 , TraceFlags(..)
4242 , TraceOk(..)
4343 , defaultTraceFlags
4444 )
45−import Control.Distributed.Process.Management.Internal.Trace.Primitives
45+import Control.Distributed.Process.Management.Trace.Primitives
4646 ( traceOn )
4747import Control.Distributed.Process.Internal.Types
4848 ( LocalNode(..)
@@ -61,10 +61,6 @@ import Control.Distributed.Process.Internal.Types
6161
6262import Control.Monad.IO.Class (liftIO)
6363import Control.Monad.Reader (ask)
64−import Control.Monad.Catch
65− ( catch
66− , finally
67− )
6864
6965import Data.Set (Set)
7066import qualified Data.Set as Set
@@ -75,7 +71,6 @@ import Data.Maybe (fromMaybe)
7571import Data.Time.Clock (getCurrentTime)
7672import Data.Time.Format (formatTime)
7773import Debug.Trace (traceEventIO)
78−import Prelude
7974
8075#if ! MIN_VERSION_base(4,6,0)
8176import Prelude hiding (catch)
@@ -91,11 +86,7 @@ import System.IO
9186 , hPutStrLn
9287 , hSetBuffering
9388 )
94−#if MIN_VERSION_time(1,5,0)
95−import Data.Time.Format (defaultTimeLocale)
96−#else
9789import System.Locale (defaultTimeLocale)
98−#endif
9990import System.Mem.Weak
10091 ( Weak
10192 )
@@ -153,7 +144,7 @@ systemLoggerTracer = do
153144 emptyPid <- return $ (nullProcessId (localNodeId node))
154145 traceMsg <- return $ NCMsg {
155146 ctrlMsgSender = ProcessIdentifier (emptyPid)
156− , ctrlMsgSignal = (NamedSend "trace.logger"
147+ , ctrlMsgSignal = (NamedSend "logger"
157148 (createUnencodedMessage msg))
158149 }
159150 liftIO $ writeChan (localCtrlChan node) traceMsg
@@ -352,3 +343,4 @@ sendTrace st ev msg = do
352343sendTraceMsg :: Maybe ProcessId -> Message -> Process ()
353344sendTraceMsg Nothing _ = return ()
354345sendTraceMsg (Just p) msg = (flip forward) p msg
346+
src/Control/Distributed/Process/Management/Internal/Trace/Types.hs → src/Control/Distributed/Process/Management/Trace/Types.hsrenamed+14−8
@@ -1,12 +1,7 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE ExistentialQuantification #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE TypeSynonymInstances #-}
5−{-# LANGUAGE GADTs #-}
61{-# LANGUAGE DeriveGeneric #-}
72
83-- | Tracing/Debugging support - Types
9−module Control.Distributed.Process.Management.Internal.Trace.Types
4+module Control.Distributed.Process.Management.Trace.Types
105 ( SetTrace(..)
116 , TraceSubject(..)
127 , TraceFlags(..)
@@ -33,16 +28,17 @@ import Control.Distributed.Process.Internal.Types
3328 , SendPort
3429 , unsafeCreateUnencodedMessage
3530 )
36−import Control.Distributed.Process.Management.Internal.Bus
31+import Control.Distributed.Process.Management.Bus
3732 ( publishEvent
3833 )
39−import Control.Distributed.Process.Management.Internal.Types
34+import Control.Distributed.Process.Management.Types
4035 ( MxEvent(..)
4136 )
4237import Control.Distributed.Process.Serializable
4338import Data.Binary
4439import Data.List (intersperse)
4540import Data.Set (Set)
41+import qualified Data.Set as Set (fromList)
4642import Data.Typeable
4743import GHC.Generics
4844
@@ -157,3 +153,13 @@ getTraceFlags t s = publishEvent t (unsafeCreateUnencodedMessage s)
157153
158154getCurrentTraceClient :: MxEventBus -> SendPort (Maybe ProcessId) -> IO ()
159155getCurrentTraceClient t s = publishEvent t (unsafeCreateUnencodedMessage s)
156+
157+class Traceable a where
158+ uod :: [a] -> TraceSubject
159+
160+instance Traceable ProcessId where
161+ uod = TraceProcs . Set.fromList
162+
163+instance Traceable String where
164+ uod = TraceNames . Set.fromList
165+
src/Control/Distributed/Process/Management/Internal/Types.hs → src/Control/Distributed/Process/Management/Types.hsrenamed+23−24
@@ -1,13 +1,11 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE ExistentialQuantification #-}
3−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
41{-# LANGUAGE DeriveGeneric #-}
5−module Control.Distributed.Process.Management.Internal.Types
2+module Control.Distributed.Process.Management.Types
63 ( MxAgentId(..)
4+ , MxTableId(..)
75 , MxAgentState(..)
86 , MxAgent(..)
97 , MxAction(..)
10− , ChannelSelector(..)
8+ , MxAgentStart(..)
119 , Fork
1210 , MxSink
1311 , MxEvent(..)
@@ -21,8 +19,8 @@ import Control.Concurrent.STM
2119import Control.Distributed.Process.Internal.Types
2220 ( Process
2321 , ProcessId
24− , SendPortId
2522 , Message
23+ , SendPort
2624 , DiedReason
2725 , NodeId
2826 )
@@ -31,7 +29,6 @@ import qualified Control.Monad.State as ST
3129 ( MonadState
3230 , StateT
3331 )
34−import Control.Monad.Fix (MonadFix)
3532import Data.Binary
3633import Data.Typeable (Typeable)
3734import GHC.Generics
@@ -40,6 +37,8 @@ import Network.Transport
4037 , EndPointAddress
4138 )
4239
40+-- TODO: consider factoring out MxEvent's tracing specific constructors
41+
4342-- | This is the /default/ management event, fired for various internal
4443-- events around the NT connection and Process lifecycle. All published
4544-- events that conform to this type, are eligible for tracing - i.e.,
@@ -58,14 +57,8 @@ data MxEvent =
5857 -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
5958 | MxSent ProcessId ProcessId Message
6059 -- ^ 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
6560 | MxReceived ProcessId Message
6661 -- ^ 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
6962 | MxConnected ConnectionId EndPointAddress
7063 -- ^ fired when a network-transport connection is first established
7164 | MxDisconnected ConnectionId EndPointAddress
@@ -82,8 +75,6 @@ data MxEvent =
8275
8376instance Binary MxEvent where
8477
85−-- | The class of things that we might be able to resolve to
86−-- a @ProcessId@ (or not).
8778class Addressable a where
8879 resolveToPid :: a -> Maybe ProcessId
8980
@@ -104,15 +95,22 @@ type Fork = (Process () -> IO ProcessId)
10495newtype MxAgentId = MxAgentId { agentId :: String }
10596 deriving (Typeable, Binary, Eq, Ord)
10697
98+data MxTableId =
99+ MxForAgent !MxAgentId
100+ | MxForPid !ProcessId
101+ deriving (Typeable, Generic)
102+instance Binary MxTableId where
103+
107104data MxAgentState s = MxAgentState
108105 {
109106 mxAgentId :: !MxAgentId
110107 , mxBus :: !(TChan Message)
108+ , mxSharedTable :: !ProcessId
111109 , mxLocalState :: !s
112110 }
113111
114−-- | Monad for management agents.
115−--
112+-- | Monad for management agents, encapsulting the
113+-- agent's state and private
116114newtype MxAgent s a =
117115 MxAgent
118116 {
@@ -120,22 +118,23 @@ newtype MxAgent s a =
120118 } deriving ( Functor
121119 , Monad
122120 , MonadIO
123− , MonadFix
124121 , ST.MonadState (MxAgentState s)
125122 , Typeable
126123 , Applicative
127124 )
128125
129−data ChannelSelector = InputChan | Mailbox
126+data MxAgentStart = MxAgentStart
127+ {
128+ mxAgentTableChan :: SendPort ProcessId
129+ , mxAgentIdStart :: MxAgentId
130+ }
131+ deriving (Typeable, Generic)
132+instance Binary MxAgentStart where
130133
131−-- | Represents the actions a management agent can take
132−-- when evaluating an /event sink/.
133−--
134134data MxAction =
135135 MxAgentDeactivate !String
136− | MxAgentPrioritise !ChannelSelector
137136 | MxAgentReady
138− | MxAgentSkip
139137
140138-- | Type of a management agent's event sink.
141139type MxSink s = Message -> MxAgent s (Maybe MxAction)
140+
src/Control/Distributed/Process/Node.hs+197−345
@@ -1,11 +1,4 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE ScopedTypeVariables #-}
4−{-# LANGUAGE RankNTypes #-}
5−{-# LANGUAGE BangPatterns #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
71{-# LANGUAGE RecordWildCards #-}
8−{-# LANGUAGE MagicHash #-}
92
103-- | Local nodes
114--
@@ -21,6 +14,10 @@ module Control.Distributed.Process.Node
2114
2215-- TODO: Calls to 'sendBinary' and co (by the NC) may stall the node controller.
2316
17+#if ! MIN_VERSION_base(4,6,0)
18+import Prelude hiding (catch)
19+#endif
20+
2421import System.IO (fixIO, hPutStrLn, stderr)
2522import System.Mem.Weak (Weak, deRefWeak)
2623import qualified Data.ByteString.Lazy as BSL (fromChunks)
@@ -28,67 +25,46 @@ import Data.Binary (decode)
2825import Data.Map (Map)
2926import qualified Data.Map as Map
3027 ( empty
31− , delete
3228 , toList
3329 , fromList
34− , insert
35− , lookup
36− , partition
30+ , filter
3731 , partitionWithKey
3832 , elems
39− , size
4033 , filterWithKey
4134 , foldlWithKey
4235 )
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
4936import Data.Set (Set)
5037import qualified Data.Set as Set
5138 ( empty
5239 , insert
5340 , delete
54− , map
5541 , member
5642 , toList
57− , union
5843 )
5944import Data.Foldable (forM_)
6045import Data.Maybe (isJust, fromJust, isNothing, catMaybes)
6146import Data.Typeable (Typeable)
6247import Control.Category ((>>>))
63−import Control.Applicative
64−import Control.Monad (void, when, join)
48+import Control.Applicative ((<$>))
49+import Control.Monad (void, when)
6550import Control.Monad.IO.Class (MonadIO, liftIO)
6651import Control.Monad.State.Strict (MonadState, StateT, evalStateT, gets)
6752import qualified Control.Monad.State.Strict as StateT (get, put)
6853import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask)
6954import Control.Exception
7055 ( throwIO
56+ , AsyncException(ThreadKilled)
7157 , SomeException
7258 , Exception
7359 , throwTo
74− , uninterruptibleMask_
75− , getMaskingState
76− , MaskingState(..)
7760 )
78−import qualified Control.Exception as Exception
79− ( Handler(..)
80− , catch
81− , catches
82− , finally
83− )
84−import Control.Concurrent (forkIO, killThread)
85−import Control.Distributed.Process.Internal.BiMultiMap (BiMultiMap)
86−import qualified Control.Distributed.Process.Internal.BiMultiMap as BiMultiMap
61+import qualified Control.Exception as Exception (Handler(..), catches, finally)
62+import Control.Concurrent (forkIO, myThreadId)
8763import Control.Distributed.Process.Internal.StrictMVar
8864 ( newMVar
8965 , withMVar
90− , modifyMVarMasked
9166 , modifyMVar
67+ , modifyMVar_
9268 , newEmptyMVar
9369 , putMVar
9470 , takeMVar
@@ -103,7 +79,6 @@ import Control.Distributed.Process.Internal.CQueue
10379 , enqueue
10480 , newCQueue
10581 , mkWeakCQueue
106− , queueSize
10782 )
10883import qualified Network.Transport as NT
10984 ( Transport
@@ -115,8 +90,8 @@ import qualified Network.Transport as NT
11590 , TransportError(..)
11691 , address
11792 , closeEndPoint
118− , Connection
11993 , ConnectionId
94+ , Connection
12095 , close
12196 , EndPointAddress
12297 , Reliability(ReliableOrdered)
@@ -135,9 +110,6 @@ import Control.Distributed.Process.Internal.Types
135110 , LocalNode(..)
136111 , MxEventBus(..)
137112 , LocalNodeState(..)
138− , ValidLocalNodeState(..)
139− , withValidLocalState
140− , modifyValidLocalState
141113 , LocalProcess(..)
142114 , LocalProcessState(..)
143115 , Process(..)
@@ -147,11 +119,9 @@ import Control.Distributed.Process.Internal.Types
147119 , localPidCounter
148120 , localPidUnique
149121 , localProcessWithId
150− , localProcesses
151122 , localConnections
152123 , forever'
153124 , MonitorRef(..)
154− , NodeClosedException(..)
155125 , ProcessMonitorNotification(..)
156126 , NodeMonitorNotification(..)
157127 , PortMonitorNotification(..)
@@ -171,52 +141,53 @@ import Control.Distributed.Process.Internal.Types
171141 , nodeOf
172142 , ProcessInfo(..)
173143 , ProcessInfoNone(..)
174− , NodeStats(..)
175144 , SendPortId(..)
176145 , typedChannelWithId
177146 , RegisterReply(..)
178147 , WhereIsReply(..)
179148 , payloadToMessage
180149 , createUnencodedMessage
181− , unsafeCreateUnencodedMessage
182150 , runLocalProcess
183151 , firstNonReservedProcessId
184152 , ImplicitReconnect(WithImplicitReconnect)
185153 )
186−import Control.Distributed.Process.Management.Internal.Agent
154+import Control.Distributed.Process.Management.Agent
187155 ( mxAgentController
188156 )
189−import Control.Distributed.Process.Management.Internal.Types
190− ( MxEvent(..)
157+import qualified Control.Distributed.Process.Management.Table as Table
158+ ( mxTableCoordinator
159+ , startTableCoordinator
191160 )
192−import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Trace
161+import qualified Control.Distributed.Process.Management.Trace.Remote as Trace
193162 ( remoteTable
194163 )
195−import Control.Distributed.Process.Management.Internal.Trace.Tracer
164+import Control.Distributed.Process.Management.Trace.Tracer
196165 ( defaultTracer
197166 )
198−import Control.Distributed.Process.Management.Internal.Trace.Types
167+import Control.Distributed.Process.Management.Trace.Types
199168 ( TraceArg(..)
200169 , traceEvent
201170 , traceLogFmt
202171 , enableTrace
203172 )
173+import Control.Distributed.Process.Management.Types
174+ ( MxEvent(..)
175+ )
204176import Control.Distributed.Process.Serializable (Serializable)
205177import Control.Distributed.Process.Internal.Messaging
206178 ( sendBinary
179+ , sendMessage
207180 , closeImplicitReconnections
208181 , impliesDeathOf
209182 )
210183import Control.Distributed.Process.Internal.Primitives
211184 ( register
185+ , finally
212186 , receiveWait
213187 , match
214188 , sendChan
189+ , catch
215190 , unwrapMessage
216− , monitor
217− , unmonitorAsync
218− , getSelfNode
219− , SayMessage(..)
220191 )
221192import Control.Distributed.Process.Internal.Types (SendPort, Tracer(..))
222193import qualified Control.Distributed.Process.Internal.Closure.BuiltIn as BuiltIn (remoteTable)
@@ -225,20 +196,7 @@ import qualified Control.Distributed.Process.Internal.StrictContainerAccessors a
225196 ( mapMaybe
226197 , mapDefault
227198 )
228−import Control.Monad.Catch (try)
229−import GHC.IO (IO(..), unsafeUnmask)
230−import GHC.Base ( maskAsyncExceptions# )
231−
232199import 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
242200
243201--------------------------------------------------------------------------------
244202-- Initialization --
@@ -262,7 +220,7 @@ newLocalNode transport rtable = do
262220createBareLocalNode :: NT.EndPoint -> RemoteTable -> IO LocalNode
263221createBareLocalNode endPoint rtable = do
264222 unq <- randomIO
265− state <- newMVar $ LocalNodeValid $ ValidLocalNodeState
223+ state <- newMVar LocalNodeState
266224 { _localProcesses = Map.empty
267225 , _localPidCounter = firstNonReservedProcessId
268226 , _localPidUnique = unq
@@ -324,19 +282,17 @@ startServiceProcesses node = do
324282 -- before /that/ process has started - this is a totally harmless race
325283 -- however, so we deliberably ignore it
326284 startDefaultTracer node
285+ tableCoordinatorPid <- fork $ Table.startTableCoordinator fork
286+ runProcess node $ register Table.mxTableCoordinator tableCoordinatorPid
327287 logger <- forkProcess node loop
328− runProcess node $ do
329− register "logger" logger
330− -- The trace.logger is used for tracing to the console to avoid feedback
331− -- loops during tracing if the user reregisters the "logger" with a custom
332− -- process which uses 'send' or other primitives which are traced.
333− register "trace.logger" logger
288+ runProcess node $ register "logger" logger
334289 where
290+ fork = forkProcess node
291+
335292 loop = do
336293 receiveWait
337− [ match $ \(SayMessage time pid string) -> do
338− let time' = formatTime defaultTimeLocale "%c" time
339− liftIO . hPutStrLn stderr $ time' ++ " " ++ show pid ++ ": " ++ string
294+ [ match $ \((time, pid, string) ::(String, ProcessId, String)) -> do
295+ liftIO . hPutStrLn stderr $ time ++ " " ++ show pid ++ ": " ++ string
340296 loop
341297 , match $ \((time, string) :: (String, String)) -> do
342298 -- this is a 'trace' message from the local node tracer
@@ -346,48 +302,32 @@ startServiceProcesses node = do
346302 sendChan ch ()
347303 ]
348304
349−-- | Force-close a local node, killing all processes on that node.
305+-- | Force-close a local node
306+--
307+-- TODO: for now we just close the associated endpoint
350308closeLocalNode :: LocalNode -> IO ()
351−closeLocalNode node = do
352− -- Kill processes after refilling the mvar. Otherwise, there is potential for
353− -- deadlock as a dying process tries to get the mvar while masking exceptions
354− -- uninterruptibly.
355− join $ modifyMVar (localState node) $ \st -> case st of
356− LocalNodeValid vst -> do
357− return ( LocalNodeClosed
358− , forM_ (vst ^. localProcesses) $ \lproc ->
359− -- Semantics of 'throwTo' guarantee that target thread will get
360− -- delivered an exception. Therefore, target thread will be
361− -- killed eventually and that's as good as we can do. No need
362− -- to wait for thread to actually finish dying.
363− killThread (processThread lproc)
364− )
365− LocalNodeClosed -> return (LocalNodeClosed, return ())
366− -- This call will have the effect of shutting down the NC as well (see
367− -- 'createBareLocalNode').
309+closeLocalNode node =
310+ -- TODO: close all our processes, surely!?
368311 NT.closeEndPoint (localEndPoint node)
369312
370313-- | Run a process on a local node and wait for it to finish
371314runProcess :: LocalNode -> Process () -> IO ()
372315runProcess node proc = do
373316 done <- newEmptyMVar
374− -- TODO; When forkProcess inherits the masking state, protect the forked
375− -- thread against async exceptions that could occur before 'try' is evaluated.
376− void $ forkProcess node $ try proc >>= liftIO . putMVar done
377− takeMVar done >>= either (throwIO :: SomeException -> IO a) return
317+ tid <- myThreadId
318+ void $ forkProcess node $ do
319+ catch (proc `finally` liftIO (putMVar done ()))
320+ (\(ex :: SomeException) -> liftIO $ throwTo tid ex)
321+ takeMVar done
378322
379323-- | Spawn a new process on a local node
380324forkProcess :: LocalNode -> Process () -> IO ProcessId
381−forkProcess node proc = do
382− ms <- getMaskingState
383− modifyMVarMasked (localState node) (startProcess ms)
325+forkProcess node proc = modifyMVar (localState node) startProcess
384326 where
385− startProcess :: MaskingState
386− -> LocalNodeState
387− -> IO (LocalNodeState, ProcessId)
388− startProcess ms (LocalNodeValid vst) = do
389− let lpid = LocalProcessId { lpidCounter = vst ^. localPidCounter
390− , lpidUnique = vst ^. localPidUnique
327+ startProcess :: LocalNodeState -> IO (LocalNodeState, ProcessId)
328+ startProcess st = do
329+ let lpid = LocalProcessId { lpidCounter = st ^. localPidCounter
330+ , lpidUnique = st ^. localPidUnique
391331 }
392332 let pid = ProcessId { processNodeId = localNodeId node
393333 , processLocalId = lpid
@@ -407,15 +347,9 @@ forkProcess node proc = do
407347 , processThread = tid
408348 , processNode = node
409349 }
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
350+ tid' <- forkIO $ do
417351 reason <- Exception.catches
418− (unmask $ runLocalProcess lproc proc >> return DiedNormal)
352+ (runLocalProcess lproc proc >> return DiedNormal)
419353 [ (Exception.Handler (\ex@(ProcessExitException from msg) -> do
420354 mMsg <- unwrapMessage msg :: IO (Maybe String)
421355 case mMsg of
@@ -425,12 +359,7 @@ forkProcess node proc = do
425359 (return . DiedException . (show :: SomeException -> String)))]
426360
427361 -- [Unified: Table 4, rules termination and exiting]
428− mconns <- modifyValidLocalState node (cleanupProcess pid)
429− -- XXX: Revisit after agreeing on the bigger picture for the semantics
430− -- of transport operations.
431− -- https://github.com/haskell-distributed/distributed-process/issues/204
432− forM_ mconns $ forkIO . mapM_ NT.close
433−
362+ modifyMVar_ (localState node) (cleanupProcess pid)
434363 writeChan (localCtrlChan node) NCMsg
435364 { ctrlMsgSender = ProcessIdentifier pid
436365 , ctrlMsgSignal = Died (ProcessIdentifier pid) reason
@@ -445,34 +374,27 @@ forkProcess node proc = do
445374 -- TODO: this doesn't look right at all - how do we know
446375 -- that newUnique represents a process id that is available!?
447376 newUnique <- randomIO
448− return ( LocalNodeValid
449− $ (localProcessWithId lpid ^= Just lproc)
377+ return ( (localProcessWithId lpid ^= Just lproc)
450378 . (localPidCounter ^= firstNonReservedProcessId)
451379 . (localPidUnique ^= newUnique)
452− $ vst
380+ $ st
453381 , pid
454382 )
455383 else
456− return ( LocalNodeValid
457− $ (localProcessWithId lpid ^= Just lproc)
384+ return ( (localProcessWithId lpid ^= Just lproc)
458385 . (localPidCounter ^: (+ 1))
459− $ vst
386+ $ st
460387 , pid
461388 )
462− startProcess _ LocalNodeClosed =
463− throwIO $ NodeClosedException $ localNodeId node
464389
465− cleanupProcess :: ProcessId
466− -> ValidLocalNodeState
467− -> IO (ValidLocalNodeState, [NT.Connection])
468− cleanupProcess pid vst = do
390+ cleanupProcess :: ProcessId -> LocalNodeState -> IO LocalNodeState
391+ cleanupProcess pid st = do
469392 let pid' = ProcessIdentifier pid
470− let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (vst ^. localConnections)
471− return ( (localProcessWithId (processLocalId pid) ^= Nothing)
472− . (localConnections ^= unaffected)
473− $ vst
474− , map fst $ Map.elems affected
475− )
393+ let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (st ^. localConnections)
394+ mapM_ (NT.close . fst) (Map.elems affected)
395+ return $ (localProcessWithId (processLocalId pid) ^= Nothing)
396+ . (localConnections ^= unaffected)
397+ $ st
476398
477399-- note [tracer/forkProcess races]
478400--
@@ -492,7 +414,7 @@ type IncomingConnection = (NT.EndPointAddress, IncomingTarget)
492414data IncomingTarget =
493415 Uninit
494416 | ToProc ProcessId (Weak (CQueue Message))
495− | ToChan SendPortId TypedChannel
417+ | ToChan TypedChannel
496418 | ToNode
497419
498420data ConnectionState = ConnectionState {
@@ -519,7 +441,6 @@ incomingFrom addr = aux >>> DAC.mapDefault Set.empty addr
519441
520442handleIncomingMessages :: LocalNode -> IO ()
521443handleIncomingMessages node = go initConnectionState
522− `Exception.catch` \(NodeClosedException _) -> return ()
523444 where
524445 go :: ConnectionState -> IO ()
525446 go !st = do
@@ -534,8 +455,7 @@ handleIncomingMessages node = go initConnectionState
534455 . (incomingFrom theirAddr ^: Set.insert cid)
535456 $ st
536457 )
537− else invalidRequest cid st $
538− "attempt to connect with unsupported reliability " ++ show rel
458+ else invalidRequest cid st
539459 NT.Received cid payload ->
540460 case st ^. incomingAt cid of
541461 Just (_, ToProc pid weakQueue) -> do
@@ -547,17 +467,13 @@ handleIncomingMessages node = go initConnectionState
547467 enqueue queue msg -- 'enqueue' is strict
548468 trace node (MxReceived pid msg)
549469 go st
550− Just (_, ToChan chId (TypedChannel chan')) -> do
470+ Just (_, ToChan (TypedChannel chan')) -> do
551471 mChan <- deRefWeak chan'
552472 -- If mChan is Nothing, the process has given up the read end of
553473 -- the channel and we simply ignore the incoming message
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'
474+ forM_ mChan $ \chan -> atomically $
475+ -- We make sure the message is fully decoded when it is enqueued
476+ writeTQueue chan $! decode (BSL.fromChunks payload)
561477 go st
562478 Just (_, ToNode) -> do
563479 let ctrlMsg = decode . BSL.fromChunks $ payload
@@ -567,47 +483,36 @@ handleIncomingMessages node = go initConnectionState
567483 case decode (BSL.fromChunks payload) of
568484 ProcessIdentifier pid -> do
569485 let lpid = processLocalId pid
570− mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
486+ mProc <- withMVar state $ return . (^. localProcessWithId lpid)
571487 case mProc of
572488 Just proc ->
573489 go (incomingAt cid ^= Just (src, ToProc pid (processWeakQ proc)) $ st)
574490 Nothing ->
575− -- incoming attempt to connect to unknown process - might
576− -- be dead already
577− go (incomingAt cid ^= Nothing $ st)
491+ invalidRequest cid st
578492 SendPortIdentifier chId -> do
579493 let lcid = sendPortLocalId chId
580494 lpid = processLocalId (sendPortProcessId chId)
581− mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
495+ mProc <- withMVar state $ return . (^. localProcessWithId lpid)
582496 case mProc of
583497 Just proc -> do
584498 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
585499 case mChannel of
586500 Just channel ->
587− go (incomingAt cid ^= Just (src, ToChan chId channel) $ st)
501+ go (incomingAt cid ^= Just (src, ToChan channel) $ st)
588502 Nothing ->
589− invalidRequest cid st $
590− "incoming attempt to connect to unknown channel of"
591− ++ " process " ++ show (sendPortProcessId chId)
503+ invalidRequest cid st
592504 Nothing ->
593− -- incoming attempt to connect to channel of unknown
594− -- process - might be dead already
595− go (incomingAt cid ^= Nothing $ st)
505+ invalidRequest cid st
596506 NodeIdentifier nid ->
597507 if nid == localNodeId node
598508 then go (incomingAt cid ^= Just (src, ToNode) $ 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
509+ else invalidRequest cid st
604510 Nothing ->
605511 invalidRequest cid st
606− "message received from an unknown connection"
607512 NT.ConnectionClosed cid ->
608513 case st ^. incomingAt cid of
609514 Nothing ->
610− invalidRequest cid st "closed unknown connection"
515+ invalidRequest cid st
611516 Just (src, _) -> do
612517 trace node (MxDisconnected cid src)
613518 go ( (incomingAt cid ^= Nothing)
@@ -638,20 +543,19 @@ handleIncomingMessages node = go initConnectionState
638543 -- and we just give up
639544 fail "Cloud Haskell fatal error: received unexpected multicast"
640545
641− invalidRequest :: NT.ConnectionId -> ConnectionState -> String -> IO ()
642− invalidRequest cid st msg = do
546+ invalidRequest :: NT.ConnectionId -> ConnectionState -> IO ()
547+ invalidRequest cid st = do
643548 -- TODO: We should treat this as a fatal error on the part of the remote
644549 -- node. That is, we should report the remote node as having died, and we
645550 -- should close incoming connections (this requires a Transport layer
646551 -- extension).
647− traceEventFmtIO node "" [ TraceStr $ " [network] invalid request"
648− ++ " (" ++ msg ++ "): "
649− , (Trace cid)
650− ]
552+ traceEventFmtIO node "" [(TraceStr " [network] invalid request: "),
553+ (Trace cid)]
651554 go ( incomingAt cid ^= Nothing
652555 $ st
653556 )
654557
558+ state = localState node
655559 endpoint = localEndPoint node
656560 ctrlChan = localCtrlChan node
657561
@@ -660,9 +564,8 @@ handleIncomingMessages node = go initConnectionState
660564--------------------------------------------------------------------------------
661565
662566runNodeController :: LocalNode -> IO ()
663−runNodeController node =
664− runReaderT (evalStateT (unNC nodeController) initNCState) node
665− `Exception.catch` \(NodeClosedException _) -> return ()
567+runNodeController =
568+ runReaderT (evalStateT (unNC nodeController) initNCState)
666569
667570--------------------------------------------------------------------------------
668571-- Internal data types --
@@ -670,26 +573,20 @@ runNodeController node =
670573
671574data NCState = NCState
672575 { -- Mapping from remote processes to linked local processes
673− _links :: !(BiMultiMap Identifier ProcessId ())
576+ _links :: !(Map Identifier (Set ProcessId))
674577 -- Mapping from remote processes to monitoring local processes
675− , _monitors :: !(BiMultiMap Identifier ProcessId MonitorRef)
578+ , _monitors :: !(Map Identifier (Set (ProcessId, MonitorRef)))
676579 -- Process registry: names and where they live, mapped to the PIDs
677580 , _registeredHere :: !(Map String ProcessId)
678581 , _registeredOnNodes :: !(Map ProcessId [(NodeId,Int)])
679582 }
680583
681584newtype NC a = NC { unNC :: StateT NCState (ReaderT LocalNode IO) a }
682− deriving ( Applicative
683− , Functor
684− , Monad
685− , MonadIO
686− , MonadState NCState
687− , MonadReader LocalNode
688− )
585+ deriving (Functor, Monad, MonadIO, MonadState NCState, MonadReader LocalNode)
689586
690587initNCState :: NCState
691−initNCState = NCState { _links = BiMultiMap.empty
692− , _monitors = BiMultiMap.empty
588+initNCState = NCState { _links = Map.empty
589+ , _monitors = Map.empty
693590 , _registeredHere = Map.empty
694591 , _registeredOnNodes = Map.empty
695592 }
@@ -705,33 +602,6 @@ instance Show ProcessKillException where
705602 show (ProcessKillException pid reason) =
706603 "killed-by=" ++ show pid ++ ",reason=" ++ reason
707604
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−
735605--------------------------------------------------------------------------------
736606-- Tracing/Debugging --
737607--------------------------------------------------------------------------------
@@ -774,7 +644,11 @@ nodeController = do
774644 -- [Unified: Table 7, rule nc_forward]
775645 case destNid (ctrlMsgSignal msg) of
776646 Just nid' | nid' /= localNodeId node ->
777− ncSendToNode nid' msg
647+ liftIO $ sendBinary node
648+ (ctrlMsgSender msg)
649+ (NodeIdentifier nid')
650+ WithImplicitReconnect
651+ msg
778652 _ ->
779653 return ()
780654
@@ -797,8 +671,6 @@ nodeController = do
797671 ncEffectWhereIs from label
798672 NCMsg _ (NamedSend label msg') ->
799673 ncEffectNamedSend label msg'
800− NCMsg _ (UnreliableSend lpid msg') ->
801− ncEffectLocalSend node (ProcessId (localNodeId node) lpid) msg'
802674 NCMsg _ (LocalSend to msg') ->
803675 ncEffectLocalSend node to msg'
804676 NCMsg _ (LocalPortSend to msg') ->
@@ -812,9 +684,8 @@ nodeController = do
812684 NCMsg _ SigShutdown ->
813685 liftIO $ do
814686 NT.closeEndPoint (localEndPoint node)
815− `Exception.finally` throwIO (NodeClosedException $ localNodeId node)
816− NCMsg (ProcessIdentifier from) (GetNodeStats nid) ->
817− ncEffectGetNodeStats from nid
687+ `Exception.finally` throwIO ThreadKilled
688+ -- ThreadKilled seems to make more sense than fail/error here
818689 unexpected ->
819690 error $ "nodeController: unexpected message " ++ show unexpected
820691
@@ -832,18 +703,22 @@ ncEffectMonitor from them mRef = do
832703 case (shouldLink, isLocal node (ProcessIdentifier from)) of
833704 (True, _) -> -- [Unified: first rule]
834705 case mRef of
835− Just ref -> modify' $ monitors ^: BiMultiMap.insert them from ref
836− Nothing -> modify' $ links ^: BiMultiMap.insert them from ()
706+ Just ref -> modify' $ monitorsFor them ^: Set.insert (from, ref)
707+ Nothing -> modify' $ linksFor them ^: Set.insert from
837708 (False, True) -> -- [Unified: second rule]
838709 notifyDied from them DiedUnknownId mRef
839710 (False, False) -> -- [Unified: third rule]
840711 -- TODO: this is the right sender according to the Unified semantics,
841712 -- but perhaps having 'them' as the sender would make more sense
842713 -- (see also: notifyDied)
843− ncSendToNode (processNodeId from) $ NCMsg
844− { ctrlMsgSender = NodeIdentifier (localNodeId node)
845− , ctrlMsgSignal = Died them DiedUnknownId
846− }
714+ liftIO $ sendBinary node
715+ (NodeIdentifier $ localNodeId node)
716+ (NodeIdentifier $ processNodeId from)
717+ WithImplicitReconnect
718+ NCMsg
719+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
720+ , ctrlMsgSignal = Died them DiedUnknownId
721+ }
847722
848723-- [Unified: Table 11]
849724ncEffectUnlink :: ProcessId -> Identifier -> NC ()
@@ -857,7 +732,7 @@ ncEffectUnlink from them = do
857732 postAsMessage from $ DidUnlinkNode nid
858733 SendPortIdentifier cid ->
859734 postAsMessage from $ DidUnlinkPort cid
860− modify' $ links ^: BiMultiMap.delete them from ()
735+ modify' $ linksFor them ^: Set.delete from
861736
862737-- [Unified: Table 11]
863738ncEffectUnmonitor :: ProcessId -> MonitorRef -> NC ()
@@ -865,7 +740,7 @@ ncEffectUnmonitor from ref = do
865740 node <- ask
866741 when (isLocal node (ProcessIdentifier from)) $
867742 postAsMessage from $ DidUnmonitor ref
868− modify' $ monitors ^: BiMultiMap.delete (monitorRefIdent ref) from ref
743+ modify' $ monitorsFor (monitorRefIdent ref) ^: Set.delete (from, ref)
869744
870745-- [Unified: Table 12]
871746ncEffectDied :: Identifier -> DiedReason -> NC ()
@@ -880,7 +755,7 @@ ncEffectDied ident reason = do
880755 let localOnly = case ident of NodeIdentifier _ -> True ; _ -> False
881756
882757 forM_ (Map.toList affectedLinks) $ \(them, uss) ->
883− forM_ uss $ \(us, _) ->
758+ forM_ uss $ \us ->
884759 when (localOnly <= isLocal node (ProcessIdentifier us)) $
885760 notifyDied us them reason Nothing
886761
@@ -889,35 +764,9 @@ ncEffectDied ident reason = do
889764 when (localOnly <= isLocal node (ProcessIdentifier us)) $
890765 notifyDied us them reason (Just ref)
891766
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
767+ modify' $ (links ^= unaffectedLinks) . (monitors ^= unaffectedMons)
768+
769+ modify' $ registeredHere ^: Map.filter (\pid -> not $ ident `impliesDeathOf` ProcessIdentifier pid)
921770
922771 remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
923772 mapM (\(pid,nidlist) ->
@@ -925,15 +774,20 @@ ncEffectDied ident reason = do
925774 True ->
926775 do forM_ nidlist $ \(nid,_) ->
927776 when (not $ isLocal node (NodeIdentifier nid))
928− (forwardDeath node nid)
777+ (forwardNameDeath node nid)
929778 return Nothing
930779 False -> return $ Just (pid,nidlist) )
931780 modify' $ registeredOnNodes ^= (Map.fromList (catMaybes remaining))
932781 where
933− forwardDeath node nid = ncSendToNode nid
934− NCMsg { ctrlMsgSender = NodeIdentifier (localNodeId node)
935− , ctrlMsgSignal = Died ident reason
936− }
782+ forwardNameDeath node nid =
783+ liftIO $ sendBinary node
784+ (NodeIdentifier $ localNodeId node)
785+ (NodeIdentifier $ nid)
786+ WithImplicitReconnect
787+ NCMsg
788+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
789+ , ctrlMsgSignal = Died ident reason
790+ }
937791
938792-- [Unified: Table 13]
939793ncEffectSpawn :: ProcessId -> Closure (Process ()) -> SpawnRef -> NC ()
@@ -947,7 +801,11 @@ ncEffectSpawn pid cProc ref = do
947801 Right p -> p
948802 node <- ask
949803 pid' <- liftIO $ forkProcess node proc
950− ncSendToProcess pid $ unsafeCreateUnencodedMessage $ DidSpawn ref pid'
804+ liftIO $ sendMessage node
805+ (NodeIdentifier (localNodeId node))
806+ (ProcessIdentifier pid)
807+ WithImplicitReconnect
808+ (DidSpawn ref pid')
951809
952810-- Unified semantics does not explicitly describe how to implement 'register',
953811-- but mentions it's "very similar to nsend" (Table 14)
@@ -965,19 +823,17 @@ ncEffectRegister from label atnode mPid reregistration = do
965823 return $ (isNothing currentVal /= reregistration) &&
966824 (not (isLocal node (ProcessIdentifier thepid) ) || isvalidlocal )
967825 if isLocal node (NodeIdentifier atnode)
968− then do when isOk $
826+ then do when (isOk) $
969827 do modify' $ registeredHereFor label ^= mPid
970828 updateRemote node currentVal mPid
971829 case mPid of
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)
830+ (Just p) -> liftIO $ trace node (MxRegistered p label)
977831 Nothing -> liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
978− newVal <- gets (^. registeredHereFor label)
979− ncSendToProcess from $ unsafeCreateUnencodedMessage $
980− RegisterReply label isOk newVal
832+ liftIO $ sendMessage node
833+ (NodeIdentifier (localNodeId node))
834+ (ProcessIdentifier from)
835+ WithImplicitReconnect
836+ (RegisterReply label isOk)
981837 else let operation =
982838 case reregistration of
983839 True -> flip decList
@@ -1007,36 +863,40 @@ ncEffectRegister from label atnode mPid reregistration = do
1007863 decList (x:xs) tag = x:decList xs tag
1008864 forward node to reg =
1009865 when (not $ isLocal node (NodeIdentifier to)) $
1010− ncSendToNode to $ NCMsg { ctrlMsgSender = ProcessIdentifier from
1011− , ctrlMsgSignal = reg
1012− }
866+ liftIO $ sendBinary node
867+ (ProcessIdentifier from)
868+ (NodeIdentifier to)
869+ WithImplicitReconnect
870+ NCMsg
871+ { ctrlMsgSender = ProcessIdentifier from
872+ , ctrlMsgSignal = reg
873+ }
1013874
1014875
1015876-- Unified semantics does not explicitly describe 'whereis'
1016877ncEffectWhereIs :: ProcessId -> String -> NC ()
1017878ncEffectWhereIs from label = do
879+ node <- ask
1018880 mPid <- gets (^. registeredHereFor label)
1019− ncSendToProcess from $ unsafeCreateUnencodedMessage $ WhereIsReply label mPid
881+ liftIO $ sendMessage node
882+ (NodeIdentifier (localNodeId node))
883+ (ProcessIdentifier from)
884+ WithImplicitReconnect
885+ (WhereIsReply label mPid)
1020886
1021887-- [Unified: Table 14]
1022888ncEffectNamedSend :: String -> Message -> NC ()
1023889ncEffectNamedSend label msg = do
1024890 mPid <- gets (^. registeredHereFor label)
1025891 -- If mPid is Nothing, we just ignore the named send (as per Table 14)
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
892+ forM_ mPid $ \pid -> postMessage pid msg
1030893
1031894-- [Issue #DP-20]
1032895ncEffectLocalSend :: LocalNode -> ProcessId -> Message -> NC ()
1033−ncEffectLocalSend = ncEffectLocalSendAndTrace True
1034−
1035−ncEffectLocalSendAndTrace :: Bool -> LocalNode -> ProcessId -> Message -> NC ()
1036−ncEffectLocalSendAndTrace shouldTrace node to msg =
896+ncEffectLocalSend node to msg =
1037897 liftIO $ withLocalProc node to $ \p -> do
1038898 enqueue (processQueue p) msg
1039− when shouldTrace $ trace node (MxReceived to msg)
899+ trace node (MxReceived to msg)
1040900
1041901-- [Issue #DP-20]
1042902ncEffectLocalPortSend :: SendPortId -> Message -> NC ()
@@ -1054,12 +914,11 @@ ncEffectLocalPortSend from msg = do
1054914 -- If ch is Nothing, the process has given up the read end of
1055915 -- the channel and we simply ignore the incoming message - this
1056916 ch <- deRefWeak chan'
1057− forM_ ch $ \chan -> deliverChan node from msg chan
1058− where deliverChan :: forall a . LocalNode -> SendPortId -> Message -> TQueue a -> IO ()
1059− deliverChan n p (UnencodedMessage _ raw) chan' = do
917+ forM_ ch $ \chan -> deliverChan msg chan
918+ where deliverChan :: forall a . Message -> TQueue a -> IO ()
919+ deliverChan (UnencodedMessage _ raw) chan' =
1060920 atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
1061− trace n (MxReceivedPort p $ unsafeCreateUnencodedMessage raw)
1062− deliverChan _ _ (EncodedMessage _ _) _ =
921+ deliverChan (EncodedMessage _ _) _ =
1063922 -- this will not happen unless someone screws with Primitives.hs
1064923 error "invalid local channel delivery"
1065924
@@ -1084,56 +943,46 @@ ncEffectGetInfo from pid =
1084943 them = (ProcessIdentifier pid)
1085944 in do
1086945 node <- ask
1087− mProc <- liftIO $ withValidLocalState node
1088− $ return . (^. localProcessWithId lpid)
946+ mProc <- liftIO $
947+ withMVar (localState node) $ return . (^. localProcessWithId lpid)
1089948 case mProc of
1090949 Nothing -> dispatch (isLocal node (ProcessIdentifier from))
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)
950+ from node (ProcessInfoNone DiedUnknownId)
951+ Just _ -> do
952+ itsLinks <- gets (^. linksFor them)
953+ itsMons <- gets (^. monitorsFor them)
1096954 registered <- gets (^. registeredHere)
1097− size <- liftIO $ queueSize $ processQueue $ proc
1098955
1099956 let reg = registeredNames registered
1100957 dispatch (isLocal node (ProcessIdentifier from))
1101958 from
959+ node
1102960 ProcessInfo {
1103961 infoNode = (processNodeId pid)
1104962 , infoRegisteredNames = reg
1105− , infoMessageQueueLength = size
1106− , infoMonitors = Set.toList itsMons
1107− , infoLinks = Set.toList itsLinks
963+ -- we cannot populate this field
964+ , infoMessageQueueLength = Nothing
965+ , infoMonitors = Set.toList itsMons
966+ , infoLinks = Set.toList itsLinks
1108967 }
1109− where dispatch :: (Serializable a)
968+ where dispatch :: (Serializable a, Show a)
1110969 => Bool
1111970 -> ProcessId
971+ -> LocalNode
1112972 -> a
1113973 -> NC ()
1114− dispatch True dest pInfo = postAsMessage dest $ pInfo
1115− dispatch False dest pInfo =
1116− ncSendToProcess dest $ unsafeCreateUnencodedMessage pInfo
974+ dispatch True dest _ pInfo = postAsMessage dest $ pInfo
975+ dispatch False dest node pInfo = do
976+ liftIO $ sendMessage node
977+ (NodeIdentifier (localNodeId node))
978+ (ProcessIdentifier dest)
979+ WithImplicitReconnect
980+ pInfo
1117981
1118982 registeredNames = Map.foldlWithKey (\ks k v -> if v == pid
1119983 then (k:ks)
1120984 else ks) []
1121985
1122−ncEffectGetNodeStats :: ProcessId -> NodeId -> NC ()
1123−ncEffectGetNodeStats from _nid = do
1124− node <- ask
1125− ncState <- StateT.get
1126− nodeState <- liftIO $ withValidLocalState node return
1127− let stats =
1128− NodeStats {
1129− nodeStatsNode = localNodeId node
1130− , nodeStatsRegisteredNames = Map.size $ ncState ^. registeredHere
1131− , nodeStatsMonitors = BiMultiMap.size $ ncState ^. monitors
1132− , nodeStatsLinks = BiMultiMap.size $ ncState ^. links
1133− , nodeStatsProcesses = Map.size (nodeState ^. localProcesses)
1134− }
1135− postAsMessage from stats
1136−
1137986--------------------------------------------------------------------------------
1138987-- Auxiliary --
1139988--------------------------------------------------------------------------------
@@ -1160,10 +1009,14 @@ notifyDied dest src reason mRef = do
11601009 throwException dest $ PortLinkException pid reason
11611010 (False, _, _) ->
11621011 -- The change in sender comes from [Unified: Table 10]
1163− ncSendToNode (processNodeId dest) $ NCMsg
1164− { ctrlMsgSender = NodeIdentifier (localNodeId node)
1165− , ctrlMsgSignal = Died src reason
1166− }
1012+ liftIO $ sendBinary node
1013+ (NodeIdentifier $ localNodeId node)
1014+ (NodeIdentifier $ processNodeId dest)
1015+ WithImplicitReconnect
1016+ NCMsg
1017+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
1018+ , ctrlMsgSignal = Died src reason
1019+ }
11671020
11681021-- | [Unified: Table 8]
11691022destNid :: ProcessSignal -> Maybe NodeId
@@ -1175,7 +1028,6 @@ destNid (Spawn _ _) = Nothing
11751028destNid (Register _ _ _ _) = Nothing
11761029destNid (WhereIs _) = Nothing
11771030destNid (NamedSend _ _) = Nothing
1178−destNid (UnreliableSend _ _) = Nothing
11791031-- We don't need to forward 'Died' signals; if monitoring/linking is setup,
11801032-- then when a local process dies the monitoring/linking machinery will take
11811033-- care of notifying remote nodes
@@ -1183,7 +1035,6 @@ destNid (Died _ _) = Nothing
11831035destNid (Kill pid _) = Just $ processNodeId pid
11841036destNid (Exit pid _) = Just $ processNodeId pid
11851037destNid (GetInfo pid) = Just $ processNodeId pid
1186−destNid (GetNodeStats nid) = Just nid
11871038destNid (LocalSend pid _) = Just $ processNodeId pid
11881039destNid (LocalPortSend cid _) = Just $ processNodeId (sendPortProcessId cid)
11891040destNid (SigShutdown) = Nothing
@@ -1202,7 +1053,7 @@ unClosure closure = do
12021053isValidLocalIdentifier :: Identifier -> NC Bool
12031054isValidLocalIdentifier ident = do
12041055 node <- ask
1205− liftIO . withValidLocalState node $ \nSt ->
1056+ liftIO . withMVar (localState node) $ \nSt ->
12061057 case ident of
12071058 NodeIdentifier nid ->
12081059 return $ nid == localNodeId node
@@ -1233,9 +1084,6 @@ postMessage pid msg = do
12331084throwException :: Exception e => ProcessId -> e -> NC ()
12341085throwException pid e = do
12351086 node <- ask
1236− -- throwTo blocks until the exception is received by the target thread.
1237− -- We cannot easily make it happen asynchronpusly because then 'unlink'
1238− -- semantics would break.
12391087 liftIO $ withLocalProc node pid $ \p -> throwTo (processThread p) e
12401088
12411089withLocalProc :: LocalNode -> ProcessId -> (LocalProcess -> IO ()) -> IO ()
@@ -1243,17 +1091,17 @@ withLocalProc node pid p =
12431091 -- By [Unified: table 6, rule missing_process] messages to dead processes
12441092 -- can silently be dropped
12451093 let lpid = processLocalId pid in do
1246− join $ withValidLocalState node $ \vst ->
1247− return $ forM_ (vst ^. localProcessWithId lpid) p
1094+ mProc <- withMVar (localState node) $ return . (^. localProcessWithId lpid)
1095+ forM_ mProc p
12481096
12491097--------------------------------------------------------------------------------
12501098-- Accessors --
12511099--------------------------------------------------------------------------------
12521100
1253−links :: Accessor NCState (BiMultiMap Identifier ProcessId ())
1101+links :: Accessor NCState (Map Identifier (Set ProcessId))
12541102links = accessor _links (\ls st -> st { _links = ls })
12551103
1256−monitors :: Accessor NCState (BiMultiMap Identifier ProcessId MonitorRef)
1104+monitors :: Accessor NCState (Map Identifier (Set (ProcessId, MonitorRef)))
12571105monitors = accessor _monitors (\ms st -> st { _monitors = ms })
12581106
12591107registeredHere :: Accessor NCState (Map String ProcessId)
@@ -1262,6 +1110,12 @@ registeredHere = accessor _registeredHere (\ry st -> st { _registeredHere = ry }
12621110registeredOnNodes :: Accessor NCState (Map ProcessId [(NodeId, Int)])
12631111registeredOnNodes = accessor _registeredOnNodes (\ry st -> st { _registeredOnNodes = ry })
12641112
1113+linksFor :: Identifier -> Accessor NCState (Set ProcessId)
1114+linksFor ident = links >>> DAC.mapDefault Set.empty ident
1115+
1116+monitorsFor :: Identifier -> Accessor NCState (Set (ProcessId, MonitorRef))
1117+monitorsFor ident = monitors >>> DAC.mapDefault Set.empty ident
1118+
12651119registeredHereFor :: String -> Accessor NCState (Maybe ProcessId)
12661120registeredHereFor ident = registeredHere >>> DAC.mapMaybe ident
12671121
@@ -1288,12 +1142,10 @@ registeredOnNodesFor ident = registeredOnNodes >>> DAC.mapMaybe ident
12881142-- * the notifications for typed channels to that process.
12891143--
12901144-- See https://github.com/haskell/containers/issues/14 for the bang on _v.
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)
1145+splitNotif :: Identifier
1146+ -> Map Identifier a
1147+ -> (Map Identifier a, Map Identifier a)
1148+splitNotif ident = Map.partitionWithKey (\k !_v -> ident `impliesDeathOf` k)
12971149
12981150--------------------------------------------------------------------------------
12991151-- Auxiliary --
src/Control/Distributed/Process/Serializable.hs+8−18
@@ -1,8 +1,3 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE UndecidableInstances #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE GADTs #-}
61module Control.Distributed.Process.Serializable
72 ( Serializable
83 , encodeFingerprint
@@ -12,33 +7,28 @@ module Control.Distributed.Process.Serializable
127 , Fingerprint
138 , showFingerprint
149 , SerializableDict(SerializableDict)
15− , TypeableDict(TypeableDict)
1610 ) where
1711
1812import Data.Binary (Binary)
19−
20−import Data.Typeable (Typeable, typeRepFingerprint, typeOf)
21−
13+import Data.Typeable (Typeable(..))
14+import Data.Typeable.Internal (TypeRep(TypeRep))
2215import Numeric (showHex)
2316import Control.Exception (throw)
2417import GHC.Fingerprint.Type (Fingerprint(..))
2518import Data.ByteString (ByteString)
2619import qualified Data.ByteString as BS
27−import qualified Data.ByteString.Internal as BSI ( unsafeCreate, toForeignPtr )
20+import qualified Data.ByteString.Internal as BSI ( unsafeCreate
21+ , inlinePerformIO
22+ , toForeignPtr
23+ )
2824import Foreign.Storable (pokeByteOff, peekByteOff, sizeOf)
2925import Foreign.ForeignPtr (withForeignPtr)
30−import System.IO.Unsafe (unsafePerformIO)
3126
3227-- | Reification of 'Serializable' (see "Control.Distributed.Process.Closure")
3328data SerializableDict a where
3429 SerializableDict :: Serializable a => SerializableDict a
3530 deriving (Typeable)
3631
37−-- | Reification of 'Typeable'.
38−data TypeableDict a where
39− TypeableDict :: Typeable a => TypeableDict a
40− deriving (Typeable)
41−
4232-- | Objects that can be sent across the network
4333class (Binary a, Typeable a) => Serializable a
4434instance (Binary a, Typeable a) => Serializable a
@@ -55,7 +45,7 @@ decodeFingerprint :: ByteString -> Fingerprint
5545decodeFingerprint bs
5646 | BS.length bs /= sizeOfFingerprint =
5747 throw $ userError "decodeFingerprint: Invalid length"
58− | otherwise = unsafePerformIO $ do
48+ | otherwise = BSI.inlinePerformIO $ do
5949 let (fp, offset, _) = BSI.toForeignPtr bs
6050 withForeignPtr fp $ \p -> peekByteOff p offset
6151
@@ -65,7 +55,7 @@ sizeOfFingerprint = sizeOf (undefined :: Fingerprint)
6555
6656-- | The fingerprint of the typeRep of the argument
6757fingerprint :: Typeable a => a -> Fingerprint
68−fingerprint = typeRepFingerprint . typeOf
58+fingerprint a = let TypeRep fp _ _ = typeOf a in fp
6959
7060-- | Show fingerprint (for debugging purposes)
7161showFingerprint :: Fingerprint -> ShowS
src/Control/Distributed/Process/UnsafePrimitives.hs+31−110
@@ -32,24 +32,7 @@
3232-- the /normal/ strategy).
3333--
3434-- Use of the functions in this module can potentially change the runtime
35−-- behaviour of your application. In addition, messages passed between Cloud
36−-- Haskell processes are written to a tracing infrastructure on the local node,
37−-- to provide improved introspection and debugging facilities for complex actor
38−-- based systems. This module makes no attempt to force evaluation in these
39−-- cases either, thus evaluation problems in passed data structures could not
40−-- only crash your processes, but could also bring down critical internal
41−-- services on which the node relies to function correctly.
42−--
43−-- If you wish to repudiate such issues, you are advised to consider the use
44−-- of NFSerialisable in the distributed-process-extras package, which type
45−-- class brings NFData into scope along with Serializable, such that we can
46−-- force evaluation. Intended for use with modules such as this one, this
47−-- approach guarantees correct evaluatedness in terms of @NFData@. Please note
48−-- however, that we /cannot/ guarantee that an @NFData@ instance will behave the
49−-- same way as a @Binary@ one with regards evaluation, so it is still possible
50−-- to introduce unexpected behaviour by using /unsafe/ primitives in this way.
51−--
52−-- You have been warned!
35+-- behaviour of your application. You have been warned!
5336--
5437-- This module is exported so that you can replace the use of Cloud Haskell's
5538-- /safe/ messaging primitives. If you want to use both variants, then you can
@@ -62,8 +45,6 @@ module Control.Distributed.Process.UnsafePrimitives
6245 send
6346 , sendChan
6447 , nsend
65− , nsendRemote
66− , usend
6748 , wrapMessage
6849 ) where
6950
@@ -72,15 +53,9 @@ import Control.Distributed.Process.Internal.Messaging
7253 , sendBinary
7354 , sendCtrlMsg
7455 )
75−import Control.Distributed.Process.Management.Internal.Types
76− ( MxEvent(..)
77− )
78−import Control.Distributed.Process.Management.Internal.Trace.Types
79− ( traceEvent
80− )
56+
8157import Control.Distributed.Process.Internal.Types
8258 ( ProcessId(..)
83− , NodeId(..)
8459 , LocalNode(..)
8560 , LocalProcess(..)
8661 , Process(..)
@@ -90,111 +65,57 @@ import Control.Distributed.Process.Internal.Types
9065 , ImplicitReconnect(..)
9166 , SendPortId(..)
9267 , Message
93− , createMessage
9468 , sendPortProcessId
9569 , unsafeCreateUnencodedMessage
9670 )
9771import Control.Distributed.Process.Serializable (Serializable)
9872
99−import Control.Monad.IO.Class (liftIO)
73+import Control.Monad.IO.Class (MonadIO, liftIO)
10074import Control.Monad.Reader (ask)
10175
10276-- | Named send to a process in the local registry (asynchronous)
10377nsend :: Serializable a => String -> a -> Process ()
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))
78+nsend label msg =
79+ sendCtrlMsg Nothing (NamedSend label (unsafeCreateUnencodedMessage msg))
12780
12881-- | Send a message
12982send :: Serializable a => ProcessId -> a -> Process ()
13083send them msg = do
13184 proc <- ask
13285 let node = localNodeId (processNode proc)
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−--
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)
17698
17799-- | Send a message on a typed channel
178100sendChan :: Serializable a => SendPort a -> a -> Process ()
179101sendChan (SendPort cid) msg = do
180102 proc <- ask
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
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
194113 where
195− unsafeSendChanLocal :: SendPortId -> Message -> Process ()
196− unsafeSendChanLocal p m = sendCtrlMsg Nothing $ LocalPortSend p m
114+ unsafeSendChanLocal :: (Serializable a) => SendPortId -> a -> Process ()
115+ unsafeSendChanLocal spId msg =
116+ sendCtrlMsg Nothing $ LocalPortSend spId (unsafeCreateUnencodedMessage msg)
197117
198118-- | Create an unencoded @Message@ for any @Serializable@ type.
199119wrapMessage :: Serializable a => a -> Message
200120wrapMessage = unsafeCreateUnencodedMessage
121+
stack-ghc-7.10.3.yamldeleted−21
@@ -1,21 +0,0 @@
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.yamldeleted−23
@@ -1,23 +0,0 @@
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.yamldeleted−21
@@ -1,21 +0,0 @@
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.yamldeleted−20
@@ -1,20 +0,0 @@
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.yamldeleted−26
@@ -1,26 +0,0 @@
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.yamldeleted−22
@@ -1,22 +0,0 @@
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
tests/TestCH.hsnew file+1339
@@ -0,0 +1,1339 @@
1+module Main where
2+
3+#if ! MIN_VERSION_base(4,6,0)
4+import Prelude hiding (catch)
5+#endif
6+
7+import Data.Binary (Binary(..))
8+import Data.Typeable (Typeable)
9+import Data.Foldable (forM_)
10+import Control.Concurrent (forkIO, threadDelay, myThreadId, throwTo, ThreadId)
11+import Control.Concurrent.MVar
12+ ( MVar
13+ , newEmptyMVar
14+ , putMVar
15+ , takeMVar
16+ , readMVar
17+ )
18+import Control.Monad (replicateM_, replicateM, forever, void)
19+import Control.Exception (SomeException, throwIO)
20+import qualified Control.Exception as Ex (catch)
21+import Control.Applicative ((<$>), (<*>), pure, (<|>))
22+import qualified Network.Transport as NT (Transport, closeEndPoint)
23+import Network.Socket (sClose)
24+import Network.Transport.TCP
25+ ( createTransportExposeInternals
26+ , TransportInternals(socketBetween)
27+ , defaultTCPParameters
28+ )
29+import Control.Distributed.Process
30+import Control.Distributed.Process.Internal.Types
31+ ( NodeId(nodeAddress)
32+ , LocalNode(localEndPoint)
33+ , ProcessExitException(..)
34+ , nullProcessId
35+ )
36+import Control.Distributed.Process.Node
37+import Control.Distributed.Process.Serializable (Serializable)
38+
39+import Test.HUnit (Assertion, assertFailure)
40+import Test.Framework (Test, defaultMain, testGroup)
41+import Test.Framework.Providers.HUnit (testCase)
42+import Control.Rematch hiding (match)
43+import Control.Rematch.Run (Match(..))
44+
45+newtype Ping = Ping ProcessId
46+ deriving (Typeable, Binary, Show)
47+
48+newtype Pong = Pong ProcessId
49+ deriving (Typeable, Binary, Show)
50+
51+--------------------------------------------------------------------------------
52+-- Supporting definitions --
53+--------------------------------------------------------------------------------
54+
55+expectThat :: a -> Matcher a -> Assertion
56+expectThat a matcher = case res of
57+ MatchSuccess -> return ()
58+ (MatchFailure msg) -> assertFailure msg
59+ where res = runMatch matcher a
60+
61+-- | Like fork, but throw exceptions in the child thread to the parent
62+forkTry :: IO () -> IO ThreadId
63+forkTry p = do
64+ tid <- myThreadId
65+ forkIO $ Ex.catch p (\e -> throwTo tid (e :: SomeException))
66+
67+-- | The ping server from the paper
68+ping :: Process ()
69+ping = do
70+ Pong partner <- expect
71+ self <- getSelfPid
72+ send partner (Ping self)
73+ ping
74+
75+-- | Quick and dirty synchronous version of whereisRemoteAsync
76+whereisRemote :: NodeId -> String -> Process (Maybe ProcessId)
77+whereisRemote nid string = do
78+ whereisRemoteAsync nid string
79+ WhereIsReply _ mPid <- expect
80+ return mPid
81+
82+data Add = Add ProcessId Double Double deriving (Typeable)
83+data Divide = Divide ProcessId Double Double deriving (Typeable)
84+data DivByZero = DivByZero deriving (Typeable)
85+
86+instance Binary Add where
87+ put (Add pid x y) = put pid >> put x >> put y
88+ get = Add <$> get <*> get <*> get
89+
90+instance Binary Divide where
91+ put (Divide pid x y) = put pid >> put x >> put y
92+ get = Divide <$> get <*> get <*> get
93+
94+instance Binary DivByZero where
95+ put DivByZero = return ()
96+ get = return DivByZero
97+
98+-- The math server from the paper
99+math :: Process ()
100+math = do
101+ receiveWait
102+ [ match (\(Add pid x y) -> send pid (x + y))
103+ , matchIf (\(Divide _ _ y) -> y /= 0)
104+ (\(Divide pid x y) -> send pid (x / y))
105+ , match (\(Divide pid _ _) -> send pid DivByZero)
106+ ]
107+ math
108+
109+-- | Monitor or link to a remote node
110+monitorOrLink :: Bool -- ^ 'True' for monitor, 'False' for link
111+ -> ProcessId -- Process to monitor/link to
112+ -> Maybe (MVar ()) -- MVar to signal on once the monitor has been set up
113+ -> Process (Maybe MonitorRef)
114+monitorOrLink mOrL pid mSignal = do
115+ result <- if mOrL then Just <$> monitor pid
116+ else link pid >> return Nothing
117+ -- Monitor is asynchronous, which usually does not matter but if we want a
118+ -- *specific* signal then it does. Therefore we wait an arbitrary delay and
119+ -- hope that this means the monitor has been set up
120+ forM_ mSignal $ \signal -> liftIO . forkIO $ threadDelay 100000 >> putMVar signal ()
121+ return result
122+
123+monitorTestProcess :: ProcessId -- Process to monitor/link to
124+ -> Bool -- 'True' for monitor, 'False' for link
125+ -> Bool -- Should we unmonitor?
126+ -> DiedReason -- Expected cause of death
127+ -> Maybe (MVar ()) -- Signal for 'monitor set up'
128+ -> MVar () -- Signal for successful termination
129+ -> Process ()
130+monitorTestProcess theirAddr mOrL un reason monitorSetup done =
131+ catch (do mRef <- monitorOrLink mOrL theirAddr monitorSetup
132+ case (un, mRef) of
133+ (True, Nothing) -> do
134+ unlink theirAddr
135+ liftIO $ putMVar done ()
136+ (True, Just ref) -> do
137+ unmonitor ref
138+ liftIO $ putMVar done ()
139+ (False, ref) -> do
140+ ProcessMonitorNotification ref' pid reason' <- expect
141+ True <- return $ Just ref' == ref && pid == theirAddr && mOrL && reason == reason'
142+ liftIO $ putMVar done ()
143+ )
144+ (\(ProcessLinkException pid reason') -> do
145+ True <- return $ pid == theirAddr && not mOrL && not un && reason == reason'
146+ liftIO $ putMVar done ()
147+ )
148+
149+--------------------------------------------------------------------------------
150+-- The tests proper --
151+--------------------------------------------------------------------------------
152+
153+-- | Basic ping test
154+testPing :: NT.Transport -> Assertion
155+testPing transport = do
156+ serverAddr <- newEmptyMVar
157+ clientDone <- newEmptyMVar
158+
159+ -- Server
160+ forkIO $ do
161+ localNode <- newLocalNode transport initRemoteTable
162+ addr <- forkProcess localNode ping
163+ putMVar serverAddr addr
164+
165+ -- Client
166+ forkIO $ do
167+ localNode <- newLocalNode transport initRemoteTable
168+ pingServer <- readMVar serverAddr
169+
170+ let numPings = 10000
171+
172+ runProcess localNode $ do
173+ pid <- getSelfPid
174+ replicateM_ numPings $ do
175+ send pingServer (Pong pid)
176+ Ping _ <- expect
177+ return ()
178+
179+ putMVar clientDone ()
180+
181+ takeMVar clientDone
182+
183+-- | Monitor a process on an unreachable node
184+testMonitorUnreachable :: NT.Transport -> Bool -> Bool -> Assertion
185+testMonitorUnreachable transport mOrL un = do
186+ deadProcess <- newEmptyMVar
187+ done <- newEmptyMVar
188+
189+ forkIO $ do
190+ localNode <- newLocalNode transport initRemoteTable
191+ addr <- forkProcess localNode . liftIO $ threadDelay 1000000
192+ closeLocalNode localNode
193+ putMVar deadProcess addr
194+
195+ forkIO $ do
196+ localNode <- newLocalNode transport initRemoteTable
197+ theirAddr <- readMVar deadProcess
198+ runProcess localNode $
199+ monitorTestProcess theirAddr mOrL un DiedDisconnect Nothing done
200+
201+ takeMVar done
202+
203+-- | Monitor a process which terminates normally
204+testMonitorNormalTermination :: NT.Transport -> Bool -> Bool -> Assertion
205+testMonitorNormalTermination transport mOrL un = do
206+ monitorSetup <- newEmptyMVar
207+ monitoredProcess <- newEmptyMVar
208+ done <- newEmptyMVar
209+
210+ forkIO $ do
211+ localNode <- newLocalNode transport initRemoteTable
212+ addr <- forkProcess localNode $
213+ liftIO $ readMVar monitorSetup
214+ putMVar monitoredProcess addr
215+
216+ forkIO $ do
217+ localNode <- newLocalNode transport initRemoteTable
218+ theirAddr <- readMVar monitoredProcess
219+ runProcess localNode $
220+ monitorTestProcess theirAddr mOrL un DiedNormal (Just monitorSetup) done
221+
222+ takeMVar done
223+
224+-- | Monitor a process which terminates abnormally
225+testMonitorAbnormalTermination :: NT.Transport -> Bool -> Bool -> Assertion
226+testMonitorAbnormalTermination transport mOrL un = do
227+ monitorSetup <- newEmptyMVar
228+ monitoredProcess <- newEmptyMVar
229+ done <- newEmptyMVar
230+
231+ let err = userError "Abnormal termination"
232+
233+ forkIO $ do
234+ localNode <- newLocalNode transport initRemoteTable
235+ addr <- forkProcess localNode . liftIO $ do
236+ readMVar monitorSetup
237+ throwIO err
238+ putMVar monitoredProcess addr
239+
240+ forkIO $ do
241+ localNode <- newLocalNode transport initRemoteTable
242+ theirAddr <- readMVar monitoredProcess
243+ runProcess localNode $
244+ monitorTestProcess theirAddr mOrL un (DiedException (show err)) (Just monitorSetup) done
245+
246+ takeMVar done
247+
248+-- | Monitor a local process that is already dead
249+testMonitorLocalDeadProcess :: NT.Transport -> Bool -> Bool -> Assertion
250+testMonitorLocalDeadProcess transport mOrL un = do
251+ processDead <- newEmptyMVar
252+ processAddr <- newEmptyMVar
253+ localNode <- newLocalNode transport initRemoteTable
254+ done <- newEmptyMVar
255+
256+ forkIO $ do
257+ addr <- forkProcess localNode . liftIO $ putMVar processDead ()
258+ putMVar processAddr addr
259+
260+ forkIO $ do
261+ theirAddr <- readMVar processAddr
262+ readMVar processDead
263+ runProcess localNode $ do
264+ monitorTestProcess theirAddr mOrL un DiedUnknownId Nothing done
265+
266+ takeMVar done
267+
268+-- | Monitor a remote process that is already dead
269+testMonitorRemoteDeadProcess :: NT.Transport -> Bool -> Bool -> Assertion
270+testMonitorRemoteDeadProcess transport mOrL un = do
271+ processDead <- newEmptyMVar
272+ processAddr <- newEmptyMVar
273+ done <- newEmptyMVar
274+
275+ forkIO $ do
276+ localNode <- newLocalNode transport initRemoteTable
277+ addr <- forkProcess localNode . liftIO $ putMVar processDead ()
278+ putMVar processAddr addr
279+
280+ forkIO $ do
281+ localNode <- newLocalNode transport initRemoteTable
282+ theirAddr <- readMVar processAddr
283+ readMVar processDead
284+ runProcess localNode $ do
285+ monitorTestProcess theirAddr mOrL un DiedUnknownId Nothing done
286+
287+ takeMVar done
288+
289+-- | Monitor a process that becomes disconnected
290+testMonitorDisconnect :: NT.Transport -> Bool -> Bool -> Assertion
291+testMonitorDisconnect transport mOrL un = do
292+ processAddr <- newEmptyMVar
293+ monitorSetup <- newEmptyMVar
294+ done <- newEmptyMVar
295+
296+ forkIO $ do
297+ localNode <- newLocalNode transport initRemoteTable
298+ addr <- forkProcess localNode . liftIO $ threadDelay 1000000
299+ putMVar processAddr addr
300+ readMVar monitorSetup
301+ NT.closeEndPoint (localEndPoint localNode)
302+
303+ forkIO $ do
304+ localNode <- newLocalNode transport initRemoteTable
305+ theirAddr <- readMVar processAddr
306+ runProcess localNode $ do
307+ monitorTestProcess theirAddr mOrL un DiedDisconnect (Just monitorSetup) done
308+
309+ takeMVar done
310+
311+-- | Test the math server (i.e., receiveWait)
312+testMath :: NT.Transport -> Assertion
313+testMath transport = do
314+ serverAddr <- newEmptyMVar
315+ clientDone <- newEmptyMVar
316+
317+ -- Server
318+ forkIO $ do
319+ localNode <- newLocalNode transport initRemoteTable
320+ addr <- forkProcess localNode math
321+ putMVar serverAddr addr
322+
323+ -- Client
324+ forkIO $ do
325+ localNode <- newLocalNode transport initRemoteTable
326+ mathServer <- readMVar serverAddr
327+
328+ runProcess localNode $ do
329+ pid <- getSelfPid
330+ send mathServer (Add pid 1 2)
331+ 3 <- expect :: Process Double
332+ send mathServer (Divide pid 8 2)
333+ 4 <- expect :: Process Double
334+ send mathServer (Divide pid 8 0)
335+ DivByZero <- expect
336+ liftIO $ putMVar clientDone ()
337+
338+ takeMVar clientDone
339+
340+-- | Send first message (i.e. connect) to an already terminated process
341+-- (without monitoring); then send another message to a second process on
342+-- the same remote node (we're checking that the remote node did not die)
343+testSendToTerminated :: NT.Transport -> Assertion
344+testSendToTerminated transport = do
345+ serverAddr1 <- newEmptyMVar
346+ serverAddr2 <- newEmptyMVar
347+ clientDone <- newEmptyMVar
348+
349+ forkIO $ do
350+ terminated <- newEmptyMVar
351+ localNode <- newLocalNode transport initRemoteTable
352+ addr1 <- forkProcess localNode $ liftIO $ putMVar terminated ()
353+ addr2 <- forkProcess localNode $ ping
354+ readMVar terminated
355+ putMVar serverAddr1 addr1
356+ putMVar serverAddr2 addr2
357+
358+ forkIO $ do
359+ localNode <- newLocalNode transport initRemoteTable
360+ server1 <- readMVar serverAddr1
361+ server2 <- readMVar serverAddr2
362+ runProcess localNode $ do
363+ pid <- getSelfPid
364+ send server1 "Hi"
365+ send server2 (Pong pid)
366+ Ping pid' <- expect
367+ True <- return $ pid' == server2
368+ liftIO $ putMVar clientDone ()
369+
370+ takeMVar clientDone
371+
372+-- | Test (non-zero) timeout
373+testTimeout :: NT.Transport -> Assertion
374+testTimeout transport = do
375+ localNode <- newLocalNode transport initRemoteTable
376+ done <- newEmptyMVar
377+
378+ runProcess localNode $ do
379+ Nothing <- receiveTimeout 1000000 [match (\(Add _ _ _) -> return ())]
380+ liftIO $ putMVar done ()
381+
382+ takeMVar done
383+
384+-- | Test zero timeout
385+testTimeout0 :: NT.Transport -> Assertion
386+testTimeout0 transport = do
387+ serverAddr <- newEmptyMVar
388+ clientDone <- newEmptyMVar
389+ messagesSent <- newEmptyMVar
390+
391+ forkIO $ do
392+ localNode <- newLocalNode transport initRemoteTable
393+ addr <- forkProcess localNode $ do
394+ liftIO $ readMVar messagesSent >> threadDelay 1000000
395+ -- Variation on the venerable ping server which uses a zero timeout
396+ -- Since we wait for all messages to be sent before doing this receive,
397+ -- we should nevertheless find the right message immediately
398+ Just partner <- receiveTimeout 0 [match (\(Pong partner) -> return partner)]
399+ self <- getSelfPid
400+ send partner (Ping self)
401+ putMVar serverAddr addr
402+
403+ forkIO $ do
404+ localNode <- newLocalNode transport initRemoteTable
405+ server <- readMVar serverAddr
406+ runProcess localNode $ do
407+ pid <- getSelfPid
408+ -- Send a bunch of messages. A large number of messages that the server
409+ -- is not interested in, and then a single message that it wants
410+ replicateM_ 10000 $ send server "Irrelevant message"
411+ send server (Pong pid)
412+ liftIO $ putMVar messagesSent ()
413+ Ping _ <- expect
414+ liftIO $ putMVar clientDone ()
415+
416+ takeMVar clientDone
417+
418+-- | Test typed channels
419+testTypedChannels :: NT.Transport -> Assertion
420+testTypedChannels transport = do
421+ serverChannel <- newEmptyMVar :: IO (MVar (SendPort (SendPort Bool, Int)))
422+ clientDone <- newEmptyMVar
423+
424+ forkIO $ do
425+ localNode <- newLocalNode transport initRemoteTable
426+ forkProcess localNode $ do
427+ (serverSendPort, rport) <- newChan
428+ liftIO $ putMVar serverChannel serverSendPort
429+ (clientSendPort, i) <- receiveChan rport
430+ sendChan clientSendPort (even i)
431+ return ()
432+
433+ forkIO $ do
434+ localNode <- newLocalNode transport initRemoteTable
435+ serverSendPort <- readMVar serverChannel
436+ runProcess localNode $ do
437+ (clientSendPort, rport) <- newChan
438+ sendChan serverSendPort (clientSendPort, 5)
439+ False <- receiveChan rport
440+ liftIO $ putMVar clientDone ()
441+
442+ takeMVar clientDone
443+
444+-- | Test merging receive ports
445+testMergeChannels :: NT.Transport -> Assertion
446+testMergeChannels transport = do
447+ localNode <- newLocalNode transport initRemoteTable
448+ testFlat localNode True "aaabbbccc"
449+ testFlat localNode False "abcabcabc"
450+ testNested localNode True True "aaabbbcccdddeeefffggghhhiii"
451+ testNested localNode True False "adgadgadgbehbehbehcficficfi"
452+ testNested localNode False True "abcabcabcdefdefdefghighighi"
453+ testNested localNode False False "adgbehcfiadgbehcfiadgbehcfi"
454+ testBlocked localNode True
455+ testBlocked localNode False
456+ where
457+ -- Single layer of merging
458+ testFlat :: LocalNode -> Bool -> String -> IO ()
459+ testFlat localNode biased expected = do
460+ done <- newEmptyMVar
461+ forkProcess localNode $ do
462+ rs <- mapM charChannel "abc"
463+ m <- mergePorts biased rs
464+ xs <- replicateM 9 $ receiveChan m
465+ True <- return $ xs == expected
466+ liftIO $ putMVar done ()
467+ takeMVar done
468+
469+ -- Two layers of merging
470+ testNested :: LocalNode -> Bool -> Bool -> String -> IO ()
471+ testNested localNode biasedInner biasedOuter expected = do
472+ done <- newEmptyMVar
473+ forkProcess localNode $ do
474+ rss <- mapM (mapM charChannel) ["abc", "def", "ghi"]
475+ ms <- mapM (mergePorts biasedInner) rss
476+ m <- mergePorts biasedOuter ms
477+ xs <- replicateM (9 * 3) $ receiveChan m
478+ True <- return $ xs == expected
479+ liftIO $ putMVar done ()
480+ takeMVar done
481+
482+ -- Test that if no messages are (immediately) available, the scheduler makes no difference
483+ testBlocked :: LocalNode -> Bool -> IO ()
484+ testBlocked localNode biased = do
485+ vs <- replicateM 3 newEmptyMVar
486+ done <- newEmptyMVar
487+
488+ forkProcess localNode $ do
489+ [sa, sb, sc] <- liftIO $ mapM readMVar vs
490+ mapM_ ((>> liftIO (threadDelay 10000)) . uncurry sendChan)
491+ [ -- a, b, c
492+ (sa, 'a')
493+ , (sb, 'b')
494+ , (sc, 'c')
495+ -- a, c, b
496+ , (sa, 'a')
497+ , (sc, 'c')
498+ , (sb, 'b')
499+ -- b, a, c
500+ , (sb, 'b')
501+ , (sa, 'a')
502+ , (sc, 'c')
503+ -- b, c, a
504+ , (sb, 'b')
505+ , (sc, 'c')
506+ , (sa, 'a')
507+ -- c, a, b
508+ , (sc, 'c')
509+ , (sa, 'a')
510+ , (sb, 'b')
511+ -- c, b, a
512+ , (sc, 'c')
513+ , (sb, 'b')
514+ , (sa, 'a')
515+ ]
516+
517+ forkProcess localNode $ do
518+ (ss, rs) <- unzip <$> replicateM 3 newChan
519+ liftIO $ mapM_ (uncurry putMVar) $ zip vs ss
520+ m <- mergePorts biased rs
521+ xs <- replicateM (6 * 3) $ receiveChan m
522+ True <- return $ xs == "abcacbbacbcacabcba"
523+ liftIO $ putMVar done ()
524+
525+ takeMVar done
526+
527+ mergePorts :: Serializable a => Bool -> [ReceivePort a] -> Process (ReceivePort a)
528+ mergePorts True = mergePortsBiased
529+ mergePorts False = mergePortsRR
530+
531+ charChannel :: Char -> Process (ReceivePort Char)
532+ charChannel c = do
533+ (sport, rport) <- newChan
534+ replicateM_ 3 $ sendChan sport c
535+ liftIO $ threadDelay 10000 -- Make sure messages have been sent
536+ return rport
537+
538+testTerminate :: NT.Transport -> Assertion
539+testTerminate transport = do
540+ localNode <- newLocalNode transport initRemoteTable
541+ done <- newEmptyMVar
542+
543+ pid <- forkProcess localNode $ do
544+ liftIO $ threadDelay 100000
545+ terminate
546+
547+ runProcess localNode $ do
548+ ref <- monitor pid
549+ ProcessMonitorNotification ref' pid' (DiedException ex) <- expect
550+ True <- return $ ref == ref' && pid == pid' && ex == show ProcessTerminationException
551+ liftIO $ putMVar done ()
552+
553+ takeMVar done
554+
555+testMonitorNode :: NT.Transport -> Assertion
556+testMonitorNode transport = do
557+ [node1, node2] <- replicateM 2 $ newLocalNode transport initRemoteTable
558+ done <- newEmptyMVar
559+
560+ closeLocalNode node1
561+
562+ runProcess node2 $ do
563+ ref <- monitorNode (localNodeId node1)
564+ NodeMonitorNotification ref' nid DiedDisconnect <- expect
565+ True <- return $ ref == ref' && nid == localNodeId node1
566+ liftIO $ putMVar done ()
567+
568+ takeMVar done
569+
570+testMonitorLiveNode :: NT.Transport -> Assertion
571+testMonitorLiveNode transport = do
572+ [node1, node2] <- replicateM 2 $ newLocalNode transport initRemoteTable
573+ ready <- newEmptyMVar
574+ done <- newEmptyMVar
575+
576+ forkProcess node2 $ do
577+ ref <- monitorNode (localNodeId node1)
578+ liftIO $ putMVar ready ()
579+ NodeMonitorNotification ref' nid _ <- expect
580+ True <- return $ ref == ref' && nid == localNodeId node1
581+ liftIO $ putMVar done ()
582+
583+ takeMVar ready
584+ closeLocalNode node1
585+
586+ takeMVar done
587+
588+testMonitorChannel :: NT.Transport -> Assertion
589+testMonitorChannel transport = do
590+ [node1, node2] <- replicateM 2 $ newLocalNode transport initRemoteTable
591+ gotNotification <- newEmptyMVar
592+
593+ pid <- forkProcess node1 $ do
594+ sport <- expect :: Process (SendPort ())
595+ ref <- monitorPort sport
596+ PortMonitorNotification ref' port' reason <- expect
597+ -- reason might be DiedUnknownId if the receive port is GCed before the
598+ -- monitor is established (TODO: not sure that this is reasonable)
599+ return $ ref' == ref && port' == sendPortId sport && (reason == DiedNormal || reason == DiedUnknownId)
600+ liftIO $ putMVar gotNotification ()
601+
602+ runProcess node2 $ do
603+ (sport, _) <- newChan :: Process (SendPort (), ReceivePort ())
604+ send pid sport
605+ liftIO $ threadDelay 100000
606+
607+ takeMVar gotNotification
608+
609+testRegistry :: NT.Transport -> Assertion
610+testRegistry transport = do
611+ node <- newLocalNode transport initRemoteTable
612+ done <- newEmptyMVar
613+
614+ pingServer <- forkProcess node ping
615+
616+ runProcess node $ do
617+ register "ping" pingServer
618+ Just pid <- whereis "ping"
619+ True <- return $ pingServer == pid
620+ us <- getSelfPid
621+ nsend "ping" (Pong us)
622+ Ping pid' <- expect
623+ True <- return $ pingServer == pid'
624+ liftIO $ putMVar done ()
625+
626+ takeMVar done
627+
628+testRemoteRegistry :: NT.Transport -> Assertion
629+testRemoteRegistry transport = do
630+ node1 <- newLocalNode transport initRemoteTable
631+ node2 <- newLocalNode transport initRemoteTable
632+ done <- newEmptyMVar
633+
634+ pingServer <- forkProcess node1 ping
635+
636+ runProcess node2 $ do
637+ let nid1 = localNodeId node1
638+ registerRemoteAsync nid1 "ping" pingServer
639+ receiveWait [
640+ matchIf (\(RegisterReply label' _) -> "ping" == label')
641+ (\(RegisterReply _ _) -> return ()) ]
642+
643+ Just pid <- whereisRemote nid1 "ping"
644+ True <- return $ pingServer == pid
645+ us <- getSelfPid
646+ nsendRemote nid1 "ping" (Pong us)
647+ Ping pid' <- expect
648+ True <- return $ pingServer == pid'
649+ liftIO $ putMVar done ()
650+
651+ takeMVar done
652+
653+testSpawnLocal :: NT.Transport -> Assertion
654+testSpawnLocal transport = do
655+ node <- newLocalNode transport initRemoteTable
656+ done <- newEmptyMVar
657+
658+ runProcess node $ do
659+ us <- getSelfPid
660+
661+ pid <- spawnLocal $ do
662+ sport <- expect
663+ sendChan sport (1234 :: Int)
664+
665+ sport <- spawnChannelLocal $ \rport -> do
666+ (1234 :: Int) <- receiveChan rport
667+ send us ()
668+
669+ send pid sport
670+ () <- expect
671+ liftIO $ putMVar done ()
672+
673+ takeMVar done
674+
675+testReconnect :: NT.Transport -> TransportInternals -> Assertion
676+testReconnect transport transportInternals = do
677+ [node1, node2] <- replicateM 2 $ newLocalNode transport initRemoteTable
678+ let nid1 = localNodeId node1
679+ nid2 = localNodeId node2
680+ processA <- newEmptyMVar
681+ [sendTestOk, registerTestOk] <- replicateM 2 newEmptyMVar
682+
683+ forkProcess node1 $ do
684+ us <- getSelfPid
685+ liftIO $ putMVar processA us
686+ msg1 <- expect
687+ msg2 <- expect
688+ True <- return $ msg1 == "message 1" && msg2 == "message 3"
689+ liftIO $ putMVar sendTestOk ()
690+
691+ forkProcess node2 $ do
692+ {-
693+ - Make sure there is no implicit reconnect on normal message sending
694+ -}
695+
696+ them <- liftIO $ readMVar processA
697+ send them "message 1" >> liftIO (threadDelay 100000)
698+
699+ -- Simulate network failure
700+ liftIO $ do
701+ sock <- socketBetween transportInternals (nodeAddress nid1) (nodeAddress nid2)
702+ sClose sock
703+ threadDelay 10000
704+
705+ -- Should not arrive
706+ send them "message 2"
707+
708+ -- Should arrive
709+ reconnect them
710+ send them "message 3"
711+
712+ liftIO $ takeMVar sendTestOk
713+
714+ {-
715+ - Test that there *is* implicit reconnect on node controller messages
716+ -}
717+
718+ us <- getSelfPid
719+ registerRemoteAsync nid1 "a" us -- registerRemote is asynchronous
720+ receiveWait [
721+ matchIf (\(RegisterReply label' _) -> "a" == label')
722+ (\(RegisterReply _ _) -> return ()) ]
723+
724+ Just _ <- whereisRemote nid1 "a"
725+
726+
727+ -- Simulate network failure
728+ liftIO $ do
729+ sock <- socketBetween transportInternals (nodeAddress nid1) (nodeAddress nid2)
730+ sClose sock
731+ threadDelay 10000
732+
733+ -- This will happen due to implicit reconnect
734+ registerRemoteAsync nid1 "b" us
735+ receiveWait [
736+ matchIf (\(RegisterReply label' _) -> "b" == label')
737+ (\(RegisterReply _ _) -> return ()) ]
738+
739+ -- Should happen
740+ registerRemoteAsync nid1 "c" us
741+ receiveWait [
742+ matchIf (\(RegisterReply label' _) -> "c" == label')
743+ (\(RegisterReply _ _) -> return ()) ]
744+
745+ -- Check
746+ Nothing <- whereisRemote nid1 "a" -- this will fail because the name is removed when the node is disconnected
747+ Just _ <- whereisRemote nid1 "b" -- this will suceed because the value is set after thereconnect
748+ Just _ <- whereisRemote nid1 "c"
749+
750+ liftIO $ putMVar registerTestOk ()
751+
752+ takeMVar registerTestOk
753+
754+-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
755+-- in between
756+testMatchAny :: NT.Transport -> Assertion
757+testMatchAny transport = do
758+ proxyAddr <- newEmptyMVar
759+ clientDone <- newEmptyMVar
760+
761+ -- Math server
762+ forkIO $ do
763+ localNode <- newLocalNode transport initRemoteTable
764+ mathServer <- forkProcess localNode math
765+ proxyServer <- forkProcess localNode $ forever $ do
766+ msg <- receiveWait [ matchAny return ]
767+ forward msg mathServer
768+ putMVar proxyAddr proxyServer
769+
770+ -- Client
771+ forkIO $ do
772+ localNode <- newLocalNode transport initRemoteTable
773+ mathServer <- readMVar proxyAddr
774+
775+ runProcess localNode $ do
776+ pid <- getSelfPid
777+ send mathServer (Add pid 1 2)
778+ 3 <- expect :: Process Double
779+ send mathServer (Divide pid 8 2)
780+ 4 <- expect :: Process Double
781+ send mathServer (Divide pid 8 0)
782+ DivByZero <- expect
783+ liftIO $ putMVar clientDone ()
784+
785+ takeMVar clientDone
786+
787+-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
788+-- in between, however we block 'Divide' requests ....
789+testMatchAnyHandle :: NT.Transport -> Assertion
790+testMatchAnyHandle transport = do
791+ proxyAddr <- newEmptyMVar
792+ clientDone <- newEmptyMVar
793+
794+ -- Math server
795+ forkIO $ do
796+ localNode <- newLocalNode transport initRemoteTable
797+ mathServer <- forkProcess localNode math
798+ proxyServer <- forkProcess localNode $ forever $ do
799+ receiveWait [
800+ matchAny (maybeForward mathServer)
801+ ]
802+ putMVar proxyAddr proxyServer
803+
804+ -- Client
805+ forkIO $ do
806+ localNode <- newLocalNode transport initRemoteTable
807+ mathServer <- readMVar proxyAddr
808+
809+ runProcess localNode $ do
810+ pid <- getSelfPid
811+ send mathServer (Add pid 1 2)
812+ 3 <- expect :: Process Double
813+ send mathServer (Divide pid 8 2)
814+ Nothing <- (expectTimeout 100000) :: Process (Maybe Double)
815+ liftIO $ putMVar clientDone ()
816+
817+ takeMVar clientDone
818+ where maybeForward :: ProcessId -> Message -> Process (Maybe ())
819+ maybeForward s msg =
820+ handleMessage msg (\m@(Add _ _ _) -> send s m)
821+
822+testMatchAnyNoHandle :: NT.Transport -> Assertion
823+testMatchAnyNoHandle transport = do
824+ addr <- newEmptyMVar
825+ clientDone <- newEmptyMVar
826+ serverDone <- newEmptyMVar
827+
828+ -- Math server
829+ forkIO $ do
830+ localNode <- newLocalNode transport initRemoteTable
831+ server <- forkProcess localNode $ forever $ do
832+ receiveWait [
833+ matchAnyIf
834+ -- the condition has type `Add -> Bool`
835+ (\(Add _ _ _) -> True)
836+ -- the match `AbstractMessage -> Process ()` will succeed!
837+ (\m -> do
838+ -- `String -> Process ()` does *not* match the input types however
839+ r <- (handleMessage m (\(_ :: String) -> die "NONSENSE" ))
840+ case r of
841+ Nothing -> return ()
842+ Just _ -> die "NONSENSE")
843+ ]
844+ -- we *must* have removed the message from our mailbox though!!!
845+ Nothing <- receiveTimeout 100000 [ match (\(Add _ _ _) -> return ()) ]
846+ liftIO $ putMVar serverDone ()
847+ putMVar addr server
848+
849+ -- Client
850+ forkIO $ do
851+ localNode <- newLocalNode transport initRemoteTable
852+ server <- readMVar addr
853+
854+ runProcess localNode $ do
855+ pid <- getSelfPid
856+ send server (Add pid 1 2)
857+ -- we only care about the client having sent a message, so we're done
858+ liftIO $ putMVar clientDone ()
859+
860+ takeMVar clientDone
861+ takeMVar serverDone
862+
863+-- | Test 'matchAnyIf'. We provide an /echo/ server, but it ignores requests
864+-- unless the text body @/= "bar"@ - this case should time out rather than
865+-- removing the message from the process mailbox.
866+testMatchAnyIf :: NT.Transport -> Assertion
867+testMatchAnyIf transport = do
868+ echoAddr <- newEmptyMVar
869+ clientDone <- newEmptyMVar
870+
871+ -- echo server
872+ forkIO $ do
873+ localNode <- newLocalNode transport initRemoteTable
874+ echoServer <- forkProcess localNode $ forever $ do
875+ receiveWait [
876+ matchAnyIf (\(_ :: ProcessId, (s :: String)) -> s /= "bar")
877+ tryHandleMessage
878+ ]
879+ putMVar echoAddr echoServer
880+
881+ -- Client
882+ forkIO $ do
883+ localNode <- newLocalNode transport initRemoteTable
884+ server <- readMVar echoAddr
885+
886+ runProcess localNode $ do
887+ pid <- getSelfPid
888+ send server (pid, "foo")
889+ "foo" <- expect
890+ send server (pid, "baz")
891+ "baz" <- expect
892+ send server (pid, "bar")
893+ Nothing <- (expectTimeout 100000) :: Process (Maybe Double)
894+ liftIO $ putMVar clientDone ()
895+
896+ takeMVar clientDone
897+ where tryHandleMessage :: Message -> Process (Maybe ())
898+ tryHandleMessage msg =
899+ handleMessage msg (\(pid :: ProcessId, (m :: String))
900+ -> do { send pid m; return () })
901+
902+testMatchMessageWithUnwrap :: NT.Transport -> Assertion
903+testMatchMessageWithUnwrap transport = do
904+ echoAddr <- newEmptyMVar
905+ clientDone <- newEmptyMVar
906+
907+ -- echo server
908+ forkIO $ do
909+ localNode <- newLocalNode transport initRemoteTable
910+ echoServer <- forkProcess localNode $ forever $ do
911+ msg <- receiveWait [
912+ matchMessage (\(m :: Message) -> do
913+ return m)
914+ ]
915+ unwrapped <- unwrapMessage msg :: Process (Maybe (ProcessId, Message))
916+ case unwrapped of
917+ (Just (p, msg')) -> forward msg' p
918+ Nothing -> die "unable to unwrap the message"
919+ putMVar echoAddr echoServer
920+
921+ -- Client
922+ forkIO $ do
923+ localNode <- newLocalNode transport initRemoteTable
924+ server <- readMVar echoAddr
925+
926+ runProcess localNode $ do
927+ pid <- getSelfPid
928+ send server (pid, wrapMessage ("foo" :: String))
929+ "foo" <- expect
930+ send server (pid, wrapMessage ("baz" :: String))
931+ "baz" <- expect
932+ liftIO $ putMVar clientDone ()
933+
934+ takeMVar clientDone
935+
936+-- Test 'receiveChanTimeout'
937+testReceiveChanTimeout :: NT.Transport -> Assertion
938+testReceiveChanTimeout transport = do
939+ done <- newEmptyMVar
940+ sendPort <- newEmptyMVar
941+
942+ forkTry $ do
943+ localNode <- newLocalNode transport initRemoteTable
944+ runProcess localNode $ do
945+ -- Create a typed channel
946+ (sp, rp) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
947+ liftIO $ putMVar sendPort sp
948+
949+ -- Wait for a message with a delay. No message arrives, we should get Nothing after 1 second
950+ Nothing <- receiveChanTimeout 1000000 rp
951+
952+ -- Wait for a message with a delay again. Now a message arrives after 0.5 seconds
953+ Just True <- receiveChanTimeout 1000000 rp
954+
955+ -- Wait for a message with zero timeout: non-blocking check. No message is available, we get Nothing
956+ Nothing <- receiveChanTimeout 0 rp
957+
958+ -- Again, but now there is a message available
959+ liftIO $ threadDelay 1000000
960+ Just False <- receiveChanTimeout 0 rp
961+
962+ liftIO $ putMVar done ()
963+
964+ forkTry $ do
965+ localNode <- newLocalNode transport initRemoteTable
966+ runProcess localNode $ do
967+ sp <- liftIO $ readMVar sendPort
968+
969+ liftIO $ threadDelay 1500000
970+ sendChan sp True
971+
972+ liftIO $ threadDelay 500000
973+ sendChan sp False
974+
975+ takeMVar done
976+
977+-- | Test Functor, Applicative, Alternative and Monad instances for ReceiveChan
978+testReceiveChanFeatures :: NT.Transport -> Assertion
979+testReceiveChanFeatures transport = do
980+ done <- newEmptyMVar
981+
982+ forkTry $ do
983+ localNode <- newLocalNode transport initRemoteTable
984+ runProcess localNode $ do
985+ (spInt, rpInt) <- newChan :: Process (SendPort Int, ReceivePort Int)
986+ (spBool, rpBool) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
987+
988+ -- Test Functor instance
989+
990+ sendChan spInt 2
991+ sendChan spBool False
992+
993+ rp1 <- mergePortsBiased [even <$> rpInt, rpBool]
994+
995+ True <- receiveChan rp1
996+ False <- receiveChan rp1
997+
998+ -- Test Applicative instance
999+
1000+ sendChan spInt 3
1001+ sendChan spInt 4
1002+
1003+ let rp2 = pure (+) <*> rpInt <*> rpInt
1004+
1005+ 7 <- receiveChan rp2
1006+
1007+ -- Test Alternative instance
1008+
1009+ sendChan spInt 3
1010+ sendChan spBool True
1011+
1012+ let rp3 = (even <$> rpInt) <|> rpBool
1013+
1014+ False <- receiveChan rp3
1015+ True <- receiveChan rp3
1016+
1017+ -- Test Monad instance
1018+
1019+ sendChan spBool True
1020+ sendChan spBool False
1021+ sendChan spInt 5
1022+
1023+ let rp4 :: ReceivePort Int
1024+ rp4 = do b <- rpBool
1025+ if b
1026+ then rpInt
1027+ else return 7
1028+
1029+ 5 <- receiveChan rp4
1030+ 7 <- receiveChan rp4
1031+
1032+ liftIO $ putMVar done ()
1033+
1034+ takeMVar done
1035+
1036+testKillLocal :: NT.Transport -> Assertion
1037+testKillLocal transport = do
1038+ localNode <- newLocalNode transport initRemoteTable
1039+ done <- newEmptyMVar
1040+
1041+ pid <- forkProcess localNode $ do
1042+ liftIO $ threadDelay 1000000
1043+
1044+ runProcess localNode $ do
1045+ ref <- monitor pid
1046+ us <- getSelfPid
1047+ kill pid "TestKill"
1048+ ProcessMonitorNotification ref' pid' (DiedException ex) <- expect
1049+ True <- return $ ref == ref' && pid == pid' && ex == "killed-by=" ++ show us ++ ",reason=TestKill"
1050+ liftIO $ putMVar done ()
1051+
1052+ takeMVar done
1053+
1054+testKillRemote :: NT.Transport -> Assertion
1055+testKillRemote transport = do
1056+ node1 <- newLocalNode transport initRemoteTable
1057+ node2 <- newLocalNode transport initRemoteTable
1058+ done <- newEmptyMVar
1059+
1060+ pid <- forkProcess node1 $ do
1061+ liftIO $ threadDelay 1000000
1062+
1063+ runProcess node2 $ do
1064+ ref <- monitor pid
1065+ us <- getSelfPid
1066+ kill pid "TestKill"
1067+ ProcessMonitorNotification ref' pid' (DiedException reason) <- expect
1068+ True <- return $ ref == ref' && pid == pid' && reason == "killed-by=" ++ show us ++ ",reason=TestKill"
1069+ liftIO $ putMVar done ()
1070+
1071+ takeMVar done
1072+
1073+testCatchesExit :: NT.Transport -> Assertion
1074+testCatchesExit transport = do
1075+ localNode <- newLocalNode transport initRemoteTable
1076+ done <- newEmptyMVar
1077+
1078+ _ <- forkProcess localNode $ do
1079+ (die ("foobar", 123 :: Int))
1080+ `catchesExit` [
1081+ (\_ m -> handleMessage m (\(_ :: String) -> return ()))
1082+ , (\_ m -> handleMessage m (\(_ :: Maybe Int) -> return ()))
1083+ , (\_ m -> handleMessage m (\(_ :: String, _ :: Int)
1084+ -> (liftIO $ putMVar done ()) >> return ()))
1085+ ]
1086+
1087+ takeMVar done
1088+
1089+testHandleMessageIf :: NT.Transport -> Assertion
1090+testHandleMessageIf transport = do
1091+ localNode <- newLocalNode transport initRemoteTable
1092+ done <- newEmptyMVar
1093+ _ <- forkProcess localNode $ do
1094+ self <- getSelfPid
1095+ send self (5 :: Integer, 10 :: Integer)
1096+ msg <- receiveWait [ matchMessage return ]
1097+ Nothing <- handleMessageIf msg (\() -> True) (\() -> die $ "whoops")
1098+ handleMessageIf msg (\(x :: Integer, y :: Integer) -> x == 5 && y == 10)
1099+ (\input -> liftIO $ putMVar done input)
1100+ return ()
1101+
1102+ result <- takeMVar done
1103+ expectThat result $ equalTo (5, 10)
1104+
1105+testCatches :: NT.Transport -> Assertion
1106+testCatches transport = do
1107+ localNode <- newLocalNode transport initRemoteTable
1108+ done <- newEmptyMVar
1109+
1110+ _ <- forkProcess localNode $ do
1111+ node <- getSelfNode
1112+ (liftIO $ throwIO (ProcessLinkException (nullProcessId node) DiedNormal))
1113+ `catches` [
1114+ Handler (\(ProcessLinkException _ _) -> liftIO $ putMVar done ())
1115+ ]
1116+
1117+ takeMVar done
1118+
1119+testMaskRestoreScope :: NT.Transport -> Assertion
1120+testMaskRestoreScope transport = do
1121+ localNode <- newLocalNode transport initRemoteTable
1122+ parentPid <- newEmptyMVar :: IO (MVar ProcessId)
1123+ spawnedPid <- newEmptyMVar :: IO (MVar ProcessId)
1124+
1125+ void $ runProcess localNode $ mask $ \unmask -> do
1126+ getSelfPid >>= liftIO . putMVar parentPid
1127+ void $ spawnLocal $ unmask (getSelfPid >>= liftIO . putMVar spawnedPid)
1128+
1129+ parent <- liftIO $ takeMVar parentPid
1130+ child <- liftIO $ takeMVar spawnedPid
1131+ expectThat parent $ isNot $ equalTo child
1132+
1133+testDie :: NT.Transport -> Assertion
1134+testDie transport = do
1135+ localNode <- newLocalNode transport initRemoteTable
1136+ done <- newEmptyMVar
1137+
1138+ _ <- forkProcess localNode $ do
1139+ (die ("foobar", 123 :: Int))
1140+ `catchExit` \_from reason -> do
1141+ -- TODO: should verify that 'from' has the right value
1142+ True <- return $ reason == ("foobar", 123 :: Int)
1143+ liftIO $ putMVar done ()
1144+
1145+ takeMVar done
1146+
1147+testPrettyExit :: NT.Transport -> Assertion
1148+testPrettyExit transport = do
1149+ localNode <- newLocalNode transport initRemoteTable
1150+ done <- newEmptyMVar
1151+
1152+ _ <- forkProcess localNode $ do
1153+ (die "timeout")
1154+ `catch` \ex@(ProcessExitException from _) ->
1155+ let expected = "exit-from=" ++ (show from)
1156+ in do
1157+ True <- return $ (show ex) == expected
1158+ liftIO $ putMVar done ()
1159+
1160+ takeMVar done
1161+
1162+testExitLocal :: NT.Transport -> Assertion
1163+testExitLocal transport = do
1164+ localNode <- newLocalNode transport initRemoteTable
1165+ supervisedDone <- newEmptyMVar
1166+ supervisorDone <- newEmptyMVar
1167+
1168+ pid <- forkProcess localNode $ do
1169+ (liftIO $ threadDelay 100000)
1170+ `catchExit` \_from reason -> do
1171+ -- TODO: should verify that 'from' has the right value
1172+ True <- return $ reason == "TestExit"
1173+ liftIO $ putMVar supervisedDone ()
1174+
1175+ runProcess localNode $ do
1176+ ref <- monitor pid
1177+ exit pid "TestExit"
1178+ -- This time the client catches the exception, so it dies normally
1179+ ProcessMonitorNotification ref' pid' DiedNormal <- expect
1180+ True <- return $ ref == ref' && pid == pid'
1181+ liftIO $ putMVar supervisorDone ()
1182+
1183+ takeMVar supervisedDone
1184+ takeMVar supervisorDone
1185+
1186+testExitRemote :: NT.Transport -> Assertion
1187+testExitRemote transport = do
1188+ node1 <- newLocalNode transport initRemoteTable
1189+ node2 <- newLocalNode transport initRemoteTable
1190+ supervisedDone <- newEmptyMVar
1191+ supervisorDone <- newEmptyMVar
1192+
1193+ pid <- forkProcess node1 $ do
1194+ (liftIO $ threadDelay 100000)
1195+ `catchExit` \_from reason -> do
1196+ -- TODO: should verify that 'from' has the right value
1197+ True <- return $ reason == "TestExit"
1198+ liftIO $ putMVar supervisedDone ()
1199+
1200+ runProcess node2 $ do
1201+ ref <- monitor pid
1202+ exit pid "TestExit"
1203+ ProcessMonitorNotification ref' pid' DiedNormal <- expect
1204+ True <- return $ ref == ref' && pid == pid'
1205+ liftIO $ putMVar supervisorDone ()
1206+
1207+ takeMVar supervisedDone
1208+ takeMVar supervisorDone
1209+
1210+testUnsafeSend :: NT.Transport -> Assertion
1211+testUnsafeSend transport = do
1212+ serverAddr <- newEmptyMVar
1213+ clientDone <- newEmptyMVar
1214+
1215+ localNode <- newLocalNode transport initRemoteTable
1216+ void $ forkProcess localNode $ do
1217+ self <- getSelfPid
1218+ liftIO $ putMVar serverAddr self
1219+ clientAddr <- expect
1220+ unsafeSend clientAddr ()
1221+
1222+ void $ forkProcess localNode $ do
1223+ serverPid <- liftIO $ takeMVar serverAddr
1224+ getSelfPid >>= unsafeSend serverPid
1225+ () <- expect
1226+ liftIO $ putMVar clientDone ()
1227+
1228+ takeMVar clientDone
1229+
1230+testUnsafeNSend :: NT.Transport -> Assertion
1231+testUnsafeNSend transport = do
1232+ clientDone <- newEmptyMVar
1233+
1234+ localNode <- newLocalNode transport initRemoteTable
1235+
1236+ pid <- forkProcess localNode $ do
1237+ () <- expect
1238+ liftIO $ putMVar clientDone ()
1239+
1240+ void $ runProcess localNode $ do
1241+ register "foobar" pid
1242+ unsafeNSend "foobar" ()
1243+
1244+ takeMVar clientDone
1245+
1246+testUnsafeSendChan :: NT.Transport -> Assertion
1247+testUnsafeSendChan transport = do
1248+ serverAddr <- newEmptyMVar
1249+ clientDone <- newEmptyMVar
1250+
1251+ localNode <- newLocalNode transport initRemoteTable
1252+ void $ forkProcess localNode $ do
1253+ self <- getSelfPid
1254+ liftIO $ putMVar serverAddr self
1255+ sp <- expect
1256+ unsafeSendChan sp ()
1257+
1258+ void $ forkProcess localNode $ do
1259+ serverPid <- liftIO $ takeMVar serverAddr
1260+ (sp, rp) <- newChan
1261+ unsafeSend serverPid sp
1262+ () <- receiveChan rp
1263+ liftIO $ putMVar clientDone ()
1264+
1265+ takeMVar clientDone
1266+
1267+tests :: (NT.Transport, TransportInternals) -> [Test]
1268+tests (transport, transportInternals) = [
1269+ testGroup "Basic features" [
1270+ testCase "Ping" (testPing transport)
1271+ , testCase "Math" (testMath transport)
1272+ , testCase "Timeout" (testTimeout transport)
1273+ , testCase "Timeout0" (testTimeout0 transport)
1274+ , testCase "SendToTerminated" (testSendToTerminated transport)
1275+ , testCase "TypedChannnels" (testTypedChannels transport)
1276+ , testCase "MergeChannels" (testMergeChannels transport)
1277+ , testCase "Terminate" (testTerminate transport)
1278+ , testCase "Registry" (testRegistry transport)
1279+ , testCase "RemoteRegistry" (testRemoteRegistry transport)
1280+ , testCase "SpawnLocal" (testSpawnLocal transport)
1281+ , testCase "HandleMessageIf" (testHandleMessageIf transport)
1282+ , testCase "MatchAny" (testMatchAny transport)
1283+ , testCase "MatchAnyHandle" (testMatchAnyHandle transport)
1284+ , testCase "MatchAnyNoHandle" (testMatchAnyNoHandle transport)
1285+ , testCase "MatchAnyIf" (testMatchAnyIf transport)
1286+ , testCase "MatchMessageUnwrap" (testMatchMessageWithUnwrap transport)
1287+ , testCase "ReceiveChanTimeout" (testReceiveChanTimeout transport)
1288+ , testCase "ReceiveChanFeatures" (testReceiveChanFeatures transport)
1289+ , testCase "KillLocal" (testKillLocal transport)
1290+ , testCase "KillRemote" (testKillRemote transport)
1291+ , testCase "Die" (testDie transport)
1292+ , testCase "PrettyExit" (testPrettyExit transport)
1293+ , testCase "CatchesExit" (testCatchesExit transport)
1294+ , testCase "Catches" (testCatches transport)
1295+ , testCase "MaskRestoreScope" (testMaskRestoreScope transport)
1296+ , testCase "ExitLocal" (testExitLocal transport)
1297+ , testCase "ExitRemote" (testExitRemote transport)
1298+ -- Unsafe Primitives
1299+ , testCase "TestUnsafeSend" (testUnsafeSend transport)
1300+ , testCase "TestUnsafeNSend" (testUnsafeNSend transport)
1301+ , testCase "TestUnsafeSendChan" (testUnsafeSendChan transport)
1302+ ]
1303+ , testGroup "Monitoring and Linking" [
1304+ -- Monitoring processes
1305+ --
1306+ -- The "missing" combinations in the list below don't make much sense, as
1307+ -- we cannot guarantee that the monitor reply or link exception will not
1308+ -- happen before the unmonitor or unlink
1309+ testCase "MonitorUnreachable" (testMonitorUnreachable transport True False)
1310+ , testCase "MonitorNormalTermination" (testMonitorNormalTermination transport True False)
1311+ , testCase "MonitorAbnormalTermination" (testMonitorAbnormalTermination transport True False)
1312+ , testCase "MonitorLocalDeadProcess" (testMonitorLocalDeadProcess transport True False)
1313+ , testCase "MonitorRemoteDeadProcess" (testMonitorRemoteDeadProcess transport True False)
1314+ , testCase "MonitorDisconnect" (testMonitorDisconnect transport True False)
1315+ , testCase "LinkUnreachable" (testMonitorUnreachable transport False False)
1316+ , testCase "LinkNormalTermination" (testMonitorNormalTermination transport False False)
1317+ , testCase "LinkAbnormalTermination" (testMonitorAbnormalTermination transport False False)
1318+ , testCase "LinkLocalDeadProcess" (testMonitorLocalDeadProcess transport False False)
1319+ , testCase "LinkRemoteDeadProcess" (testMonitorRemoteDeadProcess transport False False)
1320+ , testCase "LinkDisconnect" (testMonitorDisconnect transport False False)
1321+ , testCase "UnmonitorNormalTermination" (testMonitorNormalTermination transport True True)
1322+ , testCase "UnmonitorAbnormalTermination" (testMonitorAbnormalTermination transport True True)
1323+ , testCase "UnmonitorDisconnect" (testMonitorDisconnect transport True True)
1324+ , testCase "UnlinkNormalTermination" (testMonitorNormalTermination transport False True)
1325+ , testCase "UnlinkAbnormalTermination" (testMonitorAbnormalTermination transport False True)
1326+ , testCase "UnlinkDisconnect" (testMonitorDisconnect transport False True)
1327+ -- Monitoring nodes and channels
1328+ , testCase "MonitorNode" (testMonitorNode transport)
1329+ , testCase "MonitorLiveNode" (testMonitorLiveNode transport)
1330+ , testCase "MonitorChannel" (testMonitorChannel transport)
1331+ -- Reconnect
1332+ , testCase "Reconnect" (testReconnect transport transportInternals)
1333+ ]
1334+ ]
1335+
1336+main :: IO ()
1337+main = do
1338+ Right transport <- createTransportExposeInternals "127.0.0.1" "8080" defaultTCPParameters
1339+ defaultMain (tests transport)
tests/TestClosure.hsnew file+480
@@ -0,0 +1,480 @@
1+{-# LANGUAGE TemplateHaskell #-}
2+module Main where
3+
4+import Data.ByteString.Lazy (empty)
5+import Data.Typeable (Typeable)
6+import Control.Monad (join, replicateM, forever, replicateM_, void)
7+import Control.Exception (IOException, throw)
8+import Control.Concurrent (forkIO, threadDelay)
9+import Control.Concurrent.MVar
10+ ( MVar
11+ , newEmptyMVar
12+ , readMVar
13+ , takeMVar
14+ , putMVar
15+ , modifyMVar_
16+ , newMVar
17+ )
18+import Control.Applicative ((<$>))
19+import System.Random (randomIO)
20+import Network.Transport (Transport)
21+import Network.Transport.TCP
22+ ( createTransportExposeInternals
23+ , defaultTCPParameters
24+ , TransportInternals(socketBetween)
25+ )
26+import Network.Socket (sClose)
27+import Control.Distributed.Process
28+import Control.Distributed.Process.Closure
29+import Control.Distributed.Process.Node
30+import Control.Distributed.Process.Internal.Types (NodeId(nodeAddress))
31+import Control.Distributed.Static (staticLabel, staticClosure)
32+
33+import Test.HUnit (Assertion)
34+import Test.Framework (Test, defaultMain)
35+import Test.Framework.Providers.HUnit (testCase)
36+
37+--------------------------------------------------------------------------------
38+-- Supporting definitions --
39+--------------------------------------------------------------------------------
40+
41+quintuple :: a -> b -> c -> d -> e -> (a, b, c, d, e)
42+quintuple a b c d e = (a, b, c, d, e)
43+
44+sdictInt :: SerializableDict Int
45+sdictInt = SerializableDict
46+
47+factorial :: Int -> Process Int
48+factorial 0 = return 1
49+factorial n = (n *) <$> factorial (n - 1)
50+
51+addInt :: Int -> Int -> Int
52+addInt x y = x + y
53+
54+putInt :: Int -> MVar Int -> IO ()
55+putInt = flip putMVar
56+
57+sendPid :: ProcessId -> Process ()
58+sendPid toPid = do
59+ fromPid <- getSelfPid
60+ send toPid fromPid
61+
62+wait :: Int -> Process ()
63+wait = liftIO . threadDelay
64+
65+isPrime :: Integer -> Process Bool
66+isPrime n = return . (n `elem`) . takeWhile (<= n) . sieve $ [2..]
67+ where
68+ sieve :: [Integer] -> [Integer]
69+ sieve (p : xs) = p : sieve [x | x <- xs, x `mod` p > 0]
70+ sieve [] = error "Uh oh -- we've run out of primes"
71+
72+-- | First argument indicates empty closure environment
73+typedPingServer :: () -> ReceivePort (SendPort ()) -> Process ()
74+typedPingServer () rport = forever $ do
75+ sport <- receiveChan rport
76+ sendChan sport ()
77+
78+signal :: ProcessId -> Process ()
79+signal pid = send pid ()
80+
81+remotable [ 'factorial
82+ , 'addInt
83+ , 'putInt
84+ , 'sendPid
85+ , 'sdictInt
86+ , 'wait
87+ , 'typedPingServer
88+ , 'isPrime
89+ , 'quintuple
90+ , 'signal
91+ ]
92+
93+randomElement :: [a] -> IO a
94+randomElement xs = do
95+ ix <- randomIO
96+ return (xs !! (ix `mod` length xs))
97+
98+remotableDecl [
99+ [d| dfib :: ([NodeId], SendPort Integer, Integer) -> Process () ;
100+ dfib (_, reply, 0) = sendChan reply 0
101+ dfib (_, reply, 1) = sendChan reply 1
102+ dfib (nids, reply, n) = do
103+ nid1 <- liftIO $ randomElement nids
104+ nid2 <- liftIO $ randomElement nids
105+ (sport, rport) <- newChan
106+ spawn nid1 $ $(mkClosure 'dfib) (nids, sport, n - 2)
107+ spawn nid2 $ $(mkClosure 'dfib) (nids, sport, n - 1)
108+ n1 <- receiveChan rport
109+ n2 <- receiveChan rport
110+ sendChan reply $ n1 + n2
111+ |]
112+ ]
113+
114+-- Just try creating a static polymorphic value
115+staticQuintuple :: (Typeable a, Typeable b, Typeable c, Typeable d, Typeable e)
116+ => Static (a -> b -> c -> d -> e -> (a, b, c, d, e))
117+staticQuintuple = $(mkStatic 'quintuple)
118+
119+factorialClosure :: Int -> Closure (Process Int)
120+factorialClosure = $(mkClosure 'factorial)
121+
122+addIntClosure :: Int -> Closure (Int -> Int)
123+addIntClosure = $(mkClosure 'addInt)
124+
125+putIntClosure :: Int -> Closure (MVar Int -> IO ())
126+putIntClosure = $(mkClosure 'putInt)
127+
128+sendPidClosure :: ProcessId -> Closure (Process ())
129+sendPidClosure = $(mkClosure 'sendPid)
130+
131+sendFac :: Int -> ProcessId -> Closure (Process ())
132+sendFac n pid = factorialClosure n `bindCP` cpSend $(mkStatic 'sdictInt) pid
133+
134+factorialOf :: Closure (Int -> Process Int)
135+factorialOf = staticClosure $(mkStatic 'factorial)
136+
137+factorial' :: Int -> Closure (Process Int)
138+factorial' n = returnCP $(mkStatic 'sdictInt) n `bindCP` factorialOf
139+
140+waitClosure :: Int -> Closure (Process ())
141+waitClosure = $(mkClosure 'wait)
142+
143+simulateNetworkFailure :: TransportInternals -> NodeId -> NodeId -> Process ()
144+simulateNetworkFailure transportInternals fr to = liftIO $ do
145+ threadDelay 10000
146+ sock <- socketBetween transportInternals (nodeAddress fr) (nodeAddress to)
147+ sClose sock
148+ threadDelay 10000
149+
150+--------------------------------------------------------------------------------
151+-- The tests proper --
152+--------------------------------------------------------------------------------
153+
154+testUnclosure :: Transport -> RemoteTable -> Assertion
155+testUnclosure transport rtable = do
156+ node <- newLocalNode transport rtable
157+ done <- newEmptyMVar
158+ forkProcess node $ do
159+ 120 <- join . unClosure $ factorialClosure 5
160+ liftIO $ putMVar done ()
161+ takeMVar done
162+
163+testBind :: Transport -> RemoteTable -> Assertion
164+testBind transport rtable = do
165+ node <- newLocalNode transport rtable
166+ done <- newEmptyMVar
167+ runProcess node $ do
168+ us <- getSelfPid
169+ join . unClosure $ sendFac 6 us
170+ (720 :: Int) <- expect
171+ liftIO $ putMVar done ()
172+ takeMVar done
173+
174+testSendPureClosure :: Transport -> RemoteTable -> Assertion
175+testSendPureClosure transport rtable = do
176+ serverAddr <- newEmptyMVar
177+ serverDone <- newEmptyMVar
178+
179+ forkIO $ do
180+ node <- newLocalNode transport rtable
181+ addr <- forkProcess node $ do
182+ cl <- expect
183+ fn <- unClosure cl :: Process (Int -> Int)
184+ 13 <- return $ fn 6
185+ liftIO $ putMVar serverDone ()
186+ putMVar serverAddr addr
187+
188+ forkIO $ do
189+ node <- newLocalNode transport rtable
190+ theirAddr <- readMVar serverAddr
191+ runProcess node $ send theirAddr (addIntClosure 7)
192+
193+ takeMVar serverDone
194+
195+testSendIOClosure :: Transport -> RemoteTable -> Assertion
196+testSendIOClosure transport rtable = do
197+ serverAddr <- newEmptyMVar
198+ serverDone <- newEmptyMVar
199+
200+ forkIO $ do
201+ node <- newLocalNode transport rtable
202+ addr <- forkProcess node $ do
203+ cl <- expect
204+ io <- unClosure cl :: Process (MVar Int -> IO ())
205+ liftIO $ do
206+ someMVar <- newEmptyMVar
207+ io someMVar
208+ 5 <- readMVar someMVar
209+ putMVar serverDone ()
210+ putMVar serverAddr addr
211+
212+ forkIO $ do
213+ node <- newLocalNode transport rtable
214+ theirAddr <- readMVar serverAddr
215+ runProcess node $ send theirAddr (putIntClosure 5)
216+
217+ takeMVar serverDone
218+
219+testSendProcClosure :: Transport -> RemoteTable -> Assertion
220+testSendProcClosure transport rtable = do
221+ serverAddr <- newEmptyMVar
222+ clientDone <- newEmptyMVar
223+
224+ forkIO $ do
225+ node <- newLocalNode transport rtable
226+ addr <- forkProcess node $ do
227+ cl <- expect
228+ pr <- unClosure cl :: Process (Int -> Process ())
229+ pr 5
230+ putMVar serverAddr addr
231+
232+ forkIO $ do
233+ node <- newLocalNode transport rtable
234+ theirAddr <- readMVar serverAddr
235+ runProcess node $ do
236+ pid <- getSelfPid
237+ send theirAddr (cpSend $(mkStatic 'sdictInt) pid)
238+ 5 <- expect :: Process Int
239+ liftIO $ putMVar clientDone ()
240+
241+ takeMVar clientDone
242+
243+testSpawn :: Transport -> RemoteTable -> Assertion
244+testSpawn transport rtable = do
245+ serverNodeAddr <- newEmptyMVar
246+ clientDone <- newEmptyMVar
247+
248+ forkIO $ do
249+ node <- newLocalNode transport rtable
250+ putMVar serverNodeAddr (localNodeId node)
251+
252+ forkIO $ do
253+ node <- newLocalNode transport rtable
254+ nid <- readMVar serverNodeAddr
255+ runProcess node $ do
256+ pid <- getSelfPid
257+ pid' <- spawn nid (sendPidClosure pid)
258+ pid'' <- expect
259+ True <- return $ pid' == pid''
260+ liftIO $ putMVar clientDone ()
261+
262+ takeMVar clientDone
263+
264+testCall :: Transport -> RemoteTable -> Assertion
265+testCall transport rtable = do
266+ serverNodeAddr <- newEmptyMVar
267+ clientDone <- newEmptyMVar
268+
269+ forkIO $ do
270+ node <- newLocalNode transport rtable
271+ putMVar serverNodeAddr (localNodeId node)
272+
273+ forkIO $ do
274+ node <- newLocalNode transport rtable
275+ nid <- readMVar serverNodeAddr
276+ runProcess node $ do
277+ (120 :: Int) <- call $(mkStatic 'sdictInt) nid (factorialClosure 5)
278+ liftIO $ putMVar clientDone ()
279+
280+ takeMVar clientDone
281+
282+testCallBind :: Transport -> RemoteTable -> Assertion
283+testCallBind transport rtable = do
284+ serverNodeAddr <- newEmptyMVar
285+ clientDone <- newEmptyMVar
286+
287+ forkIO $ do
288+ node <- newLocalNode transport rtable
289+ putMVar serverNodeAddr (localNodeId node)
290+
291+ forkIO $ do
292+ node <- newLocalNode transport rtable
293+ nid <- readMVar serverNodeAddr
294+ runProcess node $ do
295+ (120 :: Int) <- call $(mkStatic 'sdictInt) nid (factorial' 5)
296+ liftIO $ putMVar clientDone ()
297+
298+ takeMVar clientDone
299+
300+testSeq :: Transport -> RemoteTable -> Assertion
301+testSeq transport rtable = do
302+ node <- newLocalNode transport rtable
303+ done <- newEmptyMVar
304+ runProcess node $ do
305+ us <- getSelfPid
306+ join . unClosure $ sendFac 5 us `seqCP` sendFac 6 us
307+ 120 :: Int <- expect
308+ 720 :: Int <- expect
309+ liftIO $ putMVar done ()
310+ takeMVar done
311+
312+-- Test 'spawnSupervised'
313+--
314+-- Set up a supervisor, spawn a child, then have a third process monitor the
315+-- child. The supervisor then throws an exception, the child dies because it
316+-- was linked to the supervisor, and the third process notices that the child
317+-- dies.
318+testSpawnSupervised :: Transport -> RemoteTable -> Assertion
319+testSpawnSupervised transport rtable = do
320+ [node1, node2] <- replicateM 2 $ newLocalNode transport rtable
321+ [superPid, childPid] <- replicateM 2 $ newEmptyMVar
322+ thirdProcessDone <- newEmptyMVar
323+
324+ forkProcess node1 $ do
325+ us <- getSelfPid
326+ liftIO $ putMVar superPid us
327+ (child, _ref) <- spawnSupervised (localNodeId node2) (waitClosure 1000000)
328+ liftIO $ do
329+ putMVar childPid child
330+ threadDelay 500000 -- Give the child a chance to link to us
331+ throw supervisorDeath
332+
333+ forkProcess node2 $ do
334+ [super, child] <- liftIO $ mapM readMVar [superPid, childPid]
335+ ref <- monitor child
336+ ProcessMonitorNotification ref' pid' (DiedException e) <- expect
337+ True <- return $ ref' == ref
338+ && pid' == child
339+ && e == show (ProcessLinkException super (DiedException (show supervisorDeath)))
340+ liftIO $ putMVar thirdProcessDone ()
341+
342+ takeMVar thirdProcessDone
343+ where
344+ supervisorDeath :: IOException
345+ supervisorDeath = userError "Supervisor died"
346+
347+testSpawnInvalid :: Transport -> RemoteTable -> Assertion
348+testSpawnInvalid transport rtable = do
349+ node <- newLocalNode transport rtable
350+ done <- newEmptyMVar
351+ forkProcess node $ do
352+ (pid, ref) <- spawnMonitor (localNodeId node) (closure (staticLabel "ThisDoesNotExist") empty)
353+ ProcessMonitorNotification ref' pid' _reason <- expect
354+ -- Depending on the exact interleaving, reason might be NoProc or the exception thrown by the absence of the static closure
355+ True <- return $ ref' == ref && pid == pid'
356+ liftIO $ putMVar done ()
357+ takeMVar done
358+
359+testClosureExpect :: Transport -> RemoteTable -> Assertion
360+testClosureExpect transport rtable = do
361+ node <- newLocalNode transport rtable
362+ done <- newEmptyMVar
363+ runProcess node $ do
364+ nodeId <- getSelfNode
365+ us <- getSelfPid
366+ them <- spawn nodeId $ cpExpect $(mkStatic 'sdictInt) `bindCP` cpSend $(mkStatic 'sdictInt) us
367+ send them (1234 :: Int)
368+ (1234 :: Int) <- expect
369+ liftIO $ putMVar done ()
370+ takeMVar done
371+
372+testSpawnChannel :: Transport -> RemoteTable -> Assertion
373+testSpawnChannel transport rtable = do
374+ done <- newEmptyMVar
375+ [node1, node2] <- replicateM 2 $ newLocalNode transport rtable
376+
377+ forkProcess node1 $ do
378+ pingServer <- spawnChannel
379+ (sdictSendPort sdictUnit)
380+ (localNodeId node2)
381+ ($(mkClosure 'typedPingServer) ())
382+ (sendReply, receiveReply) <- newChan
383+ sendChan pingServer sendReply
384+ receiveChan receiveReply
385+ liftIO $ putMVar done ()
386+
387+ takeMVar done
388+
389+testTDict :: Transport -> RemoteTable -> Assertion
390+testTDict transport rtable = do
391+ done <- newEmptyMVar
392+ [node1, node2] <- replicateM 2 $ newLocalNode transport rtable
393+ forkProcess node1 $ do
394+ True <- call $(functionTDict 'isPrime) (localNodeId node2) ($(mkClosure 'isPrime) (79 :: Integer))
395+ liftIO $ putMVar done ()
396+ takeMVar done
397+
398+testFib :: Transport -> RemoteTable -> Assertion
399+testFib transport rtable = do
400+ nodes <- replicateM 4 $ newLocalNode transport rtable
401+ done <- newEmptyMVar
402+
403+ forkProcess (head nodes) $ do
404+ (sport, rport) <- newChan
405+ spawnLocal $ dfib (map localNodeId nodes, sport, 10)
406+ 55 <- receiveChan rport :: Process Integer
407+ liftIO $ putMVar done ()
408+
409+ takeMVar done
410+
411+testSpawnReconnect :: Transport -> RemoteTable -> TransportInternals -> Assertion
412+testSpawnReconnect transport rtable transportInternals = do
413+ [node1, node2] <- replicateM 2 $ newLocalNode transport rtable
414+ let nid1 = localNodeId node1
415+ nid2 = localNodeId node2
416+ done <- newEmptyMVar
417+ iv <- newMVar (0 :: Int)
418+
419+ incr <- forkProcess node1 $ forever $ do
420+ () <- expect
421+ liftIO $ modifyMVar_ iv (return . (+ 1))
422+
423+ forkProcess node2 $ do
424+ _pid1 <- spawn nid1 ($(mkClosure 'signal) incr)
425+ simulateNetworkFailure transportInternals nid2 nid1
426+ _pid2 <- spawn nid1 ($(mkClosure 'signal) incr)
427+ _pid3 <- spawn nid1 ($(mkClosure 'signal) incr)
428+
429+ liftIO $ threadDelay 100000
430+
431+ count <- liftIO $ takeMVar iv
432+ True <- return $ count == 2 || count == 3 -- It depends on which message we get first in 'spawn'
433+
434+ liftIO $ putMVar done ()
435+
436+ takeMVar done
437+
438+-- | 'spawn' used to ave a race condition which would be triggered if the
439+-- spawning process terminates immediately after spawning
440+testSpawnTerminate :: Transport -> RemoteTable -> Assertion
441+testSpawnTerminate transport rtable = do
442+ slave <- newLocalNode transport rtable
443+ master <- newLocalNode transport rtable
444+ masterDone <- newEmptyMVar
445+
446+ runProcess master $ do
447+ us <- getSelfPid
448+ replicateM_ 1000 . spawnLocal . void . spawn (localNodeId slave) $ $(mkClosure 'signal) us
449+ replicateM_ 1000 $ (expect :: Process ())
450+ liftIO $ putMVar masterDone ()
451+
452+ takeMVar masterDone
453+
454+tests :: (Transport, TransportInternals) -> RemoteTable -> [Test]
455+tests (transport, transportInternals) rtable = [
456+ testCase "Unclosure" (testUnclosure transport rtable)
457+ , testCase "Bind" (testBind transport rtable)
458+ , testCase "SendPureClosure" (testSendPureClosure transport rtable)
459+ , testCase "SendIOClosure" (testSendIOClosure transport rtable)
460+ , testCase "SendProcClosure" (testSendProcClosure transport rtable)
461+ , testCase "Spawn" (testSpawn transport rtable)
462+ , testCase "Call" (testCall transport rtable)
463+ , testCase "CallBind" (testCallBind transport rtable)
464+ , testCase "Seq" (testSeq transport rtable)
465+ , testCase "SpawnSupervised" (testSpawnSupervised transport rtable)
466+ , testCase "SpawnInvalid" (testSpawnInvalid transport rtable)
467+ , testCase "ClosureExpect" (testClosureExpect transport rtable)
468+ , testCase "SpawnChannel" (testSpawnChannel transport rtable)
469+ , testCase "TDict" (testTDict transport rtable)
470+ , testCase "Fib" (testFib transport rtable)
471+ , testCase "SpawnTerminate" (testSpawnTerminate transport rtable)
472+ , testCase "SpawnReconnect" (testSpawnReconnect transport rtable transportInternals)
473+ ]
474+
475+
476+main :: IO ()
477+main = do
478+ Right transport <- createTransportExposeInternals "127.0.0.1" "8080" defaultTCPParameters
479+ let rtable = __remoteTable . __remoteTableDecl $ initRemoteTable
480+ defaultMain (tests transport rtable)
tests/TestMx.hsnew file+213
@@ -0,0 +1,213 @@
1+{-# LANGUAGE DeriveGeneric #-}
2+module Main where
3+
4+import Control.Concurrent (threadDelay)
5+import Control.Distributed.Process
6+import Control.Distributed.Process.Management
7+ ( MxEvent(..)
8+ , MxAgentId(..)
9+ , mxAgent
10+ , mxSink
11+ , mxReady
12+ , liftMX
13+ , mxGetLocal
14+ , mxSetLocal
15+ , mxNotify
16+ , mxBroadcast
17+ , mxGetId
18+ , mxGet
19+ , mxSet
20+ , mxClear
21+ , mxPurgeTable
22+ , mxDropTable
23+ )
24+import Control.Distributed.Process.Node
25+ ( LocalNode
26+ )
27+import Data.Binary
28+import Data.List (find)
29+import Data.Maybe (isJust)
30+import Data.Typeable
31+import GHC.Generics
32+import qualified Network.Transport as NT
33+#if ! MIN_VERSION_base(4,6,0)
34+import Prelude hiding (catch, log)
35+#endif
36+
37+import Test.Framework
38+ ( Test
39+ , testGroup
40+ )
41+import Test.Framework.Providers.HUnit (testCase)
42+import TestUtils
43+
44+data Publish = Publish
45+ deriving (Typeable, Generic, Eq)
46+
47+instance Binary Publish where
48+
49+testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
50+testAgentBroadcast result = do
51+ (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
52+
53+ publisher <- mxAgent (MxAgentId "publisher-agent") () [
54+ mxSink $ \() -> mxBroadcast Publish >> mxReady
55+ ]
56+
57+ consumer <- mxAgent (MxAgentId "consumer-agent") () [
58+ mxSink $ \Publish -> (liftMX $ sendChan resultSP ()) >> mxReady
59+ ]
60+
61+ mxNotify ()
62+ -- once the publisher has seen our message, it will broadcast the Publish
63+ stash result =<< receiveChanTimeout 1000000 resultRP
64+
65+ kill publisher "finished"
66+ kill consumer "finished"
67+
68+testAgentEventHandling :: TestResult Bool -> Process ()
69+testAgentEventHandling result = do
70+ let initState = [] :: [MxEvent]
71+ agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
72+ (mxSink $ \ev -> do
73+ st <- mxGetLocal
74+ let act =
75+ case ev of
76+ (MxSpawned _) -> mxSetLocal (ev:st)
77+ (MxProcessDied _ _) -> mxSetLocal (ev:st)
78+ _ -> return ()
79+ act >> mxReady),
80+ (mxSink $ \(ev, sp :: SendPort Bool) -> do
81+ st <- mxGetLocal
82+ let found =
83+ case ev of
84+ MxSpawned p ->
85+ isJust $ find (\ev' ->
86+ case ev' of
87+ (MxSpawned p') -> p' == p
88+ _ -> False) st
89+ MxProcessDied p r ->
90+ isJust $ find (\ev' ->
91+ case ev' of
92+ (MxProcessDied p' r') -> p' == p && r == r'
93+ _ -> False) st
94+ _ -> False
95+ liftMX $ sendChan sp found
96+ mxReady)
97+ ]
98+
99+ _ <- monitor agentPid
100+ (sp, rp) <- newChan
101+ pid <- spawnLocal $ sendChan sp ()
102+ () <- receiveChan rp
103+
104+ -- By waiting for a monitor notification, we have a
105+ -- higher probably that the agent has seen
106+ monitor pid
107+ receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
108+
109+ (replyTo, reply) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
110+ mxNotify (MxSpawned pid, replyTo)
111+ mxNotify (MxProcessDied pid DiedNormal, replyTo)
112+
113+ seenAlive <- receiveChan reply
114+ seenDead <- receiveChan reply
115+
116+ stash result $ seenAlive && seenDead
117+
118+testAgentPublication :: TestResult (Maybe Publish) -> Process ()
119+testAgentPublication result = do
120+ (syncChan, rp) <- newChan
121+ let ourId = MxAgentId "publication-agent"
122+ agentPid <- mxAgent ourId () [
123+ mxSink $ \() -> do
124+ selfId <- mxGetId
125+ liftMX $ mxSet selfId "publish" Publish >> sendChan syncChan ()
126+ mxReady
127+ ]
128+
129+ mxNotify ()
130+ () <- receiveChan rp
131+
132+ stash result =<< mxGet ourId "publish"
133+
134+ mref <- monitor agentPid
135+ kill agentPid "finished"
136+ receiveWait [
137+ matchIf (\(ProcessMonitorNotification ref _ _) -> ref == mref)
138+ ((\_ -> return ()))
139+ ]
140+
141+testAgentTableClear :: Int -> TestResult (Maybe Int, Maybe Int) -> Process ()
142+testAgentTableClear val result =
143+ let tId = (MxAgentId "agent-1")
144+ tKey = "key-1" in do
145+ mxSet tId tKey val
146+ get1 <- mxGet tId tKey
147+ mxClear tId tKey
148+ get2 <- mxGet tId tKey
149+ stash result (get1, get2)
150+
151+testAgentTablePurge :: TestResult (Maybe Int) -> Process ()
152+testAgentTablePurge result =
153+ let tId = MxAgentId "agent-2"
154+ tKey = "key-2" in do
155+ mxSet tId tKey (12345 :: Int)
156+ mxPurgeTable tId
157+ stash result =<< mxGet tId tKey
158+
159+testAgentTableDelete :: Int
160+ -> TestResult (Maybe Int, Maybe Int, Maybe Int)
161+ -> Process ()
162+testAgentTableDelete val result =
163+ let tId = (MxAgentId "agent-3")
164+ tKey = "key-3" in do
165+ mxSet tId tKey val
166+ get1 <- mxGet tId tKey
167+ mxDropTable tId
168+ get2 <- mxGet tId tKey
169+ mxSet tId tKey val
170+ get3 <- mxGet tId tKey
171+ stash result (get1, get2, get3)
172+
173+tests :: LocalNode -> IO [Test]
174+tests node1 = do
175+ return [
176+ testGroup "Mx Agents" [
177+ testCase "Event Handling"
178+ (delayedAssertion
179+ "expected True, but events where not as expected"
180+ node1 True testAgentEventHandling)
181+ , testCase "Inter-Agent Broadcast"
182+ (delayedAssertion
183+ "expected (Just ()), but no broadcast was received"
184+ node1 (Just ()) testAgentBroadcast)
185+ ],
186+ testGroup "Mx Global Properties" [
187+ testCase "Global Property Publication"
188+ (delayedAssertion
189+ "expected (Just Publish), but no table entry was found"
190+ node1 (Just Publish) testAgentPublication)
191+ , testCase "Clearing Global Properties"
192+ (delayedAssertion
193+ "expected (Just 1024, Nothing): invalid table entry found!"
194+ node1 (Just 1024, Nothing) (testAgentTableClear 1024))
195+ , testCase "Purging Global Tables"
196+ (delayedAssertion
197+ "expected Nothing, but a table entry was found"
198+ node1 Nothing testAgentTablePurge)
199+ , testCase "Deleting and (Re)Creating Global Tables"
200+ (delayedAssertion
201+ "expected (Just 15, Nothing, Just 15): invalid table entry found!"
202+ node1 (Just 15, Nothing, Just 15) (testAgentTableDelete 15))
203+ ]]
204+
205+statsTests :: NT.Transport -> IO [Test]
206+statsTests _ = do
207+ mkNode "8080" >>= tests >>= return
208+
209+main :: IO ()
210+main = do
211+ testMain $ statsTests
212+ threadDelay 100000
213+
distributed-process-tests/src/Control/Distributed/Process/Tests/Receive.hs → tests/TestReceive.hsrenamed+36−22
@@ -1,21 +1,24 @@
1−{-# LANGUAGE TemplateHaskell #-}
1+{-# LANGUAGE TemplateHaskell, DeriveDataTypeable #-}
22{-# OPTIONS_GHC -Wall #-}
3−
4−-- | XXX test doesn't work, because failure exceptions don't get propagated. The
5−-- test always claims to succeed, even if it failed.
6−
7−module Control.Distributed.Process.Tests.Receive (tests) where
8−
9−import Network.Transport.Test (TestTransport(..))
10−
11−import Network.Transport (Transport)
123import Control.Distributed.Process
4+import Control.Distributed.Process.Closure
135import Control.Distributed.Process.Node
146
7+import Network.Transport (Transport)
8+import Network.Transport.TCP
9+ ( createTransportExposeInternals
10+ , defaultTCPParameters
11+ , TransportInternals(socketBetween)
12+ )
13+
1514import Control.Monad
15+import Text.Printf
16+import Data.DeriveTH
17+import Data.Binary
18+import Data.Typeable
1619
1720import Test.HUnit (Assertion, (@?=))
18−import Test.Framework (Test)
21+import Test.Framework (Test, defaultMain)
1922import Test.Framework.Providers.HUnit (testCase)
2023
2124-- Tests:
@@ -42,7 +45,7 @@ recTest2 :: ReceivePort ()
4245 -> SendPort String
4346 -> ReceivePort String -> ReceivePort String
4447 -> Process ()
45−recTest2 wait sync r1 _ = do
48+recTest2 wait sync r1 r2 = do
4649 forever $ do
4750 receiveChan wait
4851 r <- receiveWait
@@ -55,7 +58,7 @@ recTest3 :: ReceivePort ()
5558 -> SendPort String
5659 -> ReceivePort String -> ReceivePort String
5760 -> Process ()
58−recTest3 wait sync r1 _ = do
61+recTest3 wait sync r1 r2 = do
5962 forever $ do
6063 receiveChan wait
6164 r <- receiveWait
@@ -68,7 +71,7 @@ recTest4 :: ReceivePort ()
6871 -> SendPort String
6972 -> ReceivePort String -> ReceivePort String
7073 -> Process ()
71−recTest4 wait sync r1 _ = do
74+recTest4 wait sync r1 r2 = do
7275 forever $ do
7376 receiveChan wait
7477 r <- receiveWait
@@ -78,15 +81,17 @@ recTest4 wait sync r1 _ = do
7881 ]
7982 sendChan sync r
8083
84+
8185master :: Process ()
8286master = do
87+
8388 (waits,waitr) <- newChan
8489 (syncs,syncr) <- newChan
85− let go expected = do
90+ let go expect = do
8691 sendChan waits ()
8792 r <- receiveChan syncr
88− liftIO $ print (r, expected, r == expected)
89− liftIO $ r @?= expected
93+ liftIO $ print (r,expect, r == expect)
94+ liftIO $ r @?= expect
9095
9196 liftIO $ putStrLn "---- Test 1 ----"
9297 (s1,r1) <- newChan
@@ -142,13 +147,22 @@ master = do
142147
143148 terminate
144149
150+
145151testReceive :: Transport -> RemoteTable -> Assertion
146152testReceive transport rtable = do
147153 node <- newLocalNode transport rtable
148154 runProcess node $ master
149155
150−tests :: TestTransport -> IO [Test]
151−tests TestTransport{..} = do
152− let rtable = initRemoteTable
153− return
154− [ testCase "testReceive" (testReceive testTransport rtable) ]
156+tests :: (Transport, TransportInternals) -> RemoteTable -> [Test]
157+tests (transport, transportInternals) rtable = [
158+ testCase "testReceive" (testReceive transport rtable)
159+ ]
160+
161+-- NB. test doesn't work, because failure exceptions don't get
162+-- propagated. The test always claims to succeed, even if it failed.
163+
164+main :: IO ()
165+main = do
166+ Right transport <- createTransportExposeInternals "127.0.0.1" "8080" defaultTCPParameters
167+ let rtable = initRemoteTable
168+ defaultMain (tests transport rtable)
distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hs → tests/TestStats.hsrenamed+28−24
@@ -1,9 +1,6 @@
11{-# LANGUAGE DeriveDataTypeable #-}
22{-# OPTIONS_GHC -fno-warn-orphans #-}
3−module Control.Distributed.Process.Tests.Stats (tests) where
4−
5−import Control.Distributed.Process.Tests.Internal.Utils
6−import Network.Transport.Test (TestTransport(..))
3+module Main where
74
85import Control.Concurrent.MVar
96 ( MVar
@@ -13,8 +10,11 @@ import Control.Concurrent.MVar
1310 )
1411import Control.Distributed.Process
1512import Control.Distributed.Process.Node
16−import Data.Binary ()
17−import Data.Typeable ()
13+ ( forkProcess
14+ , LocalNode)
15+import Data.Binary()
16+import Data.Typeable()
17+import qualified Network.Transport as NT
1818
1919#if ! MIN_VERSION_base(4,6,0)
2020import Prelude hiding (catch)
@@ -26,10 +26,11 @@ import Test.Framework
2626 )
2727import Test.HUnit (Assertion)
2828import Test.Framework.Providers.HUnit (testCase)
29+import TestUtils
2930
3031testLocalDeadProcessInfo :: TestResult (Maybe ProcessInfo) -> Process ()
3132testLocalDeadProcessInfo result = do
32− pid <- spawnLocal $ do (_ :: String) <- expect; return ()
33+ pid <- spawnLocal $ do "finish" <- expect; return ()
3334 mref <- monitor pid
3435 send pid "finish"
3536 _ <- receiveWait [
@@ -52,10 +53,8 @@ testLocalLiveProcessInfo result = do
5253 link self
5354 mRef <- monitor self
5455 stash mon mRef
55− res <- expect
56− case res of
57− "die" -> return ()
58− _ -> die $ "unexpected message received: " ++ res
56+ "die" <- expect
57+ return ()
5958
6059 monRef <- liftIO $ takeMVar mon
6160
@@ -75,8 +74,8 @@ testLocalLiveProcessInfo result = do
7574-- infoMessageQueueLength pInfo == Just 4 &&
7675 infoRegisteredNames pInfo == ["foobar"]
7776
78−testRemoteLiveProcessInfo :: TestTransport -> LocalNode -> Assertion
79−testRemoteLiveProcessInfo TestTransport{..} node1 = do
77+testRemoteLiveProcessInfo :: LocalNode -> Assertion
78+testRemoteLiveProcessInfo node1 = do
8079 serverAddr <- liftIO $ newEmptyMVar :: IO (MVar ProcessId)
8180 liftIO $ launchRemote serverAddr
8281 serverPid <- liftIO $ takeMVar serverAddr
@@ -86,23 +85,21 @@ testRemoteLiveProcessInfo TestTransport{..} node1 = do
8685 -- our send op shouldn't overtake link or monitor requests AFAICT
8786 -- so a little table tennis should get us synchronised properly
8887 send serverPid (self, "ping")
89− pong <- expect
88+ "pong" <- expect
9089 pInfo <- getProcessInfo serverPid
91− stash result $ pong == "pong" && pInfo /= Nothing
90+ stash result $ pInfo /= Nothing
9291 where
9392 launchRemote :: MVar ProcessId -> IO ()
9493 launchRemote locMV = do
95− node2 <- liftIO $ newLocalNode testTransport initRemoteTable
94+ node2 <- liftIO $ mkNode "8082"
9695 _ <- liftIO $ forkProcess node2 $ do
9796 self <- getSelfPid
9897 liftIO $ putMVar locMV self
9998 _ <- receiveWait [
10099 match (\(pid, "ping") -> send pid "pong")
101100 ]
102− res <- expect
103− case res of
104− "stop" -> return ()
105− _ -> die $ "unexpected message received: " ++ res
101+ "stop" <- expect
102+ return ()
106103 return ()
107104
108105 withActiveRemote :: LocalNode
@@ -111,9 +108,8 @@ testRemoteLiveProcessInfo TestTransport{..} node1 = do
111108 a <- delayedAssertion "getProcessInfo remotePid failed" n True
112109 return a
113110
114−tests :: TestTransport -> IO [Test]
115−tests testtrans@TestTransport{..} = do
116− node1 <- newLocalNode testTransport initRemoteTable
111+tests :: LocalNode -> IO [Test]
112+tests node1 = do
117113 return [
118114 testGroup "Process Info" [
119115 testCase "testLocalDeadProcessInfo"
@@ -125,5 +121,13 @@ tests testtrans@TestTransport{..} = do
125121 "expected process-info to be correctly populated"
126122 node1 True testLocalLiveProcessInfo)
127123 , testCase "testRemoveLiveProcessInfo"
128− (testRemoteLiveProcessInfo testtrans node1)
124+ (testRemoteLiveProcessInfo node1)
129125 ] ]
126+
127+statsTests :: NT.Transport -> IO [Test]
128+statsTests _ = do
129+ mkNode "8080" >>= tests >>= return
130+
131+main :: IO ()
132+main = testMain $ statsTests
133+
distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hs → tests/TestTracing.hsrenamed+31−127
@@ -1,11 +1,7 @@
11{-# LANGUAGE DeriveDataTypeable #-}
22{-# OPTIONS_GHC -fno-warn-orphans #-}
3−module Control.Distributed.Process.Tests.Tracing (tests) where
3+module Main where
44
5−import Control.Distributed.Process.Tests.Internal.Utils
6−import Network.Transport.Test (TestTransport(..))
7−
8−import Control.Applicative ((<*))
95import Control.Concurrent (threadDelay)
106import Control.Concurrent.MVar
117 ( MVar
@@ -15,18 +11,18 @@ import Control.Concurrent.MVar
1511 , takeMVar
1612 )
1713import Control.Distributed.Process
18−import Control.Distributed.Process.Node
1914import Control.Distributed.Process.Debug
2015import Control.Distributed.Process.Management
2116 ( MxEvent(..)
2217 )
23−import qualified Control.Exception as IO (bracket)
24−import Data.List (isPrefixOf, isSuffixOf)
18+import Control.Distributed.Process.Node
19+ ( forkProcess
20+ , closeLocalNode
21+ , LocalNode)
22+import qualified Network.Transport as NT
2523
2624#if ! MIN_VERSION_base(4,6,0)
2725import Prelude hiding (catch, log)
28−#else
29−import Prelude hiding ((<*))
3026#endif
3127
3228import Test.Framework
@@ -34,10 +30,7 @@ import Test.Framework
3430 , testGroup
3531 )
3632import 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−
33+import TestUtils
4134
4235testSpawnTracing :: TestResult Bool -> Process ()
4336testSpawnTracing result = do
@@ -125,11 +118,9 @@ testTraceSending result = do
125118 (\ev ->
126119 case ev of
127120 (MxSent to from msg) -> do
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..."
121+ (Just s) <- unwrapMessage msg :: Process (Maybe String)
122+ stash res (to == pid && from == self && s == "hello there")
123+ stash res (to == pid && from == self)
133124 _ ->
134125 return ()) $ do
135126 send pid "hello there"
@@ -235,11 +226,11 @@ testTraceLayering result = do
235226 })
236227 liftIO $ putMVar result' ()
237228
238−testRemoteTraceRelay :: TestTransport -> TestResult Bool -> Process ()
239−testRemoteTraceRelay TestTransport{..} result =
229+testRemoteTraceRelay :: TestResult Bool -> Process ()
230+testRemoteTraceRelay result =
240231 let flags = defaultTraceFlags { traceSpawned = traceOn }
241232 in do
242− node2 <- liftIO $ newLocalNode testTransport initRemoteTable
233+ node2 <- liftIO $ mkNode "8082"
243234 mvNid <- liftIO $ newEmptyMVar
244235
245236 -- As well as needing node2's NodeId, we want to
@@ -248,8 +239,12 @@ testRemoteTraceRelay TestTransport{..} result =
248239 -- Here we set up that relay, and then wait for a signal
249240 -- that the tracer (on node1) has seen the expected
250241 -- MxSpawned message, at which point we're finished
242+ (Just log') <- whereis "logger"
243+ pid <- liftIO $ forkProcess node2 $ do
244+ logRelay <- spawnLocal $ relay log'
245+ reregister "logger" logRelay
246+ getSelfNode >>= stash mvNid >> (expect :: Process ())
251247
252− pid <- splinchLogger node2 mvNid
253248 nid <- liftIO $ takeMVar mvNid
254249 mref <- monitor pid
255250 observedPid <- liftIO $ newEmptyMVar
@@ -270,8 +265,8 @@ testRemoteTraceRelay TestTransport{..} result =
270265 stash spawnedPid p
271266
272267 -- Now we wait for (the outer) pid to exit. This won't happen until
273− -- our tracer has seen the trace event for `p' and sent `p' the
274− -- message it's waiting for prior to exiting
268+ -- our tracer has seen the trace event for `p' and send `p' the
269+ -- message its waiting for prior to exiting
275270 receiveWait [
276271 matchIf (\(ProcessMonitorNotification mref' _ _) -> mref == mref')
277272 (\_ -> return ())
@@ -289,99 +284,8 @@ testRemoteTraceRelay TestTransport{..} result =
289284 -- and just to be polite...
290285 liftIO $ closeLocalNode node2
291286
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−
382−tests :: TestTransport -> IO [Test]
383−tests testtrans@TestTransport{..} = do
384− node1 <- newLocalNode testTransport initRemoteTable
287+tests :: LocalNode -> IO [Test]
288+tests node1 = do
385289 -- if we execute the test cases in parallel, the
386290 -- various tracers will race with one another and
387291 -- we'll get garbage results (or worse, deadlocks)
@@ -419,13 +323,13 @@ tests testtrans@TestTransport{..} = do
419323 , testCase "Remote Trace Relay"
420324 (synchronisedAssertion
421325 "expected blah"
422− 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− ]
326+ node1 True testRemoteTraceRelay lock)
431327 ] ]
328+
329+timerTests :: NT.Transport -> IO [Test]
330+timerTests _ = do
331+ mkNode "8080" >>= tests >>= return
332+
333+main :: IO ()
334+main = testMain $ timerTests
335+
tests/TestUtils.hsnew file+75
@@ -0,0 +1,75 @@
1+-- | General testing support. Just @import TestUtils@ in your test module.
2+module TestUtils where
3+
4+#if ! MIN_VERSION_base(4,6,0)
5+import Prelude hiding (catch)
6+#endif
7+import Control.Concurrent.MVar
8+ ( MVar
9+ , newEmptyMVar
10+ , takeMVar
11+ , putMVar
12+ )
13+
14+import Control.Distributed.Process
15+import Control.Distributed.Process.Node
16+import Control.Distributed.Process.Serializable()
17+import Test.HUnit (Assertion)
18+import Test.HUnit.Base (assertBool)
19+import Test.Framework (Test, defaultMain)
20+
21+import Network.Transport.TCP
22+import qualified Network.Transport as NT
23+
24+-- these utilities have been cribbed from distributed-process-platform
25+-- we should really find a way to share them...
26+
27+mkNode :: String -> IO LocalNode
28+mkNode port = do
29+ Right (transport1, _) <- createTransportExposeInternals
30+ "127.0.0.1" port defaultTCPParameters
31+ newLocalNode transport1 initRemoteTable
32+
33+-- | Given a @builder@ function, make and run a test suite on a single transport
34+testMain :: (NT.Transport -> IO [Test]) -> IO ()
35+testMain builder = do
36+ Right (transport, _) <- createTransportExposeInternals
37+ "127.0.0.1" "10001" defaultTCPParameters
38+ testData <- builder transport
39+ defaultMain testData
40+
41+-- | A mutable cell containing a test result.
42+type TestResult a = MVar a
43+
44+synchronisedAssertion :: (Eq a)
45+ => String
46+ -> LocalNode
47+ -> a
48+ -> (TestResult a -> Process ())
49+ -> MVar ()
50+ -> Assertion
51+synchronisedAssertion note localNode expected testProc lock = do
52+ result <- newEmptyMVar
53+ _ <- forkProcess localNode $ do
54+ acquire lock
55+ finally (testProc result)
56+ (release lock)
57+ assertComplete note result expected
58+ where acquire lock' = liftIO $ takeMVar lock'
59+ release lock' = liftIO $ putMVar lock' ()
60+
61+delayedAssertion :: (Eq a) => String -> LocalNode -> a ->
62+ (TestResult a -> Process ()) -> Assertion
63+delayedAssertion note localNode expected testProc = do
64+ result <- newEmptyMVar
65+ _ <- forkProcess localNode $ testProc result
66+ assertComplete note result expected
67+
68+assertComplete :: (Eq a) => String -> MVar a -> a -> IO ()
69+assertComplete msg mv a = do
70+ b <- takeMVar mv
71+ assertBool msg (a == b)
72+
73+stash :: TestResult a -> a -> Process ()
74+stash mvar x = liftIO $ putMVar mvar x
75+