git.iko.soy/distributed-process
on 905b487 help sign in
.gitignore+14−3
since splitsnapshots
unifiedsplit
@@ -1,4 +1,15 @@
1+tags
2+TAGS
1dist/
3dist/
4+\#*#
5+*~
6+*.aux
7+*.hp
8+*.hi
9+*.o
10+*.prof
11+*.ps
12+*.swp
2−.cabal-sandbox
13+cabal-dev
3−cabal.sandbox.config
14+cabal-dev*
4−.stack*
15+.DS_Store
.travis.yml+13−42
@@ -1,43 +1,14 @@
1−language: c
1+language: haskell
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:
2+script: "make ci"
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−
41notifications:
3notifications:
42− slack:
4+ email:
43− secure: LbqbNjK1KiHNiQo/i/Za4vkMD9l9mhmN+PWYFBQkNvGFWffSRayRKFrTqt4znV2p7h4dY1XZFoC7T5RemBVQLq2ppZAUWxkITeu1OUlnmVLDfJLeVYGTR/fn90nP6Y5ITE7T3A07nKmWaRbKpIgFBAOjzgqaM0csscDx3z0WW18=
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−
1392013-01-27 Tim Watson <watson.timothy@gmail.com> 0.4.2
12013-01-27 Tim Watson <watson.timothy@gmail.com> 0.4.2
140
2
141* Improved exception handling for deferred type checked exit reasons
3* Improved exception handling for deferred type checked exit reasons
LICENSE−1
@@ -1,5 +1,4 @@
1Copyright Well-Typed LLP, 2011-2012
1Copyright Well-Typed LLP, 2011-2012
2−Copyright Tweag I/O Limited, 2015
3
2
4All rights reserved.
3All rights reserved.
5
4
Makefilenew file+62
@@ -0,0 +1,62 @@
1+# CI build
2+
3+GHC ?= $(shell which ghc)
4+CABAL ?= $(shell which cabal)
5+CABAL_DEV ?= $(shell which cabal-dev)
6+PWD = $(shell pwd)
7+SANDBOX ?= $(PWD)/cabal-dev
8+BRANCH ?= $(shell git branch | grep '*' | awk '/.*/ { print $NF }')
9+GIT_BASE ?= git://github.com/haskell-distributed
10+USE_LOCAL_UMBRELLA ?=
11+REPOS=$(shell cat REPOS | sed '/^$$/d')
12+
13+.PHONY: all
14+all:
15+ $(info branch = ${BRANCH})
16+
17+.PHONY: clean
18+clean:
19+ rm -rf ${REPOS} ./dist ./cabal-dev
20+
21+.PHONY: dev-install
22+ifneq (,$(CABAL_DEV))
23+dev-install: $(REPOS)
24+ $(CABAL_DEV) install --enable-tests
25+else
26+dev-install:
27+ $(error install cabal-dev to proceed)
28+endif
29+
30+.PHONY: ci
31+ci: travis-install travis-test
32+
33+.PHONY: travis-install
34+travis-install: $(REPOS)
35+ $(CABAL) install --with-ghc=$(GHC) $(REPOS) --force-reinstalls
36+ $(CABAL) install
37+
38+.PHONY: travis-test
39+travis-test:
40+ $(CABAL) configure --enable-tests
41+ $(CABAL) build
42+ $(CABAL) test --show-details=always
43+
44+ifneq (,$(USE_LOCAL_UMBRELLA))
45+define clone
46+ git clone $(GIT_BASE)/$1 $1
47+endef
48+else
49+define clone
50+ git clone $(GIT_BASE)/$1.git $1
51+endef
52+endif
53+
54+$(REPOS):
55+ $(call clone,$@)
56+ git --git-dir=$@/.git \
57+ --work-tree=$@ \
58+ checkout $(BRANCH)
59+ cd $@ && $(CABAL_DEV) install --sandbox=$(SANDBOX)
60+
61+./build:
62+ mkdir -p build
README.md+10−7
@@ -1,16 +1,19 @@
1−# distributed-process
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)
4
2
5This repository is part of Cloud Haskell.
3This repository is part of Cloud Haskell.
6
4
7See http://haskell-distributed.github.com for documentation, user guides,
5See http://haskell-distributed.github.com for documentation, user guides,
8tutorials and assistance.
6tutorials and assistance.
9
7
10−## Getting Help / Raising Issues
8+### Getting Help / Raising Issues
11
9
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.
13
13
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.
15
16
17+### License
18+
16−This package is made available under a 3-clause BSD-style license.
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
4import Control.Applicative
4import Control.Applicative
5import Control.Distributed.Process
5import Control.Distributed.Process
6import Control.Distributed.Process.Node
6import Control.Distributed.Process.Node
7−import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
7+import Network.Transport.TCP (createTransport, defaultTCPParameters)
8import Data.Binary (encode, decode)
8import Data.Binary (encode, decode)
9import qualified Data.ByteString.Lazy as BSL
9import qualified Data.ByteString.Lazy as BSL
10
10
@@ -36,8 +36,6 @@ initialProcess "CLIENT" = do
36main :: IO ()
36main :: IO ()
37main = do
37main = do
38 [role, host, port] <- getArgs
38 [role, host, port] <- getArgs
39− trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
39+ Right transport <- createTransport host port defaultTCPParameters
40− case trans of
41− Right transport -> do node <- newLocalNode transport initRemoteTable
40+ node <- newLocalNode transport initRemoteTable
42− runProcess node $ initialProcess role
41+ runProcess node $ initialProcess role
43− Left other -> error $ show other
benchmarks/Latency.hs+4−7
@@ -3,7 +3,7 @@ import Control.Monad
3import Control.Applicative
3import Control.Applicative
4import Control.Distributed.Process
4import Control.Distributed.Process
5import Control.Distributed.Process.Node
5import Control.Distributed.Process.Node
6−import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
6+import Network.Transport.TCP (createTransport, defaultTCPParameters)
7import Data.Binary (encode, decode)
7import Data.Binary (encode, decode)
8import qualified Data.ByteString.Lazy as BSL
8import qualified Data.ByteString.Lazy as BSL
9
9
@@ -31,9 +31,6 @@ initialProcess "CLIENT" = do
31main :: IO ()
31main :: IO ()
32main = do
32main = do
33 [role, host, port] <- getArgs
33 [role, host, port] <- getArgs
34− trans <- createTransport
35− (defaultTCPAddr host port) defaultTCPParameters
34+ Right transport <- createTransport host port defaultTCPParameters
36− case trans of
37− Right transport -> do node <- newLocalNode transport initRemoteTable
35+ node <- newLocalNode transport initRemoteTable
38− runProcess node $ initialProcess role
36+ runProcess node $ initialProcess role
39− Left other -> error $ show other
benchmarks/ProcessRing.hs+4−8
@@ -4,15 +4,11 @@ To run the benchmarks, select a value for the ring size (sz) and
4the number of times to send a message around the ring
4the number of times to send a message around the ring
5
5
6-}
6-}
7−
8−{-# LANGUAGE BangPatterns #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−
11import Control.Monad
7import Control.Monad
12import Control.Distributed.Process hiding (catch)
8import Control.Distributed.Process hiding (catch)
13import Control.Distributed.Process.Node
9import Control.Distributed.Process.Node
14import Control.Exception (catch, SomeException)
10import Control.Exception (catch, SomeException)
15−import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
11+import Network.Transport.TCP (createTransport, defaultTCPParameters)
16import System.Environment
12import System.Environment
17import System.Console.GetOpt
13import System.Console.GetOpt
18
14
@@ -85,7 +81,7 @@ options =
85 (NoArg (\opts -> opts { optUnsafe = True }))
81 (NoArg (\opts -> opts { optUnsafe = True }))
86 "use 'unsafeSend' (ignored with -f) - default = False"
82 "use 'unsafeSend' (ignored with -f) - default = False"
87 , Option ['p'] ["parallel"]
83 , Option ['p'] ["parallel"]
88− (NoArg (\opts -> opts { optParallel = True }))
84+ (NoArg (\opts -> opts { optForward = True }))
89 "send in parallel and consume sequentially - default = False"
85 "send in parallel and consume sequentially - default = False"
90 ]
86 ]
91
87
@@ -110,8 +106,8 @@ main = do
110 argv <- getArgs
106 argv <- getArgs
111 (opt, _) <- parseArgv argv
107 (opt, _) <- parseArgv argv
112 putStrLn $ "options: " ++ (show opt)
108 putStrLn $ "options: " ++ (show opt)
113− Right transport <- createTransport
109+ Right transport <- createTransport "127.0.0.1" "8090" defaultTCPParameters
114− (defaultTCPAddr "127.0.0.1" "8090" ) defaultTCPParameters
115 node <- newLocalNode transport initRemoteTable
110 node <- newLocalNode transport initRemoteTable
116 catch (void $ runProcess node $ initialProcess opt)
111 catch (void $ runProcess node $ initialProcess opt)
117 (\(e :: SomeException) -> putStrLn $ "ERROR: " ++ (show e))
112 (\(e :: SomeException) -> putStrLn $ "ERROR: " ++ (show e))
113+
benchmarks/Spawns.hs+4−8
@@ -1,5 +1,3 @@
1−{-# LANGUAGE BangPatterns #-}
2−
3-- | Like Throughput, but send every ping from a different process
1-- | Like Throughput, but send every ping from a different process
4-- (i.e., require a lightweight connection per ping)
2-- (i.e., require a lightweight connection per ping)
5import System.Environment
3import System.Environment
@@ -7,7 +5,7 @@ import Control.Monad
7import Control.Applicative
5import Control.Applicative
8import Control.Distributed.Process
6import Control.Distributed.Process
9import Control.Distributed.Process.Node
7import Control.Distributed.Process.Node
10−import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
8+import Network.Transport.TCP (createTransport, defaultTCPParameters)
11import Data.Binary (encode, decode)
9import Data.Binary (encode, decode)
12import qualified Data.ByteString.Lazy as BSL
10import qualified Data.ByteString.Lazy as BSL
13
11
@@ -42,8 +40,6 @@ initialProcess "CLIENT" = do
42main :: IO ()
40main :: IO ()
43main = do
41main = do
44 [role, host, port] <- getArgs
42 [role, host, port] <- getArgs
45− trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
43+ Right transport <- createTransport host port defaultTCPParameters
46− case trans of
47− Right transport -> do node <- newLocalNode transport initRemoteTable
44+ node <- newLocalNode transport initRemoteTable
48− runProcess node $ initialProcess role
45+ runProcess node $ initialProcess role
49− Left other -> error $ show other
benchmarks/Throughput.hs+4−8
@@ -1,12 +1,10 @@
1−{-# LANGUAGE BangPatterns #-}
2{-# LANGUAGE DeriveDataTypeable #-}
1{-# LANGUAGE DeriveDataTypeable #-}
3−
4import System.Environment
2import System.Environment
5import Control.Monad
3import Control.Monad
6import Control.Applicative
4import Control.Applicative
7import Control.Distributed.Process
5import Control.Distributed.Process
8import Control.Distributed.Process.Node
6import Control.Distributed.Process.Node
9−import Network.Transport.TCP (createTransport, defaultTCPParameters, defaultTCPAddr)
7+import Network.Transport.TCP (createTransport, defaultTCPParameters)
10import Data.Binary
8import Data.Binary
11import qualified Data.ByteString.Lazy as BSL
9import qualified Data.ByteString.Lazy as BSL
12import Data.Typeable
10import Data.Typeable
@@ -67,8 +65,6 @@ initialProcess "CLIENT" = do
67main :: IO ()
65main :: IO ()
68main = do
66main = do
69 [role, host, port] <- getArgs
67 [role, host, port] <- getArgs
70− trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
68+ Right transport <- createTransport host port defaultTCPParameters
71− case trans of
72− Right transport -> do node <- newLocalNode transport initRemoteTable
69+ node <- newLocalNode transport initRemoteTable
73− runProcess node $ initialProcess role
70+ runProcess node $ initialProcess role
74− Left other -> error $ show other
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+253−120
@@ -1,15 +1,15 @@
1Name: distributed-process
1Name: distributed-process
2−Version: 0.7.4
2+Version: 0.4.2
3Cabal-Version: >=1.8
3Cabal-Version: >=1.8
4Build-Type: Simple
4Build-Type: Simple
5License: BSD3
5License: BSD3
6License-File: LICENSE
6License-File: LICENSE
7−Copyright: Well-Typed LLP, Tweag I/O Limited
7+Copyright: Well-Typed LLP
8Author: Duncan Coutts, Nicolas Wu, Edsko de Vries
8Author: 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
10Stability: experimental
10Stability: experimental
11Homepage: http://haskell-distributed.github.com/
11Homepage: http://haskell-distributed.github.com/
12−Bug-Reports: https://github.com/haskell-distributed/distributed-process/issues
12+Bug-Reports: http://cloud-haskell.atlassian.net
13Synopsis: Cloud Haskell: Erlang-style concurrency in Haskell
13Synopsis: Cloud Haskell: Erlang-style concurrency in Haskell
14Description: This is an implementation of Cloud Haskell, as described in
14Description: This is an implementation of Cloud Haskell, as described in
15 /Towards Haskell in the Cloud/ by Jeff Epstein, Andrew Black,
15 /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
17 (<http://research.microsoft.com/en-us/um/people/simonpj/papers/parallel/>),
17 (<http://research.microsoft.com/en-us/um/people/simonpj/papers/parallel/>),
18 although some of the details are different. The precise message
18 although some of the details are different. The precise message
19 passing semantics are based on /A unified semantics for future Erlang/
19 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.
21
21
22 You will probably also want to install a Cloud Haskell backend such
22 You will probably also want to install a Cloud Haskell backend such
23 as distributed-process-simplelocalnet.
23 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
25Category: Control
25Category: Control
26−extra-source-files: ChangeLog
27
26
28Source-Repository head
27Source-Repository head
29 Type: git
28 Type: git
@@ -34,135 +33,269 @@ flag th
34 description: Build with Template Haskell support
33 description: Build with Template Haskell support
35 default: True
34 default: True
36
35
37−flag old-locale
36+flag benchmarks
38− description: If false then depend on time >= 1.5.
37+ description: Build benchmarks
39− .
38+ default: False
40− If true then depend on time < 1.5 together with old-locale.
39+
40+flag prof
41+ description: Compiling with profiling enabled
41− default: False
42+ default: False
42
43
43Library
44Library
44− Build-Depends: base >= 4.6 && < 5,
45+ Build-Depends: base >= 4.4 && < 5,
45− binary >= 0.6.3 && < 0.10,
46+ binary >= 0.5 && < 0.8,
47+ deepseq >= 1.3.0.1 && < 1.4,
46 hashable >= 1.2.0.5 && < 1.3,
48 hashable >= 1.2.0.5 && < 1.3,
47− network-transport >= 0.4.1.0 && < 0.6,
49+ network-transport >= 0.3 && < 0.4,
48− stm >= 2.4 && < 2.6,
50+ stm >= 2.4 && < 2.5,
49− transformers >= 0.2 && < 0.6,
51+ transformers >= 0.2 && < 0.4,
50− mtl >= 2.0 && < 2.4,
52+ mtl >= 2.0 && < 2.2,
51 data-accessor >= 0.2 && < 0.3,
53 data-accessor >= 0.2 && < 0.3,
52 bytestring >= 0.9 && < 0.11,
54 bytestring >= 0.9 && < 0.11,
55+ containers >= 0.4 && < 0.6,
56+ old-locale >= 1.0 && < 1.1,
57+ time >= 1.2 && < 1.5,
53− random >= 1.0 && < 1.2,
58+ random >= 1.0 && < 1.1,
59+ ghc-prim >= 0.2 && < 0.4,
54− distributed-static >= 0.2 && < 0.4,
60+ distributed-static >= 0.2 && < 0.3,
55− rank1dynamic >= 0.1 && < 0.5,
61+ rank1dynamic >= 0.1 && < 0.2,
56− syb >= 0.3 && < 0.8,
62+ syb >= 0.3 && < 0.4
57− exceptions >= 0.5,
58− containers >= 0.5 && < 0.7,
59− deepseq >= 1.3.0.1 && < 1.6
60 Exposed-modules: Control.Distributed.Process,
63 Exposed-modules: Control.Distributed.Process,
61 Control.Distributed.Process.Closure,
64 Control.Distributed.Process.Closure,
62 Control.Distributed.Process.Debug,
65 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,
73 Control.Distributed.Process.Internal.Types,
66 Control.Distributed.Process.Internal.Types,
74− Control.Distributed.Process.Internal.WeakTQueue,
75 Control.Distributed.Process.Management,
67 Control.Distributed.Process.Management,
68+ Control.Distributed.Process.Management.Agent,
76 Control.Distributed.Process.Node,
69 Control.Distributed.Process.Node,
77 Control.Distributed.Process.Serializable,
70 Control.Distributed.Process.Serializable,
78 Control.Distributed.Process.UnsafePrimitives
71 Control.Distributed.Process.UnsafePrimitives
72+ Other-modules: Control.Distributed.Process.Internal.Primitives,
79− Control.Distributed.Process.Management.Internal.Agent,
73+ Control.Distributed.Process.Internal.Spawn,
74+ Control.Distributed.Process.Internal.Primitives,
80− Control.Distributed.Process.Management.Internal.Bus,
75+ Control.Distributed.Process.Internal.CQueue,
76+ Control.Distributed.Process.Internal.Closure.BuiltIn,
77+ Control.Distributed.Process.Internal.Messaging,
78+ Control.Distributed.Process.Internal.StrictList,
79+ Control.Distributed.Process.Internal.StrictMVar,
80+ Control.Distributed.Process.Internal.WeakTQueue,
81+ Control.Distributed.Process.Internal.StrictContainerAccessors,
82+ Control.Distributed.Process.Management.Bus,
81− Control.Distributed.Process.Management.Internal.Types,
83+ Control.Distributed.Process.Management.Table,
84+ Control.Distributed.Process.Management.Types,
82− Control.Distributed.Process.Management.Internal.Trace.Primitives,
85+ Control.Distributed.Process.Management.Trace.Primitives,
83− Control.Distributed.Process.Management.Internal.Trace.Remote,
86+ Control.Distributed.Process.Management.Trace.Remote,
84− Control.Distributed.Process.Management.Internal.Trace.Types,
87+ Control.Distributed.Process.Management.Trace.Types,
85− Control.Distributed.Process.Management.Internal.Trace.Tracer
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
86 ghc-options: -Wall
99 ghc-options: -Wall
87 HS-Source-Dirs: src
100 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
112 if flag(th)
101 if flag(th)
113− other-extensions: TemplateHaskell
114− Build-Depends: template-haskell >= 2.6
102+ Build-Depends: template-haskell >= 2.6 && < 2.9
115 Exposed-modules: Control.Distributed.Process.Internal.Closure.TH
103 Exposed-modules: Control.Distributed.Process.Internal.Closure.TH
116 CPP-Options: -DTemplateHaskellSupport
104 CPP-Options: -DTemplateHaskellSupport
117
105
106+Test-Suite TestCH
107+ Type: exitcode-stdio-1.0
108+ Main-Is: TestCH.hs
109+ Build-Depends: base >= 4.4 && < 5,
110+ random >= 1.0 && < 1.1,
111+ ansi-terminal >= 0.5 && < 0.6,
118−-- Tests are in distributed-process-test package, for convenience.
112+ distributed-process,
119−
113+ network-transport >= 0.3 && < 0.4,
114+ network-transport-tcp >= 0.3 && < 0.4,
115+ binary >= 0.5 && < 0.8,
116+ network >= 2.3 && < 2.5,
117+ HUnit >= 1.2 && < 1.3,
118+ test-framework >= 0.6 && < 0.9,
119+ test-framework-hunit >= 0.2.0 && < 0.4,
120+ rematch >= 0.1.2.1
121+ Extensions: CPP,
122+ ScopedTypeVariables,
123+ DeriveDataTypeable,
124+ GeneralizedNewtypeDeriving
125+ ghc-options: -Wall -threaded -debug -eventlog -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
126+ HS-Source-Dirs: tests
127+
128+Test-Suite TestClosure
129+ Type: exitcode-stdio-1.0
130+ Main-Is: TestClosure.hs
131+ Build-Depends: base >= 4.4 && < 5,
132+ random >= 1.0 && < 1.1,
133+ ansi-terminal >= 0.5 && < 0.6,
134+ distributed-static >= 0.2 && < 0.3,
135+ distributed-process,
136+ network-transport >= 0.3 && < 0.4,
137+ network-transport-tcp >= 0.3 && < 0.4,
138+ bytestring >= 0.9 && < 0.11,
139+ network >= 2.3 && < 2.5,
140+ HUnit >= 1.2 && < 1.3,
141+ test-framework >= 0.6 && < 0.9,
142+ test-framework-hunit >= 0.2.0 && < 0.4
143+ Extensions: CPP,
144+ ScopedTypeVariables
145+ ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
146+ HS-Source-Dirs: tests
147+
148+Test-Suite TestStats
149+ Type: exitcode-stdio-1.0
150+ Main-Is: TestStats.hs
151+ Build-Depends: base >= 4.4 && < 5,
152+ random >= 1.0 && < 1.1,
153+ ansi-terminal >= 0.5 && < 0.6,
154+ containers >= 0.4 && < 0.6,
155+ stm >= 2.4 && < 2.5,
156+ distributed-process,
157+ network-transport >= 0.3 && < 0.4,
158+ network-transport-tcp >= 0.3 && < 0.4,
159+ binary >= 0.5 && < 0.8,
160+ network >= 2.3 && < 2.5,
161+ HUnit >= 1.2 && < 1.3,
162+ test-framework >= 0.6 && < 0.9,
163+ test-framework-hunit >= 0.2.0 && < 0.4
164+ Extensions: CPP,
165+ ScopedTypeVariables,
166+ DeriveDataTypeable,
167+ GeneralizedNewtypeDeriving
168+ ghc-options: -Wall -debug -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
169+ HS-Source-Dirs: tests
170+
171+
172+Test-Suite TestMx
173+ Type: exitcode-stdio-1.0
174+ Main-Is: TestMx.hs
175+ Build-Depends: base >= 4.4 && < 5,
176+ random >= 1.0 && < 1.1,
177+ ansi-terminal >= 0.5 && < 0.6,
178+ containers >= 0.4 && < 0.6,
179+ stm >= 2.4 && < 2.5,
180+ distributed-process,
181+ network-transport >= 0.3 && < 0.4,
182+ network-transport-tcp >= 0.3 && < 0.4,
183+ binary >= 0.5 && < 0.7,
184+ network >= 2.3 && < 2.5,
185+ HUnit >= 1.2 && < 1.3,
186+ test-framework >= 0.6 && < 0.9,
187+ test-framework-hunit >= 0.2.0 && < 0.4,
188+ unix >= 2.5.0.0
189+ Extensions: RankNTypes,
190+ ScopedTypeVariables,
191+ FlexibleInstances,
192+ UndecidableInstances,
193+ ExistentialQuantification,
194+ GADTs,
195+ GeneralizedNewtypeDeriving,
196+ DeriveDataTypeable,
197+ CPP,
198+ BangPatterns
199+ ghc-options: -Wall -debug -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
200+ HS-Source-Dirs: tests
201+
202+Test-Suite TestTracing
203+ Type: exitcode-stdio-1.0
204+ Main-Is: TestTracing.hs
205+ Build-Depends: base >= 4.4 && < 5,
206+ random >= 1.0 && < 1.1,
207+ ansi-terminal >= 0.5 && < 0.6,
208+ containers >= 0.4 && < 0.6,
209+ stm >= 2.4 && < 2.5,
210+ distributed-process,
211+ network-transport >= 0.3 && < 0.4,
212+ network-transport-tcp >= 0.3 && < 0.4,
213+ binary >= 0.5 && < 0.7,
214+ network >= 2.3 && < 2.5,
215+ HUnit >= 1.2 && < 1.3,
216+ test-framework >= 0.6 && < 0.9,
217+ test-framework-hunit >= 0.2.0 && < 0.4,
218+ unix >= 2.5.0.0
219+ Extensions: RankNTypes,
220+ ScopedTypeVariables,
221+ FlexibleInstances,
222+ UndecidableInstances,
223+ ExistentialQuantification,
224+ GADTs,
225+ GeneralizedNewtypeDeriving,
226+ DeriveDataTypeable,
227+ CPP,
228+ BangPatterns
229+ ghc-options: -Wall -debug -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
230+ HS-Source-Dirs: tests
231+
120−benchmark distributed-process-throughput
232+Executable distributed-process-throughput
121− Type: exitcode-stdio-1.0
233+ if flag(benchmarks)
122− Build-Depends: base >= 4.6 && < 5,
234+ Build-Depends: base >= 4.4 && < 5,
123− distributed-process,
235+ distributed-process,
124− network-transport-tcp >= 0.3 && < 0.7,
236+ network-transport-tcp >= 0.3 && < 0.4,
125− bytestring >= 0.9 && < 0.11,
237+ bytestring >= 0.9 && < 0.11,
126− binary >= 0.6.3 && < 0.10
238+ binary >= 0.5 && < 0.8
239+ else
240+ buildable: False
127− Main-Is: benchmarks/Throughput.hs
241+ Main-Is: benchmarks/Throughput.hs
128− ghc-options: -Wall
242+ ghc-options: -Wall
129−
243+ Extensions: BangPatterns
244+
130−benchmark distributed-process-latency
245+Executable distributed-process-latency
131− Type: exitcode-stdio-1.0
246+ if flag(benchmarks)
132− Build-Depends: base >= 4.6 && < 5,
247+ Build-Depends: base >= 4.4 && < 5,
133− distributed-process,
248+ distributed-process,
134− network-transport-tcp >= 0.3 && < 0.7,
249+ network-transport-tcp >= 0.3 && < 0.4,
135− bytestring >= 0.9 && < 0.11,
250+ bytestring >= 0.9 && < 0.11,
136− binary >= 0.6.3 && < 0.10
251+ binary >= 0.5 && < 0.8
252+ else
253+ buildable: False
137− Main-Is: benchmarks/Latency.hs
254+ Main-Is: benchmarks/Latency.hs
138− ghc-options: -Wall
255+ ghc-options: -Wall
139−
256+ Extensions: BangPatterns
257+
140−benchmark distributed-process-channels
258+Executable distributed-process-channels
141− Type: exitcode-stdio-1.0
259+ if flag(benchmarks)
142− Build-Depends: base >= 4.6 && < 5,
260+ Build-Depends: base >= 4.4 && < 5,
143− distributed-process,
261+ distributed-process,
144− network-transport-tcp >= 0.3 && < 0.7,
262+ network-transport-tcp >= 0.3 && < 0.4,
145− bytestring >= 0.9 && < 0.11,
263+ bytestring >= 0.9 && < 0.11,
146− binary >= 0.6.3 && < 0.10
264+ binary >= 0.5 && < 0.8
265+ else
266+ buildable: False
147− Main-Is: benchmarks/Channels.hs
267+ Main-Is: benchmarks/Channels.hs
148− ghc-options: -Wall
268+ ghc-options: -Wall
149−
269+ Extensions: BangPatterns
270+
150−benchmark distributed-process-spawns
271+Executable distributed-process-spawns
151− Type: exitcode-stdio-1.0
272+ if flag(benchmarks)
152− Build-Depends: base >= 4.6 && < 5,
273+ Build-Depends: base >= 4.4 && < 5,
153− distributed-process,
274+ distributed-process,
154− network-transport-tcp >= 0.3 && < 0.7,
275+ network-transport-tcp >= 0.3 && < 0.4,
155− bytestring >= 0.9 && < 0.11,
276+ bytestring >= 0.9 && < 0.11,
156− binary >= 0.6.3 && < 0.10
277+ binary >= 0.5 && < 0.8
278+ else
279+ buildable: False
157− Main-Is: benchmarks/Spawns.hs
280+ Main-Is: benchmarks/Spawns.hs
158− ghc-options: -Wall
281+ ghc-options: -Wall
159−
282+ Extensions: BangPatterns
283+
160−benchmark distributed-process-ring
284+Executable distributed-process-ring
161− Type: exitcode-stdio-1.0
285+ if flag(benchmarks)
162− Build-Depends: base >= 4.6 && < 5,
286+ Build-Depends: base >= 4.4 && < 5,
163− distributed-process,
287+ distributed-process,
164− network-transport-tcp >= 0.3 && < 0.7,
288+ network-transport-tcp >= 0.3 && < 0.4,
165− bytestring >= 0.9 && < 0.11,
289+ bytestring >= 0.9 && < 0.11,
166− binary >= 0.6.3 && < 0.10
290+ binary >= 0.5 && < 0.8
291+ else
292+ buildable: False
167− Main-Is: benchmarks/ProcessRing.hs
293+ Main-Is: benchmarks/ProcessRing.hs
294+ if flag(prof)
295+ ghc-options: -Wall -threaded -prof -auto-all -fno-prof-count-entries -rtsopts
296+ else
168− ghc-options: -Wall -threaded -O2 -rtsopts
297+ ghc-options: -Wall -threaded -O2 -rtsopts
298+ Extensions: BangPatterns,
299+ ScopedTypeVariables
300+
301+
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−76
@@ -1,4 +1,3 @@
1−{-# LANGUAGE CPP #-}
2{- | [Cloud Haskell]
1{- | [Cloud Haskell]
3
2
4This is an implementation of Cloud Haskell, as described in
3This is an implementation of Cloud Haskell, as described in
@@ -17,7 +16,7 @@ please see the distributed-process wiki page on github:
17module Control.Distributed.Process
16module Control.Distributed.Process
18 ( -- * Basic types
17 ( -- * Basic types
19 ProcessId
18 ProcessId
20− , NodeId(..)
19+ , NodeId
21 , Process
20 , Process
22 , SendPortId
21 , SendPortId
23 , processNodeId
22 , processNodeId
@@ -25,7 +24,6 @@ module Control.Distributed.Process
25 , liftIO -- Reexported for convenience
24 , liftIO -- Reexported for convenience
26 -- * Basic messaging
25 -- * Basic messaging
27 , send
26 , send
28− , usend
29 , expect
27 , expect
30 , expectTimeout
28 , expectTimeout
31 -- * Channels
29 -- * Channels
@@ -40,11 +38,8 @@ module Control.Distributed.Process
40 , mergePortsRR
38 , mergePortsRR
41 -- * Unsafe messaging variants
39 -- * Unsafe messaging variants
42 , unsafeSend
40 , unsafeSend
43− , unsafeUSend
44 , unsafeSendChan
41 , unsafeSendChan
45 , unsafeNSend
42 , unsafeNSend
46− , unsafeNSendRemote
47− , unsafeWrapMessage
48 -- * Advanced messaging
43 -- * Advanced messaging
49 , Match
44 , Match
50 , receiveWait
45 , receiveWait
@@ -55,7 +50,6 @@ module Control.Distributed.Process
55 , matchAny
50 , matchAny
56 , matchAnyIf
51 , matchAnyIf
57 , matchChan
52 , matchChan
58− , matchSTM
59 , Message
53 , Message
60 , matchMessage
54 , matchMessage
61 , matchMessageIf
55 , matchMessageIf
@@ -64,10 +58,7 @@ module Control.Distributed.Process
64 , unwrapMessage
58 , unwrapMessage
65 , handleMessage
59 , handleMessage
66 , handleMessageIf
60 , handleMessageIf
67− , handleMessage_
68− , handleMessageIf_
69 , forward
61 , forward
70− , uforward
71 , delegate
62 , delegate
72 , relay
63 , relay
73 , proxy
64 , proxy
@@ -87,9 +78,6 @@ module Control.Distributed.Process
87 , getSelfNode
78 , getSelfNode
88 , ProcessInfo(..)
79 , ProcessInfo(..)
89 , getProcessInfo
80 , getProcessInfo
90− , NodeStats(..)
91− , getNodeStats
92− , getLocalNodeStats
93 -- * Monitoring and linking
81 -- * Monitoring and linking
94 , link
82 , link
95 , linkNode
83 , linkNode
@@ -102,7 +90,6 @@ module Control.Distributed.Process
102 , monitorPort
90 , monitorPort
103 , unmonitor
91 , unmonitor
104 , withMonitor
92 , withMonitor
105− , withMonitor_
106 , MonitorRef -- opaque
93 , MonitorRef -- opaque
107 , ProcessLinkException(..)
94 , ProcessLinkException(..)
108 , NodeLinkException(..)
95 , NodeLinkException(..)
@@ -139,7 +126,6 @@ module Control.Distributed.Process
139 , catches
126 , catches
140 , try
127 , try
141 , mask
128 , mask
142− , mask_
143 , onException
129 , onException
144 , bracket
130 , bracket
145 , bracket_
131 , bracket_
@@ -154,22 +140,19 @@ module Control.Distributed.Process
154 -- * Local versions of 'spawn'
140 -- * Local versions of 'spawn'
155 , spawnLocal
141 , spawnLocal
156 , spawnChannelLocal
142 , spawnChannelLocal
157− , callLocal
158 -- * Reconnecting
143 -- * Reconnecting
159 , reconnect
144 , reconnect
160 , reconnectPort
145 , reconnectPort
161 ) where
146 ) where
162
147
148+#if ! MIN_VERSION_base(4,6,0)
149+import Prelude hiding (catch)
150+#endif
151+
163import Control.Monad.IO.Class (liftIO)
152import Control.Monad.IO.Class (liftIO)
164−import Control.Applicative
153+import Control.Applicative ((<$>))
165import Control.Monad.Reader (ask)
154import Control.Monad.Reader (ask)
166−import Control.Concurrent (killThread)
155+import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
167−import Control.Concurrent.MVar
168− ( MVar
169− , newEmptyMVar
170− , takeMVar
171− , putMVar
172− )
173import Control.Distributed.Static
156import Control.Distributed.Static
174 ( Closure
157 ( Closure
175 , closure
158 , closure
@@ -198,13 +181,11 @@ import Control.Distributed.Process.Internal.Types
198 , RegisterReply(..)
181 , RegisterReply(..)
199 , LocalProcess(processNode)
182 , LocalProcess(processNode)
200 , Message
183 , Message
201− , localProcessWithId
202 )
184 )
203import Control.Distributed.Process.Serializable (Serializable)
185import Control.Distributed.Process.Serializable (Serializable)
204import Control.Distributed.Process.Internal.Primitives
186import Control.Distributed.Process.Internal.Primitives
205 ( -- Basic messaging
187 ( -- Basic messaging
206 send
188 send
207− , usend
208 , expect
189 , expect
209 -- Channels
190 -- Channels
210 , newChan
191 , newChan
@@ -213,10 +194,8 @@ import Control.Distributed.Process.Internal.Primitives
213 , mergePortsBiased
194 , mergePortsBiased
214 , mergePortsRR
195 , mergePortsRR
215 , unsafeSend
196 , unsafeSend
216− , unsafeUSend
217 , unsafeSendChan
197 , unsafeSendChan
218 , unsafeNSend
198 , unsafeNSend
219− , unsafeNSendRemote
220 -- Advanced messaging
199 -- Advanced messaging
221 , Match
200 , Match
222 , receiveWait
201 , receiveWait
@@ -227,19 +206,14 @@ import Control.Distributed.Process.Internal.Primitives
227 , matchAny
206 , matchAny
228 , matchAnyIf
207 , matchAnyIf
229 , matchChan
208 , matchChan
230− , matchSTM
231 , matchMessage
209 , matchMessage
232 , matchMessageIf
210 , matchMessageIf
233 , isEncoded
211 , isEncoded
234 , wrapMessage
212 , wrapMessage
235− , unsafeWrapMessage
236 , unwrapMessage
213 , unwrapMessage
237 , handleMessage
214 , handleMessage
238 , handleMessageIf
215 , handleMessageIf
239− , handleMessage_
240− , handleMessageIf_
241 , forward
216 , forward
242− , uforward
243 , delegate
217 , delegate
244 , relay
218 , relay
245 , proxy
219 , proxy
@@ -255,9 +229,6 @@ import Control.Distributed.Process.Internal.Primitives
255 , getSelfNode
229 , getSelfNode
256 , ProcessInfo(..)
230 , ProcessInfo(..)
257 , getProcessInfo
231 , getProcessInfo
258− , NodeStats(..)
259− , getNodeStats
260− , getLocalNodeStats
261 -- Monitoring and linking
232 -- Monitoring and linking
262 , link
233 , link
263 , linkNode
234 , linkNode
@@ -270,7 +241,6 @@ import Control.Distributed.Process.Internal.Primitives
270 , monitorPort
241 , monitorPort
271 , unmonitor
242 , unmonitor
272 , withMonitor
243 , withMonitor
273− , withMonitor_
274 -- Logging
244 -- Logging
275 , say
245 , say
276 -- Registry
246 -- Registry
@@ -293,7 +263,6 @@ import Control.Distributed.Process.Internal.Primitives
293 , catches
263 , catches
294 , try
264 , try
295 , mask
265 , mask
296− , mask_
297 , onException
266 , onException
298 , bracket
267 , bracket
299 , bracket_
268 , bracket_
@@ -307,10 +276,6 @@ import Control.Distributed.Process.Internal.Primitives
307 , reconnectPort
276 , reconnectPort
308 )
277 )
309import Control.Distributed.Process.Node (forkProcess)
278import Control.Distributed.Process.Node (forkProcess)
310−import Control.Distributed.Process.Internal.Types
311− ( processThread
312− , withValidLocalState
313− )
314import Control.Distributed.Process.Internal.Spawn
279import Control.Distributed.Process.Internal.Spawn
315 ( -- Spawning Processes/Channels
280 ( -- Spawning Processes/Channels
316 spawn
281 spawn
@@ -320,17 +285,6 @@ import Control.Distributed.Process.Internal.Spawn
320 , spawnSupervised
285 , spawnSupervised
321 , call
286 , call
322 )
287 )
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−
334
288
335-- INTERNAL NOTES
289-- INTERNAL NOTES
336--
290--
@@ -422,26 +376,3 @@ spawnChannelLocal proc = do
422 proc rport
376 proc rport
423 takeMVar mvar
377 takeMVar mvar
424
378
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
163 , sdictUnit
163 , sdictUnit
164 , sdictProcessId
164 , sdictProcessId
165 , sdictSendPort
165 , sdictSendPort
166− , sdictStatic
167− , sdictClosure
168 -- * The CP type and associated combinators
166 -- * The CP type and associated combinators
169 , CP
167 , CP
170 , idCP
168 , idCP
@@ -179,13 +177,6 @@ module Control.Distributed.Process.Closure
179 , cpSend
177 , cpSend
180 , cpExpect
178 , cpExpect
181 , cpNewChan
179 , cpNewChan
182− -- * Working with static values and closures (without Template Haskell)
183− , RemoteRegister
184− , MkTDict(..)
185− , mkStaticVal
186− , mkClosureValSingle
187− , mkClosureVal
188− , call'
189#ifdef TemplateHaskellSupport
180#ifdef TemplateHaskellSupport
190 -- * Template Haskell support for creating static values and closures
181 -- * Template Haskell support for creating static values and closures
191 , remotable
182 , remotable
@@ -205,8 +196,6 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
205 , sdictUnit
196 , sdictUnit
206 , sdictProcessId
197 , sdictProcessId
207 , sdictSendPort
198 , sdictSendPort
208− , sdictStatic
209− , sdictClosure
210 -- The CP type and associated combinators
199 -- The CP type and associated combinators
211 , CP
200 , CP
212 , idCP
201 , idCP
@@ -222,15 +211,6 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
222 , cpExpect
211 , cpExpect
223 , cpNewChan
212 , cpNewChan
224 )
213 )
225−import Control.Distributed.Process.Internal.Closure.Explicit
226− (
227− RemoteRegister
228− , MkTDict(..)
229− , mkStaticVal
230− , mkClosureValSingle
231− , mkClosureVal
232− , call'
233− )
234#ifdef TemplateHaskellSupport
214#ifdef TemplateHaskellSupport
235import Control.Distributed.Process.Internal.Closure.TH
215import Control.Distributed.Process.Internal.Closure.TH
236 ( remotable
216 ( remotable
src/Control/Distributed/Process/Debug.hs+14−25
@@ -1,6 +1,3 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE RankNTypes #-}
4-----------------------------------------------------------------------------
1-----------------------------------------------------------------------------
5-- |
2-- |
6-- Module : Control.Distributed.Process.Debug
3-- Module : Control.Distributed.Process.Debug
@@ -24,7 +21,7 @@
24-- generates /trace events/, describing internal runtime activities such as
21-- generates /trace events/, describing internal runtime activities such as
25-- the spawning and death of processes, message sending, delivery and so on.
22-- the spawning and death of processes, message sending, delivery and so on.
26-- See the 'MxEvent' type's documentation for a list of all the published
23-- 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.
28-- Users can additionally publish custom trace events in the form of
25-- Users can additionally publish custom trace events in the form of
29-- 'MxLog' log messages or pass custom (i.e., completely user defined)
26-- 'MxLog' log messages or pass custom (i.e., completely user defined)
30-- event data using the 'traceMessage' function.
27-- event data using the 'traceMessage' function.
@@ -78,19 +75,6 @@
78-- This is checked for /any/ non-empty value. If set, all internal traces are
75-- This is checked for /any/ non-empty value. If set, all internal traces are
79-- written to the GHC eventlog.
76-- written to the GHC eventlog.
80--
77--
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−--
94-- Users of the /simplelocalnet/ Cloud Haskell backend should also note that
78-- Users of the /simplelocalnet/ Cloud Haskell backend should also note that
95-- because the trace file option only supports trace output from a single node
79-- because the trace file option only supports trace output from a single node
96-- (so as to avoid interleaving), a file trace configured for the master node
80-- (so as to avoid interleaving), a file trace configured for the master node
@@ -141,14 +125,17 @@ module Control.Distributed.Process.Debug
141 )
125 )
142 where
126 where
143
127
144−import Control.Applicative
128+import Control.Applicative ((<$>))
145import Control.Distributed.Process.Internal.Primitives
129import Control.Distributed.Process.Internal.Primitives
146 ( proxy
130 ( proxy
131+ , finally
147 , die
132 , die
148 , whereis
133 , whereis
149 , send
134 , send
150 , receiveWait
135 , receiveWait
151 , matchIf
136 , matchIf
137+ , finally
138+ , try
152 , monitor
139 , monitor
153 )
140 )
154import Control.Distributed.Process.Internal.Types
141import Control.Distributed.Process.Internal.Types
@@ -157,21 +144,21 @@ import Control.Distributed.Process.Internal.Types
157 , LocalProcess(..)
144 , LocalProcess(..)
158 , ProcessMonitorNotification(..)
145 , ProcessMonitorNotification(..)
159 )
146 )
160−import Control.Distributed.Process.Management.Internal.Types
147+import Control.Distributed.Process.Management.Types
161 ( MxEvent(..)
148 ( MxEvent(..)
162 )
149 )
163−import Control.Distributed.Process.Management.Internal.Trace.Types
150+import Control.Distributed.Process.Management.Trace.Types
164 ( TraceArg(..)
151 ( TraceArg(..)
165 , TraceFlags(..)
152 , TraceFlags(..)
166 , TraceSubject(..)
153 , TraceSubject(..)
167 , defaultTraceFlags
154 , defaultTraceFlags
168 )
155 )
169−import Control.Distributed.Process.Management.Internal.Trace.Tracer
156+import Control.Distributed.Process.Management.Trace.Tracer
170 ( systemLoggerTracer
157 ( systemLoggerTracer
171 , logfileTracer
158 , logfileTracer
172 , eventLogTracer
159 , eventLogTracer
173 )
160 )
174−import Control.Distributed.Process.Management.Internal.Trace.Primitives
161+import Control.Distributed.Process.Management.Trace.Primitives
175 ( withRegisteredTracer
162 ( withRegisteredTracer
176 , enableTrace
163 , enableTrace
177 , enableTraceAsync
164 , enableTraceAsync
@@ -186,18 +173,19 @@ import Control.Distributed.Process.Management.Internal.Trace.Primitives
186 , traceLogFmt
173 , traceLogFmt
187 , traceMessage
174 , traceMessage
188 )
175 )
189−import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Remote
176+import qualified Control.Distributed.Process.Management.Trace.Remote as Remote
190import Control.Distributed.Process.Node
177import Control.Distributed.Process.Node
191
178
192import Control.Exception (SomeException)
179import Control.Exception (SomeException)
193
180
194import Control.Monad.IO.Class (liftIO)
181import Control.Monad.IO.Class (liftIO)
195import Control.Monad.Reader (ask)
182import Control.Monad.Reader (ask)
196−import Control.Monad.Catch (finally, try)
197
183
198import Data.Binary()
184import Data.Binary()
199
185
186+#if ! MIN_VERSION_base(4,6,0)
200−import Prelude
187+import Prelude hiding (catch)
188+#endif
201
189
202--------------------------------------------------------------------------------
190--------------------------------------------------------------------------------
203-- Debugging/Tracing API --
191-- Debugging/Tracing API --
@@ -286,3 +274,4 @@ stopTracer =
286 case basePid == (Just pid) of
274 case basePid == (Just pid) of
287 True -> return ()
275 True -> return ()
288 False -> send pid MxTraceDisable
276 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 #-}
5-- | Concurrent queue for single reader, single writer
1-- | Concurrent queue for single reader, single writer
2+{-# LANGUAGE MagicHash, UnboxedTuples, PatternGuards #-}
6module Control.Distributed.Process.Internal.CQueue
3module Control.Distributed.Process.Internal.CQueue
7 ( CQueue
4 ( CQueue
8 , BlockSpec(..)
5 , BlockSpec(..)
@@ -12,7 +9,6 @@ module Control.Distributed.Process.Internal.CQueue
12 , enqueueSTM
9 , enqueueSTM
13 , dequeue
10 , dequeue
14 , mkWeakCQueue
11 , mkWeakCQueue
15− , queueSize
16 ) where
12 ) where
17
13
18import Prelude hiding (length, reverse)
14import Prelude hiding (length, reverse)
@@ -20,14 +16,10 @@ import Control.Concurrent.STM
20 ( atomically
16 ( atomically
21 , STM
17 , STM
22 , TChan
18 , TChan
23− , TVar
24− , modifyTVar'
25 , tryReadTChan
19 , tryReadTChan
26 , newTChan
20 , newTChan
27− , newTVarIO
28 , writeTChan
21 , writeTChan
29 , readTChan
22 , readTChan
30− , readTVarIO
31 , orElse
23 , orElse
32 , retry
24 , retry
33 )
25 )
@@ -45,56 +37,39 @@ import Control.Distributed.Process.Internal.StrictList
45 , append
37 , append
46 )
38 )
47import Data.Maybe (fromJust)
39import Data.Maybe (fromJust)
48−import Data.Traversable (traverse)
49import GHC.MVar (MVar(MVar))
40import GHC.MVar (MVar(MVar))
50−import GHC.IO (IO(IO), unIO)
41+import GHC.IO (IO(IO))
51−import GHC.Exts (mkWeak#)
42+import GHC.Prim (mkWeak#)
52import GHC.Weak (Weak(Weak))
43import GHC.Weak (Weak(Weak))
53
44
54-- We use a TCHan rather than a Chan so that we have a non-blocking read
45-- We use a TCHan rather than a Chan so that we have a non-blocking read
55data CQueue a = CQueue (StrictMVar (StrictList a)) -- Arrived
46data CQueue a = CQueue (StrictMVar (StrictList a)) -- Arrived
56 (TChan a) -- Incoming
47 (TChan a) -- Incoming
57− (TVar Int) -- Queue size
58
48
59newCQueue :: IO (CQueue a)
49newCQueue :: IO (CQueue a)
60−newCQueue = CQueue <$> newMVar Nil <*> atomically newTChan <*> newTVarIO 0
50+newCQueue = CQueue <$> newMVar Nil <*> atomically newTChan
61
51
62-- | Enqueue an element
52-- | Enqueue an element
63--
53--
64-- Enqueue is strict.
54-- Enqueue is strict.
65enqueue :: CQueue a -> a -> IO ()
55enqueue :: CQueue a -> a -> IO ()
66−enqueue c !a = atomically (enqueueSTM c a)
56+enqueue (CQueue _arrived incoming) !a = atomically $ writeTChan incoming a
67
57
68-- | Variant of enqueue for use in the STM monad.
58-- | Variant of enqueue for use in the STM monad.
69enqueueSTM :: CQueue a -> a -> STM ()
59enqueueSTM :: CQueue a -> a -> STM ()
70−enqueueSTM (CQueue _arrived incoming size) !a = do
60+enqueueSTM (CQueue _arrived incoming) !a = writeTChan incoming a
71− writeTChan incoming a
72− modifyTVar' size succ
73
61
74data BlockSpec =
62data BlockSpec =
75 NonBlocking
63 NonBlocking
76 | Blocking
64 | Blocking
77 | Timeout Int
65 | Timeout Int
78
66
79−-- Match operations
80−--
81−-- They can be either a message match or a channel match.
82data MatchOn m a
67data MatchOn m a
83 = MatchMsg (m -> Maybe a)
68 = MatchMsg (m -> Maybe a)
84 | MatchChan (STM a)
69 | MatchChan (STM a)
85− deriving (Functor)
86
70
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.
92type MatchChunks m a = [Either [m -> Maybe a] [STM a]]
71type MatchChunks m a = [Either [m -> Maybe a] [STM a]]
93
72
94−-- Splits a list of matches into chunks.
95−--
96−-- > concatMap (either (map MatchMsg) (map MatchChan)) . chunkMatches == id
97−--
98chunkMatches :: [MatchOn m a] -> MatchChunks m a
73chunkMatches :: [MatchOn m a] -> MatchChunks m a
99chunkMatches [] = []
74chunkMatches [] = []
100chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
75chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
@@ -102,7 +77,6 @@ chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
102chunkMatches (MatchChan r : ms) = Right (r : chk) : chunkMatches rest
77chunkMatches (MatchChan r : ms) = Right (r : chk) : chunkMatches rest
103 where (chk, rest) = spanMatchChan ms
78 where (chk, rest) = spanMatchChan ms
104
79
105−-- | @spanMatchMsg = first (map (\(MatchMsg x) -> x)) . span isMatchMsg@
106spanMatchMsg :: [MatchOn m a] -> ([m -> Maybe a], [MatchOn m a])
80spanMatchMsg :: [MatchOn m a] -> ([m -> Maybe a], [MatchOn m a])
107spanMatchMsg [] = ([],[])
81spanMatchMsg [] = ([],[])
108spanMatchMsg (m : ms)
82spanMatchMsg (m : ms)
@@ -110,7 +84,6 @@ spanMatchMsg (m : ms)
110 | otherwise = ([], m:ms)
84 | otherwise = ([], m:ms)
111 where !(msgs,rest) = spanMatchMsg ms
85 where !(msgs,rest) = spanMatchMsg ms
112
86
113−-- | @spanMatchMsg = first (map (\(MatchChan x) -> x)) . span isMatchChan@
114spanMatchChan :: [MatchOn m a] -> ([STM a], [MatchOn m a])
87spanMatchChan :: [MatchOn m a] -> ([STM a], [MatchOn m a])
115spanMatchChan [] = ([],[])
88spanMatchChan [] = ([],[])
116spanMatchChan (m : ms)
89spanMatchChan (m : ms)
@@ -127,7 +100,7 @@ dequeue :: forall m a.
127 -> BlockSpec -- ^ Blocking behaviour
100 -> BlockSpec -- ^ Blocking behaviour
128 -> [MatchOn m a] -- ^ List of matches
101 -> [MatchOn m a] -- ^ List of matches
129 -> IO (Maybe a) -- ^ 'Nothing' only on timeout
102 -> IO (Maybe a) -- ^ 'Nothing' only on timeout
130−dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJust $
103+dequeue (CQueue arrived incoming) blockSpec matchons =
131 case blockSpec of
104 case blockSpec of
132 Timeout n -> timeout n $ fmap fromJust run
105 Timeout n -> timeout n $ fmap fromJust run
133 _other ->
106 _other ->
@@ -139,17 +112,9 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
139 -- no onException needed
112 -- no onException needed
140 _other -> run
113 _other -> run
141 where
114 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−
150 chunks = chunkMatches matchons
115 chunks = chunkMatches matchons
151
116
152− run = do
117+ run = mask_ $ do
153 arr <- takeMVar arrived
118 arr <- takeMVar arrived
154 let grabNew xs = do
119 let grabNew xs = do
155 r <- atomically $ tryReadTChan incoming
120 r <- atomically $ tryReadTChan incoming
@@ -159,25 +124,17 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
159 arr' <- grabNew arr
124 arr' <- grabNew arr
160 goCheck chunks arr'
125 goCheck chunks arr'
161
126
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))
166 waitChans ports on_block =
127 waitChans ports on_block =
167− foldr orElse on_block (map (fmap (Just . Left)) ports)
128+ foldr orElse on_block (map (fmap Just) ports)
168
129
169 --
130 --
170 -- First check the MatchChunks against the messages already in the
131 -- First check the MatchChunks against the messages already in the
171 -- mailbox. For channel matches, we do a non-blocking check at
132 -- mailbox. For channel matches, we do a non-blocking check at
172 -- this point.
133 -- this point.
173 --
134 --
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− --
178 goCheck :: MatchChunks m a
135 goCheck :: MatchChunks m a
179 -> StrictList m -- messages to check, in this order
136 -> StrictList m -- messages to check, in this order
180− -> IO (Maybe (Either a a))
137+ -> IO (Maybe a)
181
138
182 goCheck [] old = goWait old
139 goCheck [] old = goWait old
183
140
@@ -194,7 +151,7 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
194 -- of passing around restore and setting up exception handlers is
151 -- of passing around restore and setting up exception handlers is
195 -- high. So just don't use expensive matchIfs!
152 -- high. So just don't use expensive matchIfs!
196 case checkArrived matches old of
153 case checkArrived matches old of
197− (old', Just r) -> returnOld old' (Just (Right r))
154+ (old', Just r) -> returnOld old' (Just r)
198 (old', Nothing) -> goCheck rest old'
155 (old', Nothing) -> goCheck rest old'
199 -- use the result list, which is now left-biased
156 -- use the result list, which is now left-biased
200
157
@@ -223,7 +180,6 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
223 -- Contents of 'arrived' from now on is (old ++ new), and
180 -- Contents of 'arrived' from now on is (old ++ new), and
224 -- messages that arrive are snocced onto new.
181 -- messages that arrive are snocced onto new.
225 --
182 --
226− goWait :: StrictList m -> IO (Maybe (Either a a))
227 goWait old = do
183 goWait old = do
228 r <- waitIncoming `onException` putMVar arrived old
184 r <- waitIncoming `onException` putMVar arrived old
229 case r of
185 case r of
@@ -241,7 +197,7 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
241 --
197 --
242 -- Right => message arrived on a channel first
198 -- Right => message arrived on a channel first
243 --
199 --
244− Right a -> returnOld old (Just (Left a))
200+ Right a -> returnOld old (Just a)
245
201
246 --
202 --
247 -- A message arrived in the process inbox; check the MatchChunks for
203 -- A message arrived in the process inbox; check the MatchChunks for
@@ -250,7 +206,7 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
250 goCheck1 :: MatchChunks m a
206 goCheck1 :: MatchChunks m a
251 -> m -- single message to check
207 -> m -- single message to check
252 -> StrictList m -- old messages we have already checked
208 -> StrictList m -- old messages we have already checked
253− -> IO (Maybe (Either a a))
209+ -> IO (Maybe a)
254
210
255 goCheck1 [] m old = goWait (Snoc old m)
211 goCheck1 [] m old = goWait (Snoc old m)
256
212
@@ -263,17 +219,16 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
263 goCheck1 (Left matches : rest) m old = do
219 goCheck1 (Left matches : rest) m old = do
264 case checkMatches matches m of
220 case checkMatches matches m of
265 Nothing -> goCheck1 rest m old
221 Nothing -> goCheck1 rest m old
266− Just p -> returnOld old (Just (Right p))
222+ Just p -> returnOld old (Just p)
267
223
268 -- a common pattern for putting back the arrived queue at the end
224 -- 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)
270 returnOld old r = do putMVar arrived old; return r
226 returnOld old r = do putMVar arrived old; return r
271
227
272 -- as a side-effect, this left-biases the list
228 -- as a side-effect, this left-biases the list
273 checkArrived :: [m -> Maybe a] -> StrictList m -> (StrictList m, Maybe a)
229 checkArrived :: [m -> Maybe a] -> StrictList m -> (StrictList m, Maybe a)
274 checkArrived matches list = go list Nil
230 checkArrived matches list = go list Nil
275 where
231 where
276− -- @go xs ys@ searches for a message match in @append xs ys@
277 go Nil Nil = (Nil, Nothing)
232 go Nil Nil = (Nil, Nothing)
278 go Nil r = go r Nil
233 go Nil r = go r Nil
279 go (Append xs ys) tl = go xs (append ys tl)
234 go (Append xs ys) tl = go xs (append ys tl)
@@ -289,12 +244,5 @@ dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJus
289
244
290-- | Weak reference to a CQueue
245-- | Weak reference to a CQueue
291mkWeakCQueue :: CQueue a -> IO () -> IO (Weak (CQueue a))
246mkWeakCQueue :: CQueue a -> IO () -> IO (Weak (CQueue a))
292−mkWeakCQueue m@(CQueue (StrictMVar (MVar m#)) _ _) f = IO $ \s ->
247+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
296 case mkWeak# m# m f s of (# s1, w #) -> (# s1, Weak w #)
248 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 #-}
3module Control.Distributed.Process.Internal.Closure.BuiltIn
1module Control.Distributed.Process.Internal.Closure.BuiltIn
4 ( -- * Remote table
2 ( -- * Remote table
5 remoteTable
3 remoteTable
@@ -8,8 +6,6 @@ module Control.Distributed.Process.Internal.Closure.BuiltIn
8 , sdictUnit
6 , sdictUnit
9 , sdictProcessId
7 , sdictProcessId
10 , sdictSendPort
8 , sdictSendPort
11− , sdictStatic
12− , sdictClosure
13 -- * Some static values
9 -- * Some static values
14 , sndStatic
10 , sndStatic
15 -- * The CP type and associated combinators
11 -- * The CP type and associated combinators
@@ -28,7 +24,7 @@ module Control.Distributed.Process.Internal.Closure.BuiltIn
28 , cpExpect
24 , cpExpect
29 , cpNewChan
25 , cpNewChan
30 -- * Support for some CH operations
26 -- * Support for some CH operations
31− , cpDelayed
27+ , cpDelay
32 , cpEnableTraceRemote
28 , cpEnableTraceRemote
33 ) where
29 ) where
34
30
@@ -52,7 +48,6 @@ import Control.Distributed.Static
52import Control.Distributed.Process.Serializable
48import Control.Distributed.Process.Serializable
53 ( SerializableDict(..)
49 ( SerializableDict(..)
54 , Serializable
50 , Serializable
55− , TypeableDict(..)
56 )
51 )
57import Control.Distributed.Process.Internal.Types
52import Control.Distributed.Process.Internal.Types
58 ( Process
53 ( Process
@@ -85,8 +80,6 @@ remoteTable =
85 . registerStatic "$sdictUnit" (toDynamic (SerializableDict :: SerializableDict ()))
80 . registerStatic "$sdictUnit" (toDynamic (SerializableDict :: SerializableDict ()))
86 . registerStatic "$sdictProcessId" (toDynamic (SerializableDict :: SerializableDict ProcessId))
81 . registerStatic "$sdictProcessId" (toDynamic (SerializableDict :: SerializableDict ProcessId))
87 . registerStatic "$sdictSendPort_" (toDynamic (sdictSendPort_ :: SerializableDict ANY -> SerializableDict (SendPort ANY)))
82 . 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)))
90 . registerStatic "$returnProcess" (toDynamic (return :: ANY -> Process ANY))
83 . registerStatic "$returnProcess" (toDynamic (return :: ANY -> Process ANY))
91 . registerStatic "$seqProcess" (toDynamic ((>>) :: Process ANY1 -> Process ANY2 -> Process ANY2))
84 . registerStatic "$seqProcess" (toDynamic ((>>) :: Process ANY1 -> Process ANY2 -> Process ANY2))
92 . registerStatic "$bindProcess" (toDynamic ((>>=) :: Process ANY1 -> (ANY1 -> Process ANY2) -> Process ANY2))
85 . registerStatic "$bindProcess" (toDynamic ((>>=) :: Process ANY1 -> (ANY1 -> Process ANY2) -> Process ANY2))
@@ -107,12 +100,6 @@ remoteTable =
107 sdictSendPort_ :: forall a. SerializableDict a -> SerializableDict (SendPort a)
100 sdictSendPort_ :: forall a. SerializableDict a -> SerializableDict (SendPort a)
108 sdictSendPort_ SerializableDict = SerializableDict
101 sdictSendPort_ SerializableDict = SerializableDict
109
102
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−
116 sendDict :: forall a. SerializableDict a -> ProcessId -> a -> Process ()
103 sendDict :: forall a. SerializableDict a -> ProcessId -> a -> Process ()
117 sendDict SerializableDict = send
104 sendDict SerializableDict = send
118
105
@@ -155,14 +142,6 @@ sdictSendPort :: Typeable a
155 => Static (SerializableDict a) -> Static (SerializableDict (SendPort a))
142 => Static (SerializableDict a) -> Static (SerializableDict (SendPort a))
156sdictSendPort = staticApply (staticLabel "$sdictSendPort_")
143sdictSendPort = staticApply (staticLabel "$sdictSendPort_")
157
144
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−
166--------------------------------------------------------------------------------
145--------------------------------------------------------------------------------
167-- Static values --
146-- Static values --
168--------------------------------------------------------------------------------
147--------------------------------------------------------------------------------
@@ -295,20 +274,19 @@ cpEnableTraceRemote =
295-- | @delay them p@ is a process that waits for a signal (a message of type @()@)
274-- | @delay them p@ is a process that waits for a signal (a message of type @()@)
296-- from 'them' (origin is not verified) before proceeding as @p@. In order to
275-- from 'them' (origin is not verified) before proceeding as @p@. In order to
297-- avoid waiting forever, @delay them p@ monitors 'them'. If it receives a
276-- 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.
299delay :: ProcessId -> Process () -> Process ()
278delay :: ProcessId -> Process () -> Process ()
300delay them p = do
279delay them p = do
301 ref <- monitor them
280 ref <- monitor them
302 let sameRef (ProcessMonitorNotification ref' _ _) = ref == ref'
281 let sameRef (ProcessMonitorNotification ref' _ _) = ref == ref'
303 receiveWait [
282 receiveWait [
304− match $ \() -> unmonitor ref
283+ match $ \() -> unmonitor ref >> p
305 , matchIf sameRef $ \_ -> return ()
284 , matchIf sameRef $ \_ -> return ()
306 ]
285 ]
307− p
308
286
309-- | 'CP' version of 'delay'
287-- | 'CP' version of 'delay'
310−cpDelayed :: ProcessId -> Closure (Process ()) -> Closure (Process ())
288+cpDelay :: ProcessId -> Closure (Process ()) -> Closure (Process ())
311−cpDelayed = closureApply . cpDelay'
289+cpDelay = closureApply . cpDelay'
312 where
290 where
313 cpDelay' :: ProcessId -> Closure (Process () -> Process ())
291 cpDelay' :: ProcessId -> Closure (Process () -> Process ())
314 cpDelay' pid = closure decoder (encode pid)
292 cpDelay' pid = closure decoder (encode pid)
@@ -318,3 +296,6 @@ cpDelayed = closureApply . cpDelay'
318
296
319 delayStatic :: Static (ProcessId -> Process () -> Process ())
297 delayStatic :: Static (ProcessId -> Process () -> Process ())
320 delayStatic = staticLabel "$delay"
298 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 @@
1-- | Template Haskell support
1-- | Template Haskell support
2−{-# LANGUAGE TemplateHaskell, CPP #-}
2+{-# LANGUAGE TemplateHaskell #-}
3module Control.Distributed.Process.Internal.Closure.TH
3module Control.Distributed.Process.Internal.Closure.TH
4 ( -- * User-level API
4 ( -- * User-level API
5 remotable
5 remotable
@@ -29,14 +29,7 @@ import Language.Haskell.TH
29 , Type(AppT, ForallT, VarT, ArrowT)
29 , Type(AppT, ForallT, VarT, ArrowT)
30 , Info(VarI)
30 , Info(VarI)
31 , TyVarBndr(PlainTV, KindedTV)
31 , TyVarBndr(PlainTV, KindedTV)
32− , Pred
32+ , Pred(ClassP)
33−#if MIN_VERSION_template_haskell(2,10,0)
34− , conT
35− , appT
36−#else
37− , classP
38−#endif
39− , varT
40 -- Lifted constructors
33 -- Lifted constructors
41 -- .. Literals
34 -- .. Literals
42 , stringL
35 , stringL
@@ -251,21 +244,16 @@ generateStatic :: Name -> [TyVarBndr] -> Type -> Q [Dec]
251generateStatic n xs typ = do
244generateStatic n xs typ = do
252 staticTyp <- [t| Static |]
245 staticTyp <- [t| Static |]
253 sequence
246 sequence
254− [ sigD (staticName n) $ do
247+ [ sigD (staticName n) $
255− txs <- sequence $ map typeable xs
256 return (ForallT xs
248 return (ForallT xs
257− txs
249+ (map typeable xs)
258− (staticTyp `AppT` typ))
250+ (staticTyp `AppT` typ)
251+ )
259 , sfnD (staticName n) [| staticLabel $(showFQN n) |]
252 , sfnD (staticName n) [| staticLabel $(showFQN n) |]
260 ]
253 ]
261 where
254 where
262− typeable :: TyVarBndr -> Q Pred
255+ typeable :: TyVarBndr -> 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)]
256+ typeable tv = ClassP (mkName "Typeable") [VarT (tyVarBndrName tv)]
268−#endif
269
257
270-- | Generate a serialization dictionary with name 'n' for type 'typ'
258-- | Generate a serialization dictionary with name 'n' for type 'typ'
271generateDict :: Name -> Type -> Q [Dec]
259generateDict :: Name -> Type -> Q [Dec]
@@ -303,11 +291,7 @@ getType :: Name -> Q (Name, Type)
303getType name = do
291getType name = do
304 info <- reify name
292 info <- reify name
305 case info of
293 case info of
306−#if MIN_VERSION_template_haskell(2,11,0)
307− VarI origName typ _ -> return (origName, typ)
308−#else
309 VarI origName typ _ _ -> return (origName, typ)
294 VarI origName typ _ _ -> return (origName, typ)
310−#endif
311 _ -> fail $ show name ++ " not found"
295 _ -> fail $ show name ++ " not found"
312
296
313-- | Variation on 'funD' which takes a single expression to define the function
297-- | 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)
13import qualified Data.Map as Map (partitionWithKey, elems)
13import qualified Data.Map as Map (partitionWithKey, elems)
14import qualified Data.ByteString.Lazy as BSL (toChunks)
14import qualified Data.ByteString.Lazy as BSL (toChunks)
15import qualified Data.ByteString as BSS (ByteString)
15import qualified Data.ByteString as BSS (ByteString)
16+import Control.Distributed.Process.Internal.StrictMVar (withMVar, modifyMVar_)
16import Control.Distributed.Process.Serializable ()
17import Control.Distributed.Process.Serializable ()
17
18
18−import Control.Concurrent (forkIO)
19import Control.Concurrent.Chan (writeChan)
19import Control.Concurrent.Chan (writeChan)
20−import Control.Exception (mask_)
21import Control.Monad (unless)
20import Control.Monad (unless)
22−import Control.Monad.IO.Class (liftIO)
21+import Control.Monad.IO.Class (MonadIO, liftIO)
23import Control.Monad.Reader (ask)
22import Control.Monad.Reader (ask)
24import qualified Network.Transport as NT
23import qualified Network.Transport as NT
25 ( Connection
24 ( Connection
@@ -30,10 +29,7 @@ import qualified Network.Transport as NT
30 , close
29 , close
31 )
30 )
32import Control.Distributed.Process.Internal.Types
31import Control.Distributed.Process.Internal.Types
33− ( LocalNode(localEndPoint, localCtrlChan)
32+ ( LocalNode(localState, localEndPoint, localCtrlChan)
34− , withValidLocalState
35− , modifyValidLocalState
36− , modifyValidLocalState_
37 , Identifier
33 , Identifier
38 , localConnections
34 , localConnections
39 , localConnectionBetween
35 , localConnectionBetween
@@ -54,7 +50,6 @@ import Control.Distributed.Process.Internal.Types
54 , Identifier(NodeIdentifier, ProcessIdentifier, SendPortIdentifier)
50 , Identifier(NodeIdentifier, ProcessIdentifier, SendPortIdentifier)
55 )
51 )
56import Control.Distributed.Process.Serializable (Serializable)
52import Control.Distributed.Process.Serializable (Serializable)
57−import Data.Foldable (forM_)
58
53
59--------------------------------------------------------------------------------
54--------------------------------------------------------------------------------
60-- Message sending --
55-- Message sending --
@@ -78,7 +73,7 @@ sendPayload node from to implicitReconnect payload = do
78 unless didSend $ do
73 unless didSend $ do
79 writeChan (localCtrlChan node) NCMsg
74 writeChan (localCtrlChan node) NCMsg
80 { ctrlMsgSender = to
75 { ctrlMsgSender = to
81− , ctrlMsgSignal = Died (NodeIdentifier $ nodeOf to) DiedDisconnect
76+ , ctrlMsgSignal = Died to DiedDisconnect
82 }
77 }
83
78
84sendBinary :: Binary a
79sendBinary :: Binary a
@@ -107,7 +102,7 @@ setupConnBetween :: LocalNode
107 -> ImplicitReconnect
102 -> ImplicitReconnect
108 -> IO (Maybe NT.Connection)
103 -> IO (Maybe NT.Connection)
109setupConnBetween node from to implicitReconnect = do
104setupConnBetween node from to implicitReconnect = do
110− mConn <- NT.connect (localEndPoint node)
105+ mConn <- NT.connect endPoint
111 (nodeAddress . nodeOf $ to)
106 (nodeAddress . nodeOf $ to)
112 NT.ReliableOrdered
107 NT.ReliableOrdered
113 NT.defaultConnectHints
108 NT.defaultConnectHints
@@ -118,11 +113,14 @@ setupConnBetween node from to implicitReconnect = do
118 Left _ ->
113 Left _ ->
119 return Nothing
114 return Nothing
120 Right () -> do
115 Right () -> do
121− modifyValidLocalState_ node $
116+ modifyMVar_ nodeState $ return .
122− return . (localConnectionBetween from to ^= Just (conn, implicitReconnect))
117+ (localConnectionBetween from to ^= Just (conn, implicitReconnect))
123 return $ Just conn
118 return $ Just conn
124 Left _ ->
119 Left _ ->
125 return Nothing
120 return Nothing
121+ where
122+ endPoint = localEndPoint node
123+ nodeState = localState node
126
124
127connBetween :: LocalNode
125connBetween :: LocalNode
128 -> Identifier
126 -> Identifier
@@ -130,37 +128,33 @@ connBetween :: LocalNode
130 -> ImplicitReconnect
128 -> ImplicitReconnect
131 -> IO (Maybe NT.Connection)
129 -> IO (Maybe NT.Connection)
132connBetween node from to implicitReconnect = do
130connBetween node from to implicitReconnect = do
133− mConn <- withValidLocalState node $
134− return . (^. localConnectionBetween from to)
131+ mConn <- withMVar nodeState $ return . (^. localConnectionBetween from to)
135 case mConn of
132 case mConn of
136 Just (conn, _) ->
133 Just (conn, _) ->
137 return $ Just conn
134 return $ Just conn
138 Nothing ->
135 Nothing ->
139 setupConnBetween node from to implicitReconnect
136 setupConnBetween node from to implicitReconnect
137+ where
138+ nodeState = localState node
140
139
141disconnect :: LocalNode -> Identifier -> Identifier -> IO ()
140disconnect :: LocalNode -> Identifier -> Identifier -> IO ()
142−disconnect node from to = mask_ $ do
141+disconnect node from to =
143− mio <- modifyValidLocalState node $ \vst ->
142+ modifyMVar_ (localState node) $ \st ->
144− case vst ^. localConnectionBetween from to of
143+ case st ^. localConnectionBetween from to of
145 Nothing ->
144 Nothing ->
146− return (vst, return ())
145+ return st
147 Just (conn, _) -> do
146 Just (conn, _) -> do
147+ NT.close conn
148− return ( localConnectionBetween from to ^= Nothing $ vst
148+ return (localConnectionBetween from to ^= Nothing $ st)
149− , NT.close conn
150− )
151− forM_ mio forkIO
152
149
153closeImplicitReconnections :: LocalNode -> Identifier -> IO ()
150closeImplicitReconnections :: LocalNode -> Identifier -> IO ()
154−closeImplicitReconnections node to = mask_ $ do
151+closeImplicitReconnections node to =
155− mconns <- modifyValidLocalState node $ \vst -> do
152+ modifyMVar_ (localState node) $ \st -> do
156 let shouldClose (_, to') (_, WithImplicitReconnect) = to `impliesDeathOf` to'
153 let shouldClose (_, to') (_, WithImplicitReconnect) = to `impliesDeathOf` to'
157 shouldClose _ _ = False
154 shouldClose _ _ = False
158− let (affected, unaffected) =
159− Map.partitionWithKey shouldClose (vst ^. localConnections)
155+ let (affected, unaffected) = Map.partitionWithKey shouldClose (st ^. localConnections)
160− return ( localConnections ^= unaffected $ vst
161− , map fst $ Map.elems affected
162− )
163− forM_ mconns $ forkIO . mapM_ NT.close
156+ mapM_ (NT.close . fst) (Map.elems affected)
157+ return (localConnections ^= unaffected $ st)
164
158
165-- | @a `impliesDeathOf` b@ is true if the death of @a@ (for instance, a node)
159-- | @a `impliesDeathOf` b@ is true if the death of @a@ (for instance, a node)
166-- implies the death of @b@ (for instance, a process on that node)
160-- implies the death of @b@ (for instance, a process on that node)
@@ -183,11 +177,7 @@ _ `impliesDeathOf` _ =
183 False
177 False
184
178
185
179
186−-- Send a control message. Evaluates the message to HNF before sending it.
180+-- Send a control message
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.
191sendCtrlMsg :: Maybe NodeId -- ^ Nothing for the local node
181sendCtrlMsg :: Maybe NodeId -- ^ Nothing for the local node
192 -> ProcessSignal -- ^ Message to send
182 -> ProcessSignal -- ^ Message to send
193 -> Process ()
183 -> Process ()
@@ -198,10 +188,11 @@ sendCtrlMsg mNid signal = do
198 }
188 }
199 case mNid of
189 case mNid of
200 Nothing -> do
190 Nothing -> do
201− liftIO $ writeChan (localCtrlChan (processNode proc)) $! msg
191+ liftIO $ writeChan (localCtrlChan (processNode proc)) msg
202 Just nid ->
192 Just nid ->
203 liftIO $ sendBinary (processNode proc)
193 liftIO $ sendBinary (processNode proc)
204− (NodeIdentifier (processNodeId $ processId proc))
194+ (ProcessIdentifier (processId proc))
205 (NodeIdentifier nid)
195 (NodeIdentifier nid)
206 WithImplicitReconnect
196 WithImplicitReconnect
207 msg
197 msg
198+
src/Control/Distributed/Process/Internal/Primitives.hs+107−331
@@ -1,9 +1,3 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE RankNTypes #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−{-# LANGUAGE DeriveFunctor #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE ExistentialQuantification #-}
7{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE BangPatterns #-}
8
2
9-- | Cloud Haskell primitives
3-- | Cloud Haskell primitives
@@ -13,7 +7,6 @@
13module Control.Distributed.Process.Internal.Primitives
7module Control.Distributed.Process.Internal.Primitives
14 ( -- * Basic messaging
8 ( -- * Basic messaging
15 send
9 send
16− , usend
17 , expect
10 , expect
18 -- * Channels
11 -- * Channels
19 , newChan
12 , newChan
@@ -23,10 +16,8 @@ module Control.Distributed.Process.Internal.Primitives
23 , mergePortsRR
16 , mergePortsRR
24 -- * Unsafe messaging variants
17 -- * Unsafe messaging variants
25 , unsafeSend
18 , unsafeSend
26− , unsafeUSend
27 , unsafeSendChan
19 , unsafeSendChan
28 , unsafeNSend
20 , unsafeNSend
29− , unsafeNSendRemote
30 -- * Advanced messaging
21 -- * Advanced messaging
31 , Match
22 , Match
32 , receiveWait
23 , receiveWait
@@ -37,19 +28,14 @@ module Control.Distributed.Process.Internal.Primitives
37 , matchAny
28 , matchAny
38 , matchAnyIf
29 , matchAnyIf
39 , matchChan
30 , matchChan
40− , matchSTM
41 , matchMessage
31 , matchMessage
42 , matchMessageIf
32 , matchMessageIf
43 , isEncoded
33 , isEncoded
44 , wrapMessage
34 , wrapMessage
45− , unsafeWrapMessage
46 , unwrapMessage
35 , unwrapMessage
47 , handleMessage
36 , handleMessage
48 , handleMessageIf
37 , handleMessageIf
49− , handleMessage_
50− , handleMessageIf_
51 , forward
38 , forward
52− , uforward
53 , delegate
39 , delegate
54 , relay
40 , relay
55 , proxy
41 , proxy
@@ -68,19 +54,13 @@ module Control.Distributed.Process.Internal.Primitives
68 , getSelfNode
54 , getSelfNode
69 , ProcessInfo(..)
55 , ProcessInfo(..)
70 , getProcessInfo
56 , getProcessInfo
71− , NodeStats(..)
72− , getNodeStats
73− , getLocalNodeStats
74 -- * Monitoring and linking
57 -- * Monitoring and linking
75 , link
58 , link
76 , unlink
59 , unlink
77 , monitor
60 , monitor
78 , unmonitor
61 , unmonitor
79− , unmonitorAsync
80 , withMonitor
62 , withMonitor
81− , withMonitor_
82 -- * Logging
63 -- * Logging
83− , SayMessage(..)
84 , say
64 , say
85 -- * Registry
65 -- * Registry
86 , register
66 , register
@@ -102,7 +82,6 @@ module Control.Distributed.Process.Internal.Primitives
102 , catches
82 , catches
103 , try
83 , try
104 , mask
84 , mask
105− , mask_
106 , onException
85 , onException
107 , bracket
86 , bracket
108 , bracket_
87 , bracket_
@@ -128,27 +107,17 @@ module Control.Distributed.Process.Internal.Primitives
128import Prelude hiding (catch)
107import Prelude hiding (catch)
129#endif
108#endif
130
109
131−import Data.Binary (Binary(..), Put, Get, decode)
110+import Data.Binary (decode)
132−import Data.Time.Clock (getCurrentTime, UTCTime(..))
111+import Data.Time.Clock (getCurrentTime)
133−import Data.Time.Calendar (Day(..))
134import Data.Time.Format (formatTime)
112import Data.Time.Format (formatTime)
135−#if MIN_VERSION_time(1,5,0)
136−import Data.Time.Format (defaultTimeLocale)
137−#else
138import System.Locale (defaultTimeLocale)
113import System.Locale (defaultTimeLocale)
139−#endif
140import System.Timeout (timeout)
114import System.Timeout (timeout)
141−import Control.Monad (when, void)
115+import Control.Monad (when)
142import Control.Monad.Reader (ask)
116import Control.Monad.Reader (ask)
143−import Control.Monad.IO.Class (liftIO)
117+import Control.Monad.IO.Class (MonadIO, liftIO)
144−import Control.Monad.Catch
118+import Control.Applicative ((<$>))
145− ( Exception
119+import Control.Exception (Exception(..), throw, throwIO, SomeException)
146− , SomeException
147− , throwM
148− , fromException
149− )
150−import qualified Control.Monad.Catch as Catch
120+import qualified Control.Exception as Ex (catch, mask, try)
151−import Control.Applicative
152import Control.Distributed.Process.Internal.StrictMVar
121import Control.Distributed.Process.Internal.StrictMVar
153 ( StrictMVar
122 ( StrictMVar
154 , modifyMVar
123 , modifyMVar
@@ -187,8 +156,6 @@ import Control.Distributed.Process.Internal.Types
187 , MonitorRef(..)
156 , MonitorRef(..)
188 , SpawnRef(..)
157 , SpawnRef(..)
189 , ProcessSignal(..)
158 , ProcessSignal(..)
190− , NodeMonitorNotification(..)
191− , ProcessMonitorNotification(..)
192 , monitorCounter
159 , monitorCounter
193 , spawnCounter
160 , spawnCounter
194 , SendPort(..)
161 , SendPort(..)
@@ -199,7 +166,6 @@ import Control.Distributed.Process.Internal.Types
199 , SendPortId(..)
166 , SendPortId(..)
200 , Identifier(..)
167 , Identifier(..)
201 , ProcessExitException(..)
168 , ProcessExitException(..)
202− , DiedReason(..)
203 , DidUnmonitor(..)
169 , DidUnmonitor(..)
204 , DidUnlinkProcess(..)
170 , DidUnlinkProcess(..)
205 , DidUnlinkNode(..)
171 , DidUnlinkNode(..)
@@ -209,10 +175,10 @@ import Control.Distributed.Process.Internal.Types
209 , ProcessRegistrationException(..)
175 , ProcessRegistrationException(..)
210 , ProcessInfo(..)
176 , ProcessInfo(..)
211 , ProcessInfoNone(..)
177 , ProcessInfoNone(..)
212− , NodeStats(..)
213 , isEncoded
178 , isEncoded
214 , createMessage
179 , createMessage
215 , createUnencodedMessage
180 , createUnencodedMessage
181+ , runLocalProcess
216 , ImplicitReconnect( NoImplicitReconnect)
182 , ImplicitReconnect( NoImplicitReconnect)
217 , LocalProcessState
183 , LocalProcessState
218 , LocalSendPortId
184 , LocalSendPortId
@@ -225,10 +191,10 @@ import Control.Distributed.Process.Internal.Messaging
225 , disconnect
191 , disconnect
226 , sendCtrlMsg
192 , sendCtrlMsg
227 )
193 )
228−import Control.Distributed.Process.Management.Internal.Types
194+import Control.Distributed.Process.Management.Types
229 ( MxEvent(..)
195 ( MxEvent(..)
230 )
196 )
231−import Control.Distributed.Process.Management.Internal.Trace.Types
197+import Control.Distributed.Process.Management.Trace.Types
232 ( traceEvent
198 ( traceEvent
233 )
199 )
234import Control.Distributed.Process.Internal.WeakTQueue
200import Control.Distributed.Process.Internal.WeakTQueue
@@ -236,7 +202,6 @@ import Control.Distributed.Process.Internal.WeakTQueue
236 , readTQueue
202 , readTQueue
237 , mkWeakTQueue
203 , mkWeakTQueue
238 )
204 )
239−import Prelude
240
205
241import Unsafe.Coerce
206import Unsafe.Coerce
242
207
@@ -254,15 +219,17 @@ send them msg = do
254 node = processNode proc
219 node = processNode proc
255 nodeId = localNodeId node
220 nodeId = localNodeId node
256 destNode = (processNodeId them) in do
221 destNode = (processNodeId them) in do
222+ case destNode == nodeId of
223+ True -> sendLocal them msg
224+ False -> liftIO $ sendMessage (processNode proc)
225+ (ProcessIdentifier (processId proc))
226+ (ProcessIdentifier them)
227+ NoImplicitReconnect
228+ msg
229+ -- We do not fire the trace event until after the sending is complete;
230+ -- In the remote case, 'sendMessage' can block in the networking stack.
257 liftIO $ traceEvent (localEventBus node)
231 liftIO $ traceEvent (localEventBus node)
258 (MxSent them us (createUnencodedMessage msg))
232 (MxSent them us (createUnencodedMessage msg))
259− if destNode == nodeId
260− then sendLocal them msg
261− else liftIO $ sendMessage (processNode proc)
262− (ProcessIdentifier (processId proc))
263− (ProcessIdentifier them)
264− NoImplicitReconnect
265− msg
266
233
267-- | /Unsafe/ variant of 'send'. This function makes /no/ attempt to serialize
234-- | /Unsafe/ variant of 'send'. This function makes /no/ attempt to serialize
268-- and (in the case when the destination process resides on the same local
235-- and (in the case when the destination process resides on the same local
@@ -271,34 +238,6 @@ send them msg = do
271unsafeSend :: Serializable a => ProcessId -> a -> Process ()
238unsafeSend :: Serializable a => ProcessId -> a -> Process ()
272unsafeSend = Unsafe.send
239unsafeSend = Unsafe.send
273
240
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−
302-- | Wait for a message of a specific type
241-- | Wait for a message of a specific type
303expect :: forall a. Serializable a => Process a
242expect :: forall a. Serializable a => Process a
304expect = receiveWait [match return]
243expect = receiveWait [match return]
@@ -307,13 +246,7 @@ expect = receiveWait [match return]
307-- Channels --
246-- Channels --
308--------------------------------------------------------------------------------
247--------------------------------------------------------------------------------
309
248
310−-- | Create a new typed channel, bound to the calling Process
249+-- | Create a new typed channel
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−--
317newChan :: Serializable a => Process (SendPort a, ReceivePort a)
250newChan :: Serializable a => Process (SendPort a, ReceivePort a)
318newChan = do
251newChan = do
319 proc <- ask
252 proc <- ask
@@ -341,16 +274,13 @@ newChan = do
341sendChan :: Serializable a => SendPort a -> a -> Process ()
274sendChan :: Serializable a => SendPort a -> a -> Process ()
342sendChan (SendPort cid) msg = do
275sendChan (SendPort cid) msg = do
343 proc <- ask
276 proc <- ask
344− let node = processNode proc
345− pid = processId proc
346− us = localNodeId node
277+ let node = localNodeId (processNode proc)
347− them = processNodeId (sendPortProcessId cid) in do
278+ destNode = processNodeId (sendPortProcessId cid) in do
348− liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid $ wrapMessage msg)
349− case them == us of
279+ case destNode == node of
350 True -> sendChanLocal cid msg
280 True -> sendChanLocal cid msg
351 False -> do
281 False -> do
352− liftIO $ sendBinary node
282+ liftIO $ sendBinary (processNode proc)
353− (ProcessIdentifier pid)
283+ (ProcessIdentifier (processId proc))
354 (SendPortIdentifier cid)
284 (SendPortIdentifier cid)
355 NoImplicitReconnect
285 NoImplicitReconnect
356 msg
286 msg
@@ -405,17 +335,13 @@ mergePortsRR = \ps -> do
405
335
406-- | Opaque type used in 'receiveWait' and 'receiveTimeout'
336-- | Opaque type used in 'receiveWait' and 'receiveTimeout'
407newtype Match b = Match { unMatch :: MatchOn Message (Process b) }
337newtype Match b = Match { unMatch :: MatchOn Message (Process b) }
408− deriving (Functor)
409
338
410-- | Test the matches in order against each message in the queue
339-- | Test the matches in order against each message in the queue
411receiveWait :: [Match b] -> Process b
340receiveWait :: [Match b] -> Process b
412receiveWait ms = do
341receiveWait ms = do
413 queue <- processQueue <$> ask
342 queue <- processQueue <$> ask
414− mProc <- liftIO $ dequeue queue Blocking (map unMatch ms)
343+ Just proc <- liftIO $ dequeue queue Blocking (map unMatch ms)
415− case mProc of
416− Just proc' -> proc'
344+ proc
417− Nothing -> die $ "System Invariant Violation: CQueue.hs returned `Nothing` "
418− ++ "in the absence of a timeout value."
419
345
420-- | Like 'receiveWait' but with a timeout.
346-- | Like 'receiveWait' but with a timeout.
421--
347--
@@ -431,26 +357,9 @@ receiveTimeout t ms = do
431 Nothing -> return Nothing
357 Nothing -> return Nothing
432 Just proc -> Just <$> proc
358 Just proc -> Just <$> proc
433
359
434−-- | Match on a typed channel
435matchChan :: ReceivePort a -> (a -> Process b) -> Match b
360matchChan :: ReceivePort a -> (a -> Process b) -> Match b
436matchChan p fn = Match $ MatchChan (fmap fn (receiveSTM p))
361matchChan p fn = Match $ MatchChan (fmap fn (receiveSTM p))
437
362
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−
454-- | Match against any message of the right type
363-- | Match against any message of the right type
455match :: forall a b. Serializable a => (a -> Process b) -> Match b
364match :: forall a b. Serializable a => (a -> Process b) -> Match b
456match = matchIf (const True)
365match = matchIf (const True)
@@ -494,35 +403,22 @@ forward msg them = do
494 us = processId proc
403 us = processId proc
495 nid = localNodeId node
404 nid = localNodeId node
496 destNode = (processNodeId them) in do
405 destNode = (processNodeId them) in do
497− liftIO $ traceEvent (localEventBus node) (MxSent them us msg)
498− if destNode == nid
406+ case destNode == nid of
499− then sendCtrlMsg Nothing (LocalSend them msg)
407+ True -> sendCtrlMsg Nothing (LocalSend them msg)
500− else liftIO $ sendPayload (processNode proc)
408+ False -> liftIO $ sendPayload (processNode proc)
501− (ProcessIdentifier (processId proc))
409+ (ProcessIdentifier (processId proc))
502− (ProcessIdentifier them)
410+ (ProcessIdentifier them)
503− NoImplicitReconnect
411+ NoImplicitReconnect
504− (messageToPayload msg)
412+ (messageToPayload msg)
413+ -- We do not fire the trace event until after the sending is complete;
414+ -- In the remote case, 'sendMessage' can block in the networking stack.
415+ liftIO $ traceEvent (localEventBus node)
416+ (MxSent them us msg)
505
417
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
522
418
523-- | Wrap a 'Serializable' value in a 'Message'. Note that 'Message's are
419-- | Wrap a 'Serializable' value in a 'Message'. Note that 'Message's are
524-- 'Serializable' - like the datum they contain - but also note, deserialising
420-- 'Serializable' - like the datum they contain - but also note, deserialising
525−-- such a 'Message' will yield a 'Message', not the type within it! To obtain the
421+-- a 'Message' will yield a 'Message', not the type within it! To obtain the
526-- wrapped datum, use 'unwrapMessage' or 'handleMessage' with a specific type.
422-- wrapped datum, use 'unwrapMessage' or 'handleMessage' with a specific type.
527--
423--
528-- @
424-- @
@@ -537,11 +433,6 @@ uforward msg them = do
537wrapMessage :: Serializable a => a -> Message
433wrapMessage :: Serializable a => a -> Message
538wrapMessage = createUnencodedMessage -- see [note Serializable UnencodedMessage]
434wrapMessage = createUnencodedMessage -- see [note Serializable UnencodedMessage]
539
435
540−-- | This is the /unsafe/ variant of 'wrapMessage'. See
541−-- "Control.Distributed.Process.UnsafePrimitives" for details.
542−unsafeWrapMessage :: Serializable a => a -> Message
543−unsafeWrapMessage = Unsafe.wrapMessage
544−
545-- [note Serializable UnencodedMessage]
436-- [note Serializable UnencodedMessage]
546-- if we attempt to serialise an UnencodedMessage, it will be converted to an
437-- if we attempt to serialise an UnencodedMessage, it will be converted to an
547-- EncodedMessage first, so we're ok here. See 'messageToPayload' in
438-- EncodedMessage first, so we're ok here. See 'messageToPayload' in
@@ -585,11 +476,6 @@ handleMessage :: forall m a b. (Monad m, Serializable a)
585 => Message -> (a -> m b) -> m (Maybe b)
476 => Message -> (a -> m b) -> m (Maybe b)
586handleMessage msg proc = handleMessageIf msg (const True) proc
477handleMessage msg proc = handleMessageIf msg (const True) proc
587
478
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−--
593handleMessageIf :: forall m a b . (Monad m, Serializable a)
479handleMessageIf :: forall m a b . (Monad m, Serializable a)
594 => Message
480 => Message
595 -> (a -> Bool)
481 -> (a -> Bool)
@@ -612,22 +498,6 @@ handleMessageIf msg c proc = do
612 decoded :: a -- note [decoding]
498 decoded :: a -- note [decoding]
613 !decoded = decode (messageEncoding msg)
499 !decoded = decode (messageEncoding msg)
614
500
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−
631-- | Match against an arbitrary message. 'matchAny' removes the first available
501-- | Match against an arbitrary message. 'matchAny' removes the first available
632-- message from the process mailbox. To handle arbitrary /raw/ messages once
502-- message from the process mailbox. To handle arbitrary /raw/ messages once
633-- removed from the mailbox, see 'handleMessage' and 'unwrapMessage'.
503-- removed from the mailbox, see 'handleMessage' and 'unwrapMessage'.
@@ -715,7 +585,7 @@ instance Exception ProcessTerminationException
715
585
716-- | Terminate immediately (throws a ProcessTerminationException)
586-- | Terminate immediately (throws a ProcessTerminationException)
717terminate :: Process a
587terminate :: Process a
718−terminate = throwM ProcessTerminationException
588+terminate = liftIO $ throwIO ProcessTerminationException
719
589
720-- [Issue #110]
590-- [Issue #110]
721-- | Die immediately - throws a 'ProcessExitException' with the given @reason@.
591-- | Die immediately - throws a 'ProcessExitException' with the given @reason@.
@@ -725,7 +595,7 @@ die reason = do
725-- could be decoded by a handler passed to 'catchExit', re-thrown or even
595-- could be decoded by a handler passed to 'catchExit', re-thrown or even
726-- passed to another process via the tracing mechanism.
596-- passed to another process via the tracing mechanism.
727 pid <- getSelfPid
597 pid <- getSelfPid
728− throwM (ProcessExitException pid (createMessage reason))
598+ liftIO $ throwIO (ProcessExitException pid (createMessage reason))
729
599
730-- | Forceful request to kill a process. Where 'exit' provides an exception
600-- | Forceful request to kill a process. Where 'exit' provides an exception
731-- that can be caught and handled, 'kill' throws an unexposed exception type
601-- that can be caught and handled, 'kill' throws an unexposed exception type
@@ -758,12 +628,12 @@ catchExit :: forall a b . (Show a, Serializable a)
758 => Process b
628 => Process b
759 -> (ProcessId -> a -> Process b)
629 -> (ProcessId -> a -> Process b)
760 -> Process b
630 -> Process b
761−catchExit act exitHandler = Catch.catch act handleExit
631+catchExit act exitHandler = catch act handleExit
762 where
632 where
763 handleExit ex@(ProcessExitException from msg) =
633 handleExit ex@(ProcessExitException from msg) =
764 if messageFingerprint msg == fingerprint (undefined :: a)
634 if messageFingerprint msg == fingerprint (undefined :: a)
765 then exitHandler from decoded
635 then exitHandler from decoded
766− else throwM ex
636+ else liftIO $ throwIO ex
767 where
637 where
768 decoded :: a
638 decoded :: a
769 -- Make sure the value is fully decoded so that we don't hang to
639 -- Make sure the value is fully decoded so that we don't hang to
@@ -782,12 +652,12 @@ catchExit act exitHandler = Catch.catch act handleExit
782catchesExit :: Process b
652catchesExit :: Process b
783 -> [(ProcessId -> Message -> (Process (Maybe b)))]
653 -> [(ProcessId -> Message -> (Process (Maybe b)))]
784 -> Process b
654 -> Process b
785−catchesExit act handlers = Catch.catch act ((flip handleExit) handlers)
655+catchesExit act handlers = catch act ((flip handleExit) handlers)
786 where
656 where
787 handleExit :: ProcessExitException
657 handleExit :: ProcessExitException
788 -> [(ProcessId -> Message -> Process (Maybe b))]
658 -> [(ProcessId -> Message -> Process (Maybe b))]
789 -> Process b
659 -> Process b
790− handleExit ex [] = throwM ex
660+ handleExit ex [] = liftIO $ throwIO ex
791 handleExit ex@(ProcessExitException from msg) (h:hs) = do
661 handleExit ex@(ProcessExitException from msg) (h:hs) = do
792 r <- h from msg
662 r <- h from msg
793 case r of
663 case r of
@@ -802,31 +672,6 @@ getSelfPid = processId <$> ask
802getSelfNode :: Process NodeId
672getSelfNode :: Process NodeId
803getSelfNode = localNodeId . processNode <$> ask
673getSelfNode = localNodeId . processNode <$> ask
804
674
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−
830-- | Get information about the specified process
675-- | Get information about the specified process
831getProcessInfo :: ProcessId -> Process (Maybe ProcessInfo)
676getProcessInfo :: ProcessId -> Process (Maybe ProcessInfo)
832getProcessInfo pid =
677getProcessInfo pid =
@@ -896,19 +741,12 @@ monitor = monitor' . ProcessIdentifier
896-- @withMonitor@ returns, there might still be unreceived monitor
741-- @withMonitor@ returns, there might still be unreceived monitor
897-- messages in the queue.
742-- messages in the queue.
898--
743--
899−withMonitor :: ProcessId -> (MonitorRef -> Process a) -> Process a
744+withMonitor :: ProcessId -> Process a -> Process a
900−withMonitor pid = bracket (monitor pid) unmonitor
745+withMonitor pid code = bracket (monitor pid) unmonitor (\_ -> code)
901−
746+ -- unmonitor blocks waiting for the response, so there's a possibility
902−-- | Establishes temporary monitoring of another process.
747+ -- that an exception might interrupt withMonitor before the unmonitor
903−--
748+ -- has completed. I think that's better than making the unmonitor
904−-- @withMonitor_ pid code@ sets up monitoring of @pid@ for the duration
749+ -- uninterruptible.
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
912
750
913-- | Remove a link
751-- | Remove a link
914--
752--
@@ -946,21 +784,12 @@ unlinkPort sport = do
946-- | Remove a monitor
784-- | Remove a monitor
947--
785--
948-- This has the same synchronous/asynchronous nature as 'unlink'.
786-- This has the same synchronous/asynchronous nature as 'unlink'.
949−--
950−-- ProcessMonitorNotification messages for the given MonitorRef are removed from
951−-- the mailbox.
952unmonitor :: MonitorRef -> Process ()
787unmonitor :: MonitorRef -> Process ()
953unmonitor ref = do
788unmonitor ref = do
954 unmonitorAsync ref
789 unmonitorAsync ref
955 receiveWait [ matchIf (\(DidUnmonitor ref') -> ref' == ref)
790 receiveWait [ matchIf (\(DidUnmonitor ref') -> ref' == ref)
956 (\_ -> return ())
791 (\_ -> return ())
957 ]
792 ]
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− ]
964
793
965--------------------------------------------------------------------------------
794--------------------------------------------------------------------------------
966-- Exception handling --
795-- Exception handling --
@@ -968,43 +797,50 @@ unmonitor ref = do
968
797
969-- | Lift 'Control.Exception.catch'
798-- | Lift 'Control.Exception.catch'
970catch :: Exception e => Process a -> (e -> Process a) -> Process a
799catch :: Exception e => Process a -> (e -> Process a) -> Process a
971−catch = Catch.catch
800+catch p h = do
972−{-# DEPRECATED catch "Use Control.Monad.Catch.catch instead" #-}
801+ lproc <- ask
802+ liftIO $ Ex.catch (runLocalProcess lproc p) (runLocalProcess lproc . h)
973
803
974-- | Lift 'Control.Exception.try'
804-- | Lift 'Control.Exception.try'
975try :: Exception e => Process a -> Process (Either e a)
805try :: Exception e => Process a -> Process (Either e a)
976−try = Catch.try
806+try p = do
977−{-# DEPRECATED try "Use Control.Monad.Catch.try instead" #-}
807+ lproc <- ask
808+ liftIO $ Ex.try (runLocalProcess lproc p)
978
809
979-- | Lift 'Control.Exception.mask'
810-- | Lift 'Control.Exception.mask'
980mask :: ((forall a. Process a -> Process a) -> Process b) -> Process b
811mask :: ((forall a. Process a -> Process a) -> Process b) -> Process b
981−mask = Catch.mask
812+mask p = do
982−{-# DEPRECATED mask "Use Control.Monad.Catch.mask_ instead" #-}
813+ lproc <- ask
983−
814+ liftIO $ Ex.mask $ \restore ->
984−-- | Lift 'Control.Exception.mask_'
815+ runLocalProcess lproc (p (liftRestore restore))
816+ where
817+ liftRestore :: (forall a. IO a -> IO a)
985−mask_ :: Process a -> Process a
818+ -> (forall a. Process a -> Process a)
986−mask_ = Catch.mask_
819+ liftRestore restoreIO = \p2 -> do
987−{-# DEPRECATED mask_ "Use Control.Monad.Catch.mask_ instead" #-}
820+ ourLocalProc <- ask
821+ liftIO $ restoreIO $ runLocalProcess ourLocalProc p2
988
822
989-- | Lift 'Control.Exception.onException'
823-- | Lift 'Control.Exception.onException'
990onException :: Process a -> Process b -> Process a
824onException :: Process a -> Process b -> Process a
991−onException = Catch.onException
825+onException p what = p `catch` \e -> do _ <- what
992−{-# DEPRECATED onException "Use Control.Monad.Catch.onException instead" #-}
826+ liftIO $ throwIO (e :: SomeException)
993
827
994-- | Lift 'Control.Exception.bracket'
828-- | Lift 'Control.Exception.bracket'
995bracket :: Process a -> (a -> Process b) -> (a -> Process c) -> Process c
829bracket :: Process a -> (a -> Process b) -> (a -> Process c) -> Process c
996−bracket = Catch.bracket
830+bracket before after thing =
997−{-# DEPRECATED bracket "Use Control.Monad.Catch.bracket instead" #-}
831+ mask $ \restore -> do
832+ a <- before
833+ r <- restore (thing a) `onException` after a
834+ _ <- after a
835+ return r
998
836
999-- | Lift 'Control.Exception.bracket_'
837-- | Lift 'Control.Exception.bracket_'
1000bracket_ :: Process a -> Process b -> Process c -> Process c
838bracket_ :: Process a -> Process b -> Process c -> Process c
1001−bracket_ = Catch.bracket_
839+bracket_ before after thing = bracket before (const after) (const thing)
1002−{-# DEPRECATED bracket_ "Use Control.Monad.Catch.bracket_ instead" #-}
1003
840
1004-- | Lift 'Control.Exception.finally'
841-- | Lift 'Control.Exception.finally'
1005finally :: Process a -> Process b -> Process a
842finally :: Process a -> Process b -> Process a
1006−finally = Catch.finally
843+finally a sequel = bracket_ (return ()) sequel a
1007−{-# DEPRECATED finally "Use Control.Monad.Catch.finally instead" #-}
1008
844
1009-- | You need this when using 'catches'
845-- | You need this when using 'catches'
1010data Handler a = forall e . Exception e => Handler (e -> Process a)
846data Handler a = forall e . Exception e => Handler (e -> Process a)
@@ -1014,10 +850,10 @@ instance Functor Handler where
1014
850
1015-- | Lift 'Control.Exception.catches'
851-- | Lift 'Control.Exception.catches'
1016catches :: Process a -> [Handler a] -> Process a
852catches :: Process a -> [Handler a] -> Process a
1017−catches proc handlers = proc `Catch.catch` catchesHandler handlers
853+catches proc handlers = proc `catch` catchesHandler handlers
1018
854
1019catchesHandler :: [Handler a] -> SomeException -> Process a
855catchesHandler :: [Handler a] -> SomeException -> Process a
1020−catchesHandler handlers e = foldr tryHandler (throwM e) handlers
856+catchesHandler handlers e = foldr tryHandler (throw e) handlers
1021 where tryHandler (Handler handler) res
857 where tryHandler (Handler handler) res
1022 = case fromException e of
858 = case fromException e of
1023 Just e' -> handler e'
859 Just e' -> handler e'
@@ -1037,10 +873,7 @@ expectTimeout n = receiveTimeout n [match return]
1037spawnAsync :: NodeId -> Closure (Process ()) -> Process SpawnRef
873spawnAsync :: NodeId -> Closure (Process ()) -> Process SpawnRef
1038spawnAsync nid proc = do
874spawnAsync nid proc = do
1039 spawnRef <- getSpawnRef
875 spawnRef <- getSpawnRef
1040− node <- getSelfNode
1041− if nid == node
1042− then sendCtrlMsg Nothing $ Spawn proc spawnRef
1043− else sendCtrlMsg (Just nid) $ Spawn proc spawnRef
876+ sendCtrlMsg (Just nid) $ Spawn proc spawnRef
1044 return spawnRef
877 return spawnRef
1045
878
1046-- | Monitor a node (asynchronous)
879-- | Monitor a node (asynchronous)
@@ -1086,60 +919,27 @@ unlinkPortAsync (SendPort cid) =
1086-- Logging --
919-- Logging --
1087--------------------------------------------------------------------------------
920--------------------------------------------------------------------------------
1088
921
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−
1124-- | Log a string
922-- | Log a string
1125--
923--
1126−-- @say message@ sends a message of type 'SayMessage' with the current time and
924+-- @say message@ sends a message (time, pid of the current process, message)
1127−-- 'ProcessId' of the current process to the process registered as @logger@. By
925+-- to the process registered as 'logger'. By default, this process simply
1128−-- default, this process simply sends the string to @stderr@. Individual Cloud
926+-- sends the string to 'stderr'. Individual Cloud Haskell backends might
1129−-- Haskell backends might replace this with a different logger process, however.
927+-- replace this with a different logger process, however.
1130say :: String -> Process ()
928say :: String -> Process ()
1131say string = do
929say string = do
1132 now <- liftIO getCurrentTime
930 now <- liftIO getCurrentTime
1133 us <- getSelfPid
931 us <- getSelfPid
1134− nsend "logger" (SayMessage now us string)
932+ nsend "logger" (formatTime defaultTimeLocale "%c" now, us, string)
1135
933
1136--------------------------------------------------------------------------------
934--------------------------------------------------------------------------------
1137-- Registry --
935-- Registry --
1138--------------------------------------------------------------------------------
936--------------------------------------------------------------------------------
1139
937
1140−-- | Register a process with the local registry (synchronous). The name must not
938+-- | Register a process with the local registry (asynchronous).
939+-- This version will wait until a response is gotten from the
940+-- management process. The name must not already be registered.
1141−-- already be registered. The process need not be on this node. A bad
941+-- The process need not be on this node.
1142−-- registration will result in a 'ProcessRegistrationException'
942+-- A bad registration will result in a 'ProcessRegistrationException'
1143--
943--
1144-- The process to be registered does not have to be local itself.
944-- The process to be registered does not have to be local itself.
1145register :: String -> ProcessId -> Process ()
945register :: String -> ProcessId -> Process ()
@@ -1154,10 +954,9 @@ registerImpl :: Bool -> String -> ProcessId -> Process ()
1154registerImpl force label pid = do
954registerImpl force label pid = do
1155 mynid <- getSelfNode
955 mynid <- getSelfNode
1156 sendCtrlMsg Nothing (Register label mynid (Just pid) force)
956 sendCtrlMsg Nothing (Register label mynid (Just pid) force)
1157− receiveWait
1158− [ matchIf (\(RegisterReply label' _ _) -> label == label')
957+ receiveWait [ matchIf (\(RegisterReply label' _) -> label == label')
1159− (\(RegisterReply _ ok owner) -> handleRegistrationReply label ok owner)
958+ (\(RegisterReply _ ok) -> handleRegistrationReply label ok)
1160− ]
959+ ]
1161
960
1162-- | Register a process with a remote registry (asynchronous).
961-- | Register a process with a remote registry (asynchronous).
1163--
962--
@@ -1166,10 +965,8 @@ registerImpl force label pid = do
1166--
965--
1167-- See comments in 'whereisRemoteAsync'
966-- See comments in 'whereisRemoteAsync'
1168registerRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
967registerRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
1169−registerRemoteAsync nid label pid = do
968+registerRemoteAsync nid label pid =
1170− here <- getSelfNode
1171− sendCtrlMsg (if nid == here then Nothing else Just nid)
1172− (Register label nid (Just pid) False)
969+ sendCtrlMsg (Just nid) (Register label nid (Just pid) False)
1173
970
1174reregisterRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
971reregisterRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
1175reregisterRemoteAsync nid label pid =
972reregisterRemoteAsync nid label pid =
@@ -1182,17 +979,16 @@ unregister :: String -> Process ()
1182unregister label = do
979unregister label = do
1183 mynid <- getSelfNode
980 mynid <- getSelfNode
1184 sendCtrlMsg Nothing (Register label mynid Nothing False)
981 sendCtrlMsg Nothing (Register label mynid Nothing False)
1185− receiveWait
1186− [ matchIf (\(RegisterReply label' _ _) -> label == label')
982+ receiveWait [ matchIf (\(RegisterReply label' _) -> label == label')
1187− (\(RegisterReply _ ok owner) -> handleRegistrationReply label ok owner)
983+ (\(RegisterReply _ ok) -> handleRegistrationReply label ok)
1188− ]
984+ ]
1189
985
1190-- | Deal with the result from an attempted registration or unregistration
986-- | Deal with the result from an attempted registration or unregistration
1191-- by throwing an exception if necessary
987-- by throwing an exception if necessary
1192−handleRegistrationReply :: String -> Bool -> Maybe ProcessId -> Process ()
988+handleRegistrationReply :: String -> Bool -> Process ()
1193−handleRegistrationReply label ok owner =
989+handleRegistrationReply label ok =
1194 when (not ok) $
990 when (not ok) $
1195− throwM $ ProcessRegistrationException label owner
991+ liftIO $ throwIO $ ProcessRegistrationException label
1196
992
1197-- | Remove a process from a remote registry (asynchronous).
993-- | Remove a process from a remote registry (asynchronous).
1198--
994--
@@ -1221,18 +1017,13 @@ whereis label = do
1221-- use 'monitorNode' and take appropriate action when you receive a
1017-- use 'monitorNode' and take appropriate action when you receive a
1222-- 'NodeMonitorNotification').
1018-- 'NodeMonitorNotification').
1223whereisRemoteAsync :: NodeId -> String -> Process ()
1019whereisRemoteAsync :: NodeId -> String -> Process ()
1224−whereisRemoteAsync nid label = do
1020+whereisRemoteAsync nid label =
1225− here <- getSelfNode
1226− sendCtrlMsg (if nid == here then Nothing else Just nid) (WhereIs label)
1021+ sendCtrlMsg (Just nid) (WhereIs label)
1227
1022
1228-- | Named send to a process in the local registry (asynchronous)
1023-- | Named send to a process in the local registry (asynchronous)
1229nsend :: Serializable a => String -> a -> Process ()
1024nsend :: Serializable a => String -> a -> Process ()
1230−nsend label msg = do
1025+nsend label msg =
1231− proc <- ask
1232− let msg' = createUnencodedMessage msg
1233− liftIO $ traceEvent (localEventBus (processNode proc))
1234− (MxSentToName label (processId proc) msg')
1235− sendCtrlMsg Nothing (NamedSend label msg')
1026+ sendCtrlMsg Nothing (NamedSend label (createUnencodedMessage msg))
1236
1027
1237-- | Named send to a process in the local registry (asynchronous).
1028-- | Named send to a process in the local registry (asynchronous).
1238-- This function makes /no/ attempt to serialize and (in the case when the
1029-- This function makes /no/ attempt to serialize and (in the case when the
@@ -1243,23 +1034,8 @@ unsafeNSend = Unsafe.nsend
1243
1034
1244-- | Named send to a process in a remote registry (asynchronous)
1035-- | Named send to a process in a remote registry (asynchronous)
1245nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
1036nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
1246−nsendRemote nid label msg = do
1037+nsendRemote nid label msg =
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))
1038+ 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
1263
1039
1264--------------------------------------------------------------------------------
1040--------------------------------------------------------------------------------
1265-- Closures --
1041-- Closures --
src/Control/Distributed/Process/Internal/Spawn.hs+10−14
@@ -1,4 +1,3 @@
1−{-# LANGUAGE RankNTypes #-}
2module Control.Distributed.Process.Internal.Spawn
1module Control.Distributed.Process.Internal.Spawn
3 ( spawn
2 ( spawn
4 , spawnLink
3 , spawnLink
@@ -37,13 +36,11 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
37 , cpLink
36 , cpLink
38 , cpSend
37 , cpSend
39 , cpNewChan
38 , cpNewChan
40− , cpDelayed
39+ , cpDelay
41− , returnCP
42− , sdictUnit
43 )
40 )
44import Control.Distributed.Process.Internal.Primitives
41import Control.Distributed.Process.Internal.Primitives
45 ( -- Basic messaging
42 ( -- Basic messaging
46− usend
43+ send
47 , expect
44 , expect
48 , receiveWait
45 , receiveWait
49 , match
46 , match
@@ -67,11 +64,11 @@ spawn :: NodeId -> Closure (Process ()) -> Process ProcessId
67spawn nid proc = do
64spawn nid proc = do
68 us <- getSelfPid
65 us <- getSelfPid
69 mRef <- monitorNode nid
66 mRef <- monitorNode nid
70− sRef <- spawnAsync nid (cpDelayed us proc)
67+ sRef <- spawnAsync nid (cpDelay us proc)
71 receiveWait [
68 receiveWait [
72 matchIf (\(DidSpawn ref _) -> ref == sRef) $ \(DidSpawn _ pid) -> do
69 matchIf (\(DidSpawn ref _) -> ref == sRef) $ \(DidSpawn _ pid) -> do
73 unmonitor mRef
70 unmonitor mRef
74− usend pid ()
71+ send pid ()
75 return pid
72 return pid
76 , matchIf (\(NodeMonitorNotification ref _ _) -> ref == mRef) $ \_ ->
73 , matchIf (\(NodeMonitorNotification ref _ _) -> ref == mRef) $ \_ ->
77 return (nullProcessId nid)
74 return (nullProcessId nid)
@@ -111,14 +108,12 @@ call :: Serializable a
111 -> Process a
108 -> Process a
112call dict nid proc = do
109call dict nid proc = do
113 us <- getSelfPid
110 us <- getSelfPid
114− (pid, mRef) <- spawnMonitor nid (proc `bindCP`
111+ (pid, mRef) <- spawnMonitor nid (proc `bindCP` cpSend dict us)
115− cpSend dict us `seqCP`
112+ -- We are guaranteed to receive the reply before the monitor notification
116− -- Delay so the process does not terminate
113+ -- (if a reply is sent at all)
117− -- before the response arrives.
114+ -- NOTE: This might not be true if we switch to unreliable delivery.
118− cpDelayed us (returnCP sdictUnit ())
119− )
120 mResult <- receiveWait
115 mResult <- receiveWait
121− [ match $ \a -> usend pid () >> return (Right a)
116+ [ match (return . Right)
122 , matchIf (\(ProcessMonitorNotification ref _ _) -> ref == mRef)
117 , matchIf (\(ProcessMonitorNotification ref _ _) -> ref == mRef)
123 (\(ProcessMonitorNotification _ _ reason) -> return (Left reason))
118 (\(ProcessMonitorNotification _ _ reason) -> return (Left reason))
124 ]
119 ]
@@ -163,3 +158,4 @@ spawnChannel dict nid proc = do
163 (cpSend (sdictSendPort dict) pid `splitCP` proc)
158 (cpSend (sdictSendPort dict) pid `splitCP` proc)
164 `bindCP`
159 `bindCP`
165 (idCP `closureCompose` staticClosure sndStatic)
160 (idCP `closureCompose` staticClosure sndStatic)
161+
src/Control/Distributed/Process/Internal/StrictMVar.hs+5−37
@@ -1,43 +1,33 @@
1-- | Like Control.Concurrent.MVar.Strict but reduce to HNF, not NF
1-- | Like Control.Concurrent.MVar.Strict but reduce to HNF, not NF
2−{-# LANGUAGE CPP, MagicHash, UnboxedTuples #-}
2+{-# LANGUAGE MagicHash, UnboxedTuples #-}
3module Control.Distributed.Process.Internal.StrictMVar
3module Control.Distributed.Process.Internal.StrictMVar
4 ( StrictMVar(StrictMVar)
4 ( StrictMVar(StrictMVar)
5 , newEmptyMVar
5 , newEmptyMVar
6 , newMVar
6 , newMVar
7 , takeMVar
7 , takeMVar
8 , putMVar
8 , putMVar
9− , readMVar
10 , withMVar
9 , withMVar
11 , modifyMVar_
10 , modifyMVar_
12 , modifyMVar
11 , modifyMVar
13− , modifyMVarMasked
14 , mkWeakMVar
12 , mkWeakMVar
15 ) where
13 ) where
16
14
17import Control.Applicative ((<$>))
15import Control.Applicative ((<$>))
18import Control.Monad ((>=>))
16import Control.Monad ((>=>))
19−#if MIN_VERSION_base(4,6,0)
20import Control.Exception (evaluate)
17import Control.Exception (evaluate)
21−#else
22−import Control.Exception (evaluate, mask_, onException)
23−#endif
24import qualified Control.Concurrent.MVar as MVar
18import qualified Control.Concurrent.MVar as MVar
25 ( MVar
19 ( MVar
26 , newEmptyMVar
20 , newEmptyMVar
27 , newMVar
21 , newMVar
28 , takeMVar
22 , takeMVar
29 , putMVar
23 , putMVar
30− , readMVar
31 , withMVar
24 , withMVar
32 , modifyMVar_
25 , modifyMVar_
33 , modifyMVar
26 , modifyMVar
34−#if MIN_VERSION_base(4,6,0)
35− , modifyMVarMasked
36−#endif
37 )
27 )
38import GHC.MVar (MVar(MVar))
28import GHC.MVar (MVar(MVar))
39−import GHC.IO (IO(IO), unIO)
29+import GHC.IO (IO(IO))
40−import GHC.Exts (mkWeak#)
30+import GHC.Prim (mkWeak#)
41import GHC.Weak (Weak(Weak))
31import GHC.Weak (Weak(Weak))
42
32
43newtype StrictMVar a = StrictMVar (MVar.MVar a)
33newtype StrictMVar a = StrictMVar (MVar.MVar a)
@@ -54,9 +44,6 @@ takeMVar (StrictMVar v) = MVar.takeMVar v
54putMVar :: StrictMVar a -> a -> IO ()
44putMVar :: StrictMVar a -> a -> IO ()
55putMVar (StrictMVar v) x = evaluate x >> MVar.putMVar v x
45putMVar (StrictMVar v) x = evaluate x >> MVar.putMVar v x
56
46
57−readMVar :: StrictMVar a -> IO a
58−readMVar (StrictMVar v) = MVar.readMVar v
59−
60withMVar :: StrictMVar a -> (a -> IO b) -> IO b
47withMVar :: StrictMVar a -> (a -> IO b) -> IO b
61withMVar (StrictMVar v) = MVar.withMVar v
48withMVar (StrictMVar v) = MVar.withMVar v
62
49
@@ -69,25 +56,6 @@ modifyMVar (StrictMVar v) f = MVar.modifyMVar v (f >=> evaluateFst)
69 evaluateFst :: (a, b) -> IO (a, b)
56 evaluateFst :: (a, b) -> IO (a, b)
70 evaluateFst (x, y) = evaluate x >> return (x, y)
57 evaluateFst (x, y) = evaluate x >> return (x, y)
71
58
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−
87mkWeakMVar :: StrictMVar a -> IO () -> IO (Weak (StrictMVar a))
59mkWeakMVar :: StrictMVar a -> IO () -> IO (Weak (StrictMVar a))
88−mkWeakMVar q@(StrictMVar (MVar m#)) f = IO $ \s ->
60+mkWeakMVar m@(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 #)
61+ case mkWeak# m# m f s of (# s1, w #) -> (# s1, Weak w #)
93−#endif
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 #-}
5{-# LANGUAGE DeriveGeneric #-}
1{-# LANGUAGE DeriveGeneric #-}
6−{-# LANGUAGE CPP #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE TypeFamilies #-}
9−{-# LANGUAGE Rank2Types #-}
10
2
11-- | Types used throughout the Cloud Haskell framework
3-- | Types used throughout the Cloud Haskell framework
12--
4--
@@ -24,14 +16,9 @@ module Control.Distributed.Process.Internal.Types
24 , nullProcessId
16 , nullProcessId
25 -- * Local nodes and processes
17 -- * Local nodes and processes
26 , LocalNode(..)
18 , LocalNode(..)
27− , LocalNodeState(..)
28− , ValidLocalNodeState(..)
29− , NodeClosedException(..)
30− , withValidLocalState
31− , modifyValidLocalState
32− , modifyValidLocalState_
33 , Tracer(..)
19 , Tracer(..)
34 , MxEventBus(..)
20 , MxEventBus(..)
21+ , LocalNodeState(..)
35 , LocalProcess(..)
22 , LocalProcess(..)
36 , LocalProcessState(..)
23 , LocalProcessState(..)
37 , Process(..)
24 , Process(..)
@@ -72,7 +59,6 @@ module Control.Distributed.Process.Internal.Types
72 , RegisterReply(..)
59 , RegisterReply(..)
73 , ProcessInfo(..)
60 , ProcessInfo(..)
74 , ProcessInfoNone(..)
61 , ProcessInfoNone(..)
75− , NodeStats(..)
76 -- * Node controller internal data types
62 -- * Node controller internal data types
77 , NCMsg(..)
63 , NCMsg(..)
78 , ProcessSignal(..)
64 , ProcessSignal(..)
@@ -95,7 +81,6 @@ module Control.Distributed.Process.Internal.Types
95import System.Mem.Weak (Weak)
81import System.Mem.Weak (Weak)
96import Data.Map (Map)
82import Data.Map (Map)
97import Data.Int (Int32)
83import Data.Int (Int32)
98−import Data.Data (Data)
99import Data.Typeable (Typeable, typeOf)
84import Data.Typeable (Typeable, typeOf)
100import Data.Binary (Binary(put, get), putWord8, getWord8, encode)
85import Data.Binary (Binary(put, get), putWord8, getWord8, encode)
101import qualified Data.ByteString as BSS (ByteString, concat, copy)
86import qualified Data.ByteString as BSS (ByteString, concat, copy)
@@ -110,17 +95,15 @@ import qualified Data.ByteString.Lazy.Internal as BSL (ByteString(..))
110import Data.Accessor (Accessor, accessor)
95import Data.Accessor (Accessor, accessor)
111import Control.Category ((>>>))
96import Control.Category ((>>>))
112import Control.DeepSeq (NFData(..))
97import Control.DeepSeq (NFData(..))
113−import Control.Exception (Exception, throwIO)
98+import Control.Exception (Exception)
114import Control.Concurrent (ThreadId)
99import Control.Concurrent (ThreadId)
115import Control.Concurrent.Chan (Chan)
100import Control.Concurrent.Chan (Chan)
116import Control.Concurrent.STM (STM)
101import Control.Concurrent.STM (STM)
117import Control.Concurrent.STM.TChan (TChan)
102import Control.Concurrent.STM.TChan (TChan)
118−import Control.Monad.Catch (MonadThrow(..), MonadCatch(..), MonadMask(..))
119import qualified Network.Transport as NT (EndPoint, EndPointAddress, Connection)
103import qualified Network.Transport as NT (EndPoint, EndPointAddress, Connection)
120−import Control.Applicative
104+import Control.Applicative (Applicative, Alternative, (<$>), (<*>))
121−import Control.Monad.Fix (MonadFix)
122import Control.Monad.Reader (MonadReader(..), ReaderT, runReaderT)
105import Control.Monad.Reader (MonadReader(..), ReaderT, runReaderT)
123−import Control.Monad.IO.Class (MonadIO(..))
106+import Control.Monad.IO.Class (MonadIO)
124import Control.Distributed.Process.Serializable
107import Control.Distributed.Process.Serializable
125 ( Fingerprint
108 ( Fingerprint
126 , Serializable
109 , Serializable
@@ -131,19 +114,13 @@ import Control.Distributed.Process.Serializable
131 , showFingerprint
114 , showFingerprint
132 )
115 )
133import Control.Distributed.Process.Internal.CQueue (CQueue)
116import Control.Distributed.Process.Internal.CQueue (CQueue)
134−import Control.Distributed.Process.Internal.StrictMVar
117+import Control.Distributed.Process.Internal.StrictMVar (StrictMVar)
135− ( StrictMVar
136− , withMVar
137− , modifyMVar
138− , modifyMVar_
139− )
140import Control.Distributed.Process.Internal.WeakTQueue (TQueue)
118import Control.Distributed.Process.Internal.WeakTQueue (TQueue)
141import Control.Distributed.Static (RemoteTable, Closure)
119import Control.Distributed.Static (RemoteTable, Closure)
142import qualified Control.Distributed.Process.Internal.StrictContainerAccessors as DAC (mapMaybe)
120import qualified Control.Distributed.Process.Internal.StrictContainerAccessors as DAC (mapMaybe)
143
121
144import Data.Hashable
122import Data.Hashable
145import GHC.Generics
123import GHC.Generics
146−import Prelude
147
124
148--------------------------------------------------------------------------------
125--------------------------------------------------------------------------------
149-- Node and process identifiers --
126-- Node and process identifiers --
@@ -151,9 +128,9 @@ import Prelude
151
128
152-- | Node identifier
129-- | Node identifier
153newtype NodeId = NodeId { nodeAddress :: NT.EndPointAddress }
130newtype NodeId = NodeId { nodeAddress :: NT.EndPointAddress }
154− deriving (Eq, Ord, Typeable, Data, Generic)
131+ deriving (Eq, Ord, Typeable, Generic)
155instance Binary NodeId where
132instance Binary NodeId where
156−instance NFData NodeId where rnf (NodeId a) = rnf a `seq` ()
133+instance NFData NodeId
157instance Hashable NodeId where
134instance Hashable NodeId where
158instance Show NodeId where
135instance Show NodeId where
159 show (NodeId addr) = "nid://" ++ show addr
136 show (NodeId addr) = "nid://" ++ show addr
@@ -164,7 +141,7 @@ data LocalProcessId = LocalProcessId
164 { lpidUnique :: {-# UNPACK #-} !Int32
141 { lpidUnique :: {-# UNPACK #-} !Int32
165 , lpidCounter :: {-# UNPACK #-} !Int32
142 , lpidCounter :: {-# UNPACK #-} !Int32
166 }
143 }
167− deriving (Eq, Ord, Typeable, Data, Generic, Show)
144+ deriving (Eq, Ord, Typeable, Generic, Show)
168
145
169instance Hashable LocalProcessId where
146instance Hashable LocalProcessId where
170
147
@@ -175,10 +152,10 @@ data ProcessId = ProcessId
175 -- | Node-local identifier for the process
152 -- | Node-local identifier for the process
176 , processLocalId :: {-# UNPACK #-} !LocalProcessId
153 , processLocalId :: {-# UNPACK #-} !LocalProcessId
177 }
154 }
178− deriving (Eq, Ord, Typeable, Data, Generic)
155+ deriving (Eq, Ord, Typeable, Generic)
179
156
180instance Binary ProcessId where
157instance Binary ProcessId where
181−instance NFData ProcessId where rnf (ProcessId n _) = rnf n `seq` ()
158+instance NFData ProcessId where
182instance Hashable ProcessId where
159instance Hashable ProcessId where
183
160
184instance Show ProcessId where
161instance Show ProcessId where
@@ -193,10 +170,6 @@ data Identifier =
193 deriving (Eq, Ord, Generic)
170 deriving (Eq, Ord, Generic)
194
171
195instance Hashable Identifier where
172instance 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` ()
200
173
201instance Show Identifier where
174instance Show Identifier where
202 show (NodeIdentifier nid) = show nid
175 show (NodeIdentifier nid) = show nid
@@ -273,11 +246,7 @@ data ImplicitReconnect = WithImplicitReconnect | NoImplicitReconnect
273 deriving (Eq, Show)
246 deriving (Eq, Show)
274
247
275-- | Local node state
248-- | Local node state
276−data LocalNodeState =
249+data LocalNodeState = LocalNodeState
277− LocalNodeValid {-# UNPACK #-} !ValidLocalNodeState
278− | LocalNodeClosed
279−
280−data ValidLocalNodeState = ValidLocalNodeState
281 { -- | Processes running on this node
250 { -- | Processes running on this node
282 _localProcesses :: !(Map LocalProcessId LocalProcess)
251 _localProcesses :: !(Map LocalProcessId LocalProcess)
283 -- | Counter to assign PIDs
252 -- | Counter to assign PIDs
@@ -290,40 +259,6 @@ data ValidLocalNodeState = ValidLocalNodeState
290 (NT.Connection, ImplicitReconnect))
259 (NT.Connection, ImplicitReconnect))
291 }
260 }
292
261
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−
327-- | Processes running on our local node
262-- | Processes running on our local node
328data LocalProcess = LocalProcess
263data LocalProcess = LocalProcess
329 { processQueue :: !(CQueue Message)
264 { processQueue :: !(CQueue Message)
@@ -350,50 +285,7 @@ data LocalProcessState = LocalProcessState
350newtype Process a = Process {
285newtype Process a = Process {
351 unProcess :: ReaderT LocalProcess IO a
286 unProcess :: ReaderT LocalProcess IO a
352 }
287 }
353− deriving ( Applicative
354− , Functor
355− , Monad
356− , MonadFix
357− , MonadIO
358− , MonadReader LocalProcess
288+ deriving (Functor, Monad, MonadIO, MonadReader LocalProcess, Typeable, Applicative)
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
397
289
398--------------------------------------------------------------------------------
290--------------------------------------------------------------------------------
399-- Typed channels --
291-- Typed channels --
@@ -418,9 +310,6 @@ instance Show SendPortId where
418 show (SendPortId (ProcessId (NodeId addr) (LocalProcessId _ plid)) clid)
310 show (SendPortId (ProcessId (NodeId addr) (LocalProcessId _ plid)) clid)
419 = "cid://" ++ show addr ++ ":" ++ show plid ++ ":" ++ show clid
311 = "cid://" ++ show addr ++ ":" ++ show plid ++ ":" ++ show clid
420
312
421−instance NFData SendPortId where
422− rnf (SendPortId p _) = rnf p `seq` ()
423−
424data TypedChannel = forall a. Serializable a => TypedChannel (Weak (TQueue a))
313data TypedChannel = forall a. Serializable a => TypedChannel (Weak (TQueue a))
425
314
426-- | The send send of a typed channel (serializable)
315-- | The send send of a typed channel (serializable)
@@ -432,7 +321,7 @@ newtype SendPort a = SendPort {
432
321
433instance (Serializable a) => Binary (SendPort a) where
322instance (Serializable a) => Binary (SendPort a) where
434instance (Hashable a) => Hashable (SendPort a) where
323instance (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
436
325
437-- | The receive end of a typed channel (not serializable)
326-- | The receive end of a typed channel (not serializable)
438--
327--
@@ -470,15 +359,6 @@ data Message =
470 }
359 }
471 deriving (Typeable)
360 deriving (Typeable)
472
361
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−
482instance Show Message where
362instance Show Message where
483 show (EncodedMessage fp enc) = show enc ++ " :: " ++ showFingerprint fp []
363 show (EncodedMessage fp enc) = show enc ++ " :: " ++ showFingerprint fp []
484 show (UnencodedMessage _ uenc) = "[unencoded message] :: " ++ (show $ typeOf uenc)
364 show (UnencodedMessage _ uenc) = "[unencoded message] :: " ++ (show $ typeOf uenc)
@@ -505,7 +385,7 @@ createUnencodedMessage a =
505 let encoded = encode a in BSL.length encoded `seq` UnencodedMessage (fingerprint a) a
385 let encoded = encode a in BSL.length encoded `seq` UnencodedMessage (fingerprint a) a
506
386
507-- | Turn any serializable term into an unencodede/local message, without
387-- | Turn any serializable term into an unencodede/local message, without
508−-- evalutaing it! This is a dangerous business.
388+-- evalutaing it!
509unsafeCreateUnencodedMessage :: Serializable a => a -> Message
389unsafeCreateUnencodedMessage :: Serializable a => a -> Message
510unsafeCreateUnencodedMessage a = UnencodedMessage (fingerprint a) a
390unsafeCreateUnencodedMessage a = UnencodedMessage (fingerprint a) a
511
391
@@ -541,11 +421,8 @@ data MonitorRef = MonitorRef
541 -- | Unique to distinguish multiple monitor requests by the same process
421 -- | Unique to distinguish multiple monitor requests by the same process
542 , monitorRefCounter :: !Int32
422 , monitorRefCounter :: !Int32
543 }
423 }
544− deriving (Eq, Ord, Show, Typeable, Generic)
424+ deriving (Eq, Ord, Show, Generic)
545−instance Hashable MonitorRef
425+instance Hashable MonitorRef where
546−
547−instance NFData MonitorRef where
548− rnf (MonitorRef i _) = rnf i `seq` ()
549
426
550-- | Message sent by process monitors
427-- | Message sent by process monitors
551data ProcessMonitorNotification =
428data ProcessMonitorNotification =
@@ -579,11 +456,9 @@ data PortLinkException =
579
456
580-- | Exception thrown when a process attempts to register
457-- | Exception thrown when a process attempts to register
581-- a process under an already-registered name or to
458-- a process under an already-registered name or to
582−-- unregister a name that hasn't been registered. Returns
459+-- unregister a name that hasn't been registered
583−-- the name and the identifier of the process that owns it,
584−-- if any.
585data ProcessRegistrationException =
460data ProcessRegistrationException =
586− ProcessRegistrationException !String !(Maybe ProcessId)
461+ ProcessRegistrationException !String
587 deriving (Typeable, Show)
462 deriving (Typeable, Show)
588
463
589-- | Internal exception thrown indirectly by 'exit'
464-- | Internal exception thrown indirectly by 'exit'
@@ -615,10 +490,6 @@ data DiedReason =
615 | DiedUnknownId
490 | DiedUnknownId
616 deriving (Show, Eq)
491 deriving (Show, Eq)
617
492
618−instance NFData DiedReason where
619− rnf (DiedException s) = rnf s `seq` ()
620− rnf x = x `seq` ()
621−
622-- | (Asynchronous) reply from unmonitor
493-- | (Asynchronous) reply from unmonitor
623newtype DidUnmonitor = DidUnmonitor MonitorRef
494newtype DidUnmonitor = DidUnmonitor MonitorRef
624 deriving (Typeable, Binary)
495 deriving (Typeable, Binary)
@@ -637,7 +508,7 @@ newtype DidUnlinkPort = DidUnlinkPort SendPortId
637
508
638-- | 'SpawnRef' are used to return pids of spawned processes
509-- | 'SpawnRef' are used to return pids of spawned processes
639newtype SpawnRef = SpawnRef Int32
510newtype SpawnRef = SpawnRef Int32
640− deriving (Show, Binary, Typeable, Eq, Ord)
511+ deriving (Show, Binary, Typeable, Eq)
641
512
642-- | (Asynchronius) reply from 'spawn'
513-- | (Asynchronius) reply from 'spawn'
643data DidSpawn = DidSpawn SpawnRef ProcessId
514data DidSpawn = DidSpawn SpawnRef ProcessId
@@ -648,23 +519,14 @@ data WhereIsReply = WhereIsReply String (Maybe ProcessId)
648 deriving (Show, Typeable)
519 deriving (Show, Typeable)
649
520
650-- | (Asynchronous) reply from 'register' and 'unregister'
521-- | (Asynchronous) reply from 'register' and 'unregister'
651−data RegisterReply = RegisterReply String Bool (Maybe ProcessId)
522+data RegisterReply = RegisterReply String Bool
652 deriving (Show, Typeable)
523 deriving (Show, Typeable)
653
524
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−
663-- | Provide information about a running process
525-- | Provide information about a running process
664data ProcessInfo = ProcessInfo {
526data ProcessInfo = ProcessInfo {
665 infoNode :: NodeId
527 infoNode :: NodeId
666 , infoRegisteredNames :: [String]
528 , infoRegisteredNames :: [String]
667− , infoMessageQueueLength :: Int
529+ , infoMessageQueueLength :: Maybe Int
668 , infoMonitors :: [(ProcessId, MonitorRef)]
530 , infoMonitors :: [(ProcessId, MonitorRef)]
669 , infoLinks :: [ProcessId]
531 , infoLinks :: [ProcessId]
670 } deriving (Show, Eq, Typeable)
532 } deriving (Show, Eq, Typeable)
@@ -694,14 +556,12 @@ data ProcessSignal =
694 | WhereIs !String
556 | WhereIs !String
695 | Register !String !NodeId !(Maybe ProcessId) !Bool -- Use 'Nothing' to unregister, use True to force reregister
557 | Register !String !NodeId !(Maybe ProcessId) !Bool -- Use 'Nothing' to unregister, use True to force reregister
696 | NamedSend !String !Message
558 | NamedSend !String !Message
697− | UnreliableSend !LocalProcessId !Message
698 | LocalSend !ProcessId !Message
559 | LocalSend !ProcessId !Message
699 | LocalPortSend !SendPortId !Message
560 | LocalPortSend !SendPortId !Message
700 | Kill !ProcessId !String
561 | Kill !ProcessId !String
701 | Exit !ProcessId !Message
562 | Exit !ProcessId !Message
702 | GetInfo !ProcessId
563 | GetInfo !ProcessId
703 | SigShutdown
564 | SigShutdown
704− | GetNodeStats !NodeId
705 deriving Show
565 deriving Show
706
566
707--------------------------------------------------------------------------------
567--------------------------------------------------------------------------------
@@ -750,10 +610,8 @@ instance Binary ProcessSignal where
750 put (Exit pid reason) = putWord8 10 >> put pid >> put (messageToPayload reason)
610 put (Exit pid reason) = putWord8 10 >> put pid >> put (messageToPayload reason)
751 put (LocalSend to' msg) = putWord8 11 >> put to' >> put (messageToPayload msg)
611 put (LocalSend to' msg) = putWord8 11 >> put to' >> put (messageToPayload msg)
752 put (LocalPortSend sid msg) = putWord8 12 >> put sid >> put (messageToPayload msg)
612 put (LocalPortSend sid msg) = putWord8 12 >> put sid >> put (messageToPayload msg)
753− put (UnreliableSend lpid msg) = putWord8 13 >> put lpid >> put (messageToPayload msg)
754 put (GetInfo about) = putWord8 30 >> put about
613 put (GetInfo about) = putWord8 30 >> put about
755 put (SigShutdown) = putWord8 31
614 put (SigShutdown) = putWord8 31
756− put (GetNodeStats nid) = putWord8 32 >> put nid
757 get = do
615 get = do
758 header <- getWord8
616 header <- getWord8
759 case header of
617 case header of
@@ -770,10 +628,8 @@ instance Binary ProcessSignal where
770 10 -> Exit <$> get <*> (payloadToMessage <$> get)
628 10 -> Exit <$> get <*> (payloadToMessage <$> get)
771 11 -> LocalSend <$> get <*> (payloadToMessage <$> get)
629 11 -> LocalSend <$> get <*> (payloadToMessage <$> get)
772 12 -> LocalPortSend <$> get <*> (payloadToMessage <$> get)
630 12 -> LocalPortSend <$> get <*> (payloadToMessage <$> get)
773− 13 -> UnreliableSend <$> get <*> (payloadToMessage <$> get)
774 30 -> GetInfo <$> get
631 30 -> GetInfo <$> get
775 31 -> return SigShutdown
632 31 -> return SigShutdown
776− 32 -> GetNodeStats <$> get
777 _ -> fail "ProcessSignal.get: invalid"
633 _ -> fail "ProcessSignal.get: invalid"
778
634
779instance Binary DiedReason where
635instance Binary DiedReason where
@@ -800,6 +656,9 @@ instance Binary SendPortId where
800 put cid = put (sendPortProcessId cid) >> put (sendPortLocalId cid)
656 put cid = put (sendPortProcessId cid) >> put (sendPortLocalId cid)
801 get = SendPortId <$> get <*> get
657 get = SendPortId <$> get <*> get
802
658
659+instance NFData SendPortId where
660+ rnf cid = (sendPortProcessId cid) `seq` (sendPortLocalId cid) `seq` ()
661+
803instance Binary Identifier where
662instance Binary Identifier where
804 put (ProcessIdentifier pid) = putWord8 0 >> put pid
663 put (ProcessIdentifier pid) = putWord8 0 >> put pid
805 put (NodeIdentifier nid) = putWord8 1 >> put nid
664 put (NodeIdentifier nid) = putWord8 1 >> put nid
@@ -817,8 +676,8 @@ instance Binary WhereIsReply where
817 get = WhereIsReply <$> get <*> get
676 get = WhereIsReply <$> get <*> get
818
677
819instance Binary RegisterReply where
678instance Binary RegisterReply where
820− put (RegisterReply label ok owner) = put label >> put ok >> put owner
679+ put (RegisterReply label ok) = put label >> put ok
821− get = RegisterReply <$> get <*> get <*> get
680+ get = RegisterReply <$> get <*> get
822
681
823instance Binary ProcessInfo where
682instance Binary ProcessInfo where
824 get = ProcessInfo <$> get <*> get <*> get <*> get <*> get
683 get = ProcessInfo <$> get <*> get <*> get <*> get <*> get
@@ -828,14 +687,6 @@ instance Binary ProcessInfo where
828 >> put (infoMonitors pInfo)
687 >> put (infoMonitors pInfo)
829 >> put (infoLinks pInfo)
688 >> put (infoLinks pInfo)
830
689
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−
839instance Binary ProcessInfoNone where
690instance Binary ProcessInfoNone where
840 get = ProcessInfoNone <$> get
691 get = ProcessInfoNone <$> get
841 put (ProcessInfoNone r) = put r
692 put (ProcessInfoNone r) = put r
@@ -844,22 +695,22 @@ instance Binary ProcessInfoNone where
844-- Accessors --
695-- Accessors --
845--------------------------------------------------------------------------------
696--------------------------------------------------------------------------------
846
697
847−localProcesses :: Accessor ValidLocalNodeState (Map LocalProcessId LocalProcess)
698+localProcesses :: Accessor LocalNodeState (Map LocalProcessId LocalProcess)
848localProcesses = accessor _localProcesses (\procs st -> st { _localProcesses = procs })
699localProcesses = accessor _localProcesses (\procs st -> st { _localProcesses = procs })
849
700
850−localPidCounter :: Accessor ValidLocalNodeState Int32
701+localPidCounter :: Accessor LocalNodeState Int32
851localPidCounter = accessor _localPidCounter (\ctr st -> st { _localPidCounter = ctr })
702localPidCounter = accessor _localPidCounter (\ctr st -> st { _localPidCounter = ctr })
852
703
853−localPidUnique :: Accessor ValidLocalNodeState Int32
704+localPidUnique :: Accessor LocalNodeState Int32
854localPidUnique = accessor _localPidUnique (\unq st -> st { _localPidUnique = unq })
705localPidUnique = accessor _localPidUnique (\unq st -> st { _localPidUnique = unq })
855
706
856−localConnections :: Accessor ValidLocalNodeState (Map (Identifier, Identifier) (NT.Connection, ImplicitReconnect))
707+localConnections :: Accessor LocalNodeState (Map (Identifier, Identifier) (NT.Connection, ImplicitReconnect))
857localConnections = accessor _localConnections (\conns st -> st { _localConnections = conns })
708localConnections = accessor _localConnections (\conns st -> st { _localConnections = conns })
858
709
859−localProcessWithId :: LocalProcessId -> Accessor ValidLocalNodeState (Maybe LocalProcess)
710+localProcessWithId :: LocalProcessId -> Accessor LocalNodeState (Maybe LocalProcess)
860localProcessWithId lpid = localProcesses >>> DAC.mapMaybe lpid
711localProcessWithId lpid = localProcesses >>> DAC.mapMaybe lpid
861
712
862−localConnectionBetween :: Identifier -> Identifier -> Accessor ValidLocalNodeState (Maybe (NT.Connection, ImplicitReconnect))
713+localConnectionBetween :: Identifier -> Identifier -> Accessor LocalNodeState (Maybe (NT.Connection, ImplicitReconnect))
863localConnectionBetween from' to' = localConnections >>> DAC.mapMaybe (from', to')
714localConnectionBetween from' to' = localConnections >>> DAC.mapMaybe (from', to')
864
715
865monitorCounter :: Accessor LocalProcessState Int32
716monitorCounter :: Accessor LocalProcessState Int32
@@ -885,3 +736,4 @@ typedChannelWithId cid = typedChannels >>> DAC.mapMaybe cid
885{-# INLINE forever' #-}
736{-# INLINE forever' #-}
886forever' :: Monad m => m a -> m b
737forever' :: Monad m => m a -> m b
887forever' a = let a' = a >> a' in a'
738forever' 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 #-}
4-- | Clone of Control.Concurrent.STM.TQueue with support for mkWeakTQueue
1-- | Clone of Control.Concurrent.STM.TQueue with support for mkWeakTQueue
5--
2--
6-- Not all functionality from the original module is available: unGetTQueue,
3-- Not all functionality from the original module is available: unGetTQueue,
7-- peekTQueue and tryPeekTQueue are missing. In order to implement these we'd
4-- peekTQueue and tryPeekTQueue are missing. In order to implement these we'd
8-- need to be able to touch# the write end of the queue inside unGetTQueue, but
5-- need to be able to touch# the write end of the queue inside unGetTQueue, but
9-- that means we need a version of touch# that works within the STM monad.
6-- that means we need a version of touch# that works within the STM monad.
7+{-# LANGUAGE MagicHash, UnboxedTuples #-}
10module Control.Distributed.Process.Internal.WeakTQueue (
8module Control.Distributed.Process.Internal.WeakTQueue (
11 -- * Original functionality
9 -- * Original functionality
12 TQueue,
10 TQueue,
@@ -23,8 +21,8 @@ module Control.Distributed.Process.Internal.WeakTQueue (
23import Prelude hiding (read)
21import Prelude hiding (read)
24import GHC.Conc
22import GHC.Conc
25import Data.Typeable (Typeable)
23import Data.Typeable (Typeable)
26−import GHC.IO (IO(IO), unIO)
24+import GHC.IO (IO(IO))
27−import GHC.Exts (mkWeak#)
25+import GHC.Prim (mkWeak#)
28import GHC.Weak (Weak(Weak))
26import GHC.Weak (Weak(Weak))
29
27
30--------------------------------------------------------------------------------
28--------------------------------------------------------------------------------
@@ -100,8 +98,4 @@ isEmptyTQueue (TQueue read write) = do
100
98
101mkWeakTQueue :: TQueue a -> IO () -> IO (Weak (TQueue a))
99mkWeakTQueue :: TQueue a -> IO () -> IO (Weak (TQueue a))
102mkWeakTQueue q@(TQueue _read (TVar write#)) f = IO $ \s ->
100mkWeakTQueue 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
106 case mkWeak# write# q f s of (# s', w #) -> (# s', Weak w #)
101 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 @@
4{-# LANGUAGE ExistentialQuantification #-}
4{-# LANGUAGE ExistentialQuantification #-}
5{-# LANGUAGE ScopedTypeVariables #-}
5{-# LANGUAGE ScopedTypeVariables #-}
6{-# LANGUAGE RecordWildCards #-}
6{-# LANGUAGE RecordWildCards #-}
7−{-# LANGUAGE PatternGuards #-}
8{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FlexibleInstances #-}
9{-# LANGUAGE UndecidableInstances #-}
8{-# LANGUAGE UndecidableInstances #-}
10
9
@@ -18,234 +17,24 @@
18-- Stability : experimental
17-- Stability : experimental
19-- Portability : non-portable (requires concurrency)
18-- Portability : non-portable (requires concurrency)
20--
19--
21−-- [Management Extensions API]
20+-- /Management Extensions/ for Cloud Haskell.
22--
21--
23−-- This module presents an API for creating /Management Agents/:
24−-- special processes that are capable of receiving and responding to
22+-- This module provides a standard API for receiving and/or responding to
25−-- a node's internal system events. These /system events/ are delivered by
23+-- system events in a Cloud Haskell node.
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.
208--
24--
209-- [Architecture Overview]
25-- [Architecture Overview]
210--
26--
211−-- The architecture of the management event bus is internal and subject to
27+-- /Management Extensions/ can be used by infrastructure or application code
212−-- change without prior notice. The description that follows is provided for
28+-- to provide access to runtime instrumentation data, expose control planes
213−-- informational purposes only.
29+-- and/or provide remote access to external clients.
214--
30--
215−-- When a node initially starts, two special, internal system processes are
31+-- The management infrastructure is broken down into three components, which
216−-- started to support the management infrastructure. The first, known as the
32+-- roughly correspond to the modules it exposes:
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/.
224--
33--
225−-- There are several reasons for segregating the tracing and management control
34+-- 1. @Agent@ - registration and management of /Management Agents/
226−-- planes in this fashion. Tracing can be enabled or disabled by clients, whilst
35+-- 2. @Instrumentation@ - provides an API for publishing /instrumentation data/
227−-- the management event bus cannot, since in addition to providing
36+-- 3. @Remote@ - provides an API for remote management and administration
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/.
236--
37--
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.
249--
38--
250-----------------------------------------------------------------------------
39-----------------------------------------------------------------------------
251module Control.Distributed.Process.Management
40module Control.Distributed.Process.Management
@@ -258,37 +47,36 @@ module Control.Distributed.Process.Management
258 , MxAgentId(..)
47 , MxAgentId(..)
259 , MxAgent()
48 , MxAgent()
260 , mxAgent
49 , mxAgent
261− , mxAgentWithFinalize
262− , MxSink()
50+ , MxSink
263 , mxSink
51 , mxSink
264 , mxGetId
52 , mxGetId
265 , mxDeactivate
53 , mxDeactivate
266 , mxReady
54 , mxReady
267− , mxSkip
268− , mxReceive
269− , mxReceiveChan
270 , mxBroadcast
55 , mxBroadcast
271 , mxSetLocal
56 , mxSetLocal
272 , mxGetLocal
57 , mxGetLocal
273− , mxUpdateLocal
274 , liftMX
58 , liftMX
59+ -- * Mx Data API
60+ , mxPublish
61+ , mxSet
62+ , mxGet
63+ , mxClear
64+ , mxPurgeTable
65+ , mxDropTable
275 ) where
66 ) where
276
67
277−import Control.Applicative
68+import Control.Applicative ((<$>))
278import Control.Concurrent.STM (atomically)
69import Control.Concurrent.STM (atomically)
279import Control.Concurrent.STM.TChan
70import Control.Concurrent.STM.TChan
280 ( readTChan
71 ( readTChan
281 , writeTChan
72 , writeTChan
282− , TChan
283 )
73 )
284import Control.Distributed.Process.Internal.Primitives
74import Control.Distributed.Process.Internal.Primitives
75+ ( newChan
76+ , nsend
285− ( receiveWait
77+ , receiveWait
286− , matchAny
78+ , matchChan
287− , matchSTM
288 , unwrapMessage
79 , unwrapMessage
289− , register
290− , whereis
291− , die
292 )
80 )
293import Control.Distributed.Process.Internal.Types
81import Control.Distributed.Process.Internal.Types
294 ( Process
82 ( Process
@@ -299,27 +87,28 @@ import Control.Distributed.Process.Internal.Types
299 , MxEventBus(..)
87 , MxEventBus(..)
300 , unsafeCreateUnencodedMessage
88 , unsafeCreateUnencodedMessage
301 )
89 )
302−import Control.Distributed.Process.Management.Internal.Bus (publishEvent)
90+import Control.Distributed.Process.Management.Bus (publishEvent)
303−import Control.Distributed.Process.Management.Internal.Types
91+import qualified Control.Distributed.Process.Management.Table as Table
92+import Control.Distributed.Process.Management.Types
304 ( MxAgentId(..)
93 ( MxAgentId(..)
305 , MxAgent(..)
94 , MxAgent(..)
306 , MxAction(..)
95 , MxAction(..)
307− , ChannelSelector(..)
308 , MxAgentState(..)
96 , MxAgentState(..)
97+ , MxAgentStart(..)
309 , MxSink
98 , MxSink
310 , MxEvent(..)
99 , MxEvent(..)
311 )
100 )
312import Control.Distributed.Process.Serializable (Serializable)
101import Control.Distributed.Process.Serializable (Serializable)
313import Control.Monad.IO.Class (liftIO)
102import Control.Monad.IO.Class (liftIO)
314import Control.Monad.Reader (ask)
103import Control.Monad.Reader (ask)
315−import Control.Monad.Catch (onException)
316import qualified Control.Monad.State as ST
104import qualified Control.Monad.State as ST
105+ ( MonadState
106+ , StateT
317− ( get
107+ , get
318 , modify
108 , modify
319 , lift
109 , lift
320 , runStateT
110 , runStateT
321 )
111 )
322−import Prelude
323
112
324-- | Publishes an arbitrary @Serializable@ message to the management event bus.
113-- | Publishes an arbitrary @Serializable@ message to the management event bus.
325-- Note that /no attempt is made to force the argument/, therefore it is very
114-- Note that /no attempt is made to force the argument/, therefore it is very
@@ -331,76 +120,71 @@ mxNotify msg = do
331 bus <- localEventBus . processNode <$> ask
120 bus <- localEventBus . processNode <$> ask
332 liftIO $ publishEvent bus $ unsafeCreateUnencodedMessage msg
121 liftIO $ publishEvent bus $ unsafeCreateUnencodedMessage msg
333
122
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+
334--------------------------------------------------------------------------------
160--------------------------------------------------------------------------------
335-- API for writing user defined management extensions (i.e., agents) --
161-- API for writing user defined management extensions (i.e., agents) --
336--------------------------------------------------------------------------------
162--------------------------------------------------------------------------------
337
163
338−-- | Return the 'MxAgentId' for the currently executing agent.
339−--
340mxGetId :: MxAgent s MxAgentId
164mxGetId :: MxAgent s MxAgentId
341mxGetId = ST.get >>= return . mxAgentId
165mxGetId = ST.get >>= return . mxAgentId
342
166
343−-- | The 'MxAgent' version of 'mxNotify'.
344−--
345mxBroadcast :: (Serializable m) => m -> MxAgent s ()
167mxBroadcast :: (Serializable m) => m -> MxAgent s ()
346mxBroadcast msg = do
168mxBroadcast msg = do
347 state <- ST.get
169 state <- ST.get
348 liftMX $ liftIO $ atomically $ do
170 liftMX $ liftIO $ atomically $ do
349 writeTChan (mxBus state) (unsafeCreateUnencodedMessage msg)
171 writeTChan (mxBus state) (unsafeCreateUnencodedMessage msg)
350
172
351−-- | Gracefully terminate an agent.
352−--
353mxDeactivate :: forall s. String -> MxAgent s MxAction
173mxDeactivate :: forall s. String -> MxAgent s MxAction
354mxDeactivate = return . MxAgentDeactivate
174mxDeactivate = return . MxAgentDeactivate
355
175
356−-- | Continue executing (i.e., receiving and processing messages).
357−--
358mxReady :: forall s. MxAgent s MxAction
176mxReady :: forall s. MxAgent s MxAction
359mxReady = return MxAgentReady
177mxReady = return MxAgentReady
360
178
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−--
383liftMX :: Process a -> MxAgent s a
179liftMX :: Process a -> MxAgent s a
384liftMX p = MxAgent $ ST.lift p
180liftMX p = MxAgent $ ST.lift p
385
181
386−-- | Set the agent's local state.
387−--
388mxSetLocal :: s -> MxAgent s ()
182mxSetLocal :: s -> MxAgent s ()
389mxSetLocal s = ST.modify $ \st -> st { mxLocalState = s }
183mxSetLocal s = ST.modify $ \st -> st { mxLocalState = s }
390
184
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−--
398mxGetLocal :: MxAgent s s
185mxGetLocal :: MxAgent s s
399mxGetLocal = ST.get >>= return . mxLocalState
186mxGetLocal = ST.get >>= return . mxLocalState
400
187
401−-- | Create an 'MxSink' from an expression taking a @Serializable@ type @m@,
402−-- that yields an 'MxAction' in the 'MxAgent' monad.
403−--
404mxSink :: forall s m . (Serializable m)
188mxSink :: forall s m . (Serializable m)
405 => (m -> MxAgent s MxAction)
189 => (m -> MxAgent s MxAction)
406 -> MxSink s
190 -> MxSink s
@@ -408,88 +192,43 @@ mxSink act msg = do
408 msg' <- liftMX $ (unwrapMessage msg :: Process (Maybe m))
192 msg' <- liftMX $ (unwrapMessage msg :: Process (Maybe m))
409 case msg' of
193 case msg' of
410 Nothing -> return Nothing
194 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
416
196
417−-- private ADT: a linked list of event sinks
418data MxPipeline s =
197data MxPipeline s =
419 MxPipeline
198 MxPipeline
420 {
199 {
421− current :: !(MxSink s)
200+ current :: !(MxSink s)
422− , next :: !(MxPipeline s)
201+ , next :: !(MxPipeline s)
423 } | MxStop
202 } | MxStop
424
203
425-- | Activates a new agent.
204-- | Activates a new agent.
426--
205--
427−mxAgent :: MxAgentId -> s -> [MxSink s] -> Process ProcessId
206+mxAgent :: MxAgentId
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
437 -> s
207 -> s
438 -> [MxSink s]
208 -> [MxSink s]
439− -> MxAgent s ()
440 -> Process ProcessId
209 -> Process ProcessId
441−mxAgentWithFinalize mxId initState handlers dtor = do
210+mxAgent mxId initState handlers = 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
211+ node <- processNode <$> ask
448− pid <- liftIO $ mxNew (localEventBus node) $ start
212+ pid <- liftIO $ mxNew (localEventBus node) $ start
449− register name pid
450− return pid
213+ return pid
451 where
214 where
452 start (sendTChan, recvTChan) = do
215 start (sendTChan, recvTChan) = do
453− let nState = MxAgentState mxId sendTChan initState
216+ (sp, rp) <- newChan
454− runAgent dtor handlers InputChan recvTChan nState
217+ nsend Table.mxTableCoordinator (MxAgentStart sp mxId)
455−
218+ -- liftIO $ putStrLn $ "waiting on table coordinator " ++ Table.mxTableCoordinator
456− runAgent :: MxAgent s ()
219+ -- p <- whereis Table.mxTableCoordinator
457− -> [MxSink s]
220+ -- liftIO $ putStrLn $ "registration == " ++ (show p)
458− -> ChannelSelector
221+ tablePid <- receiveWait [ matchChan rp (\(p :: ProcessId) -> return p) ]
459− -> TChan Message
222+ -- liftIO $ putStrLn "starting agent listener..."
460− -> MxAgentState s
223+ runAgent handlers recvTChan $ MxAgentState mxId sendTChan tablePid initState
461− -> Process ()
224+
462− runAgent eh hs cs c s =
225+ runAgent hs c s = do
463− runAgentWithFinalizer eh hs cs c s
226+ msg <- (liftIO $ atomically $ readTChan c)
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'
227+ (action, state) <- runPipeline msg s $ pipeline hs
475 case action of
228 case action of
476− MxAgentReady -> runAgent eh' hs' InputChan c' state
477− MxAgentPrioritise priority -> runAgent eh' hs' priority c' state
229+ MxAgentReady -> runAgent hs c state
478− MxAgentDeactivate _ -> runAgentFinalizer eh' state
230+ MxAgentDeactivate _ -> {- TODO: log r -} return ()
479− MxAgentSkip -> error "IllegalState"
480−-- MxAgentBecome h' -> runAgent h' c state
231+-- 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
493
232
494 pipeline :: forall s . [MxSink s] -> MxPipeline s
233 pipeline :: forall s . [MxSink s] -> MxPipeline s
495 pipeline [] = MxStop
234 pipeline [] = MxStop
@@ -507,3 +246,4 @@ mxAgentWithFinalize mxId initState handlers dtor = do
507 case pass of
246 case pass of
508 Nothing -> runPipeline msg state next
247 Nothing -> runPipeline msg state next
509 Just result -> return (result, state')
248 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 #-}
2{-# LANGUAGE RecordWildCards #-}
1{-# LANGUAGE RecordWildCards #-}
3
2
4−module Control.Distributed.Process.Management.Internal.Agent where
3+module Control.Distributed.Process.Management.Agent where
5
4
6−import Control.Applicative
5+import Control.Applicative ((<$>))
7−import Control.Concurrent (forkIO)
8import Control.Concurrent.MVar (MVar, newEmptyMVar, putMVar, takeMVar)
6import Control.Concurrent.MVar (MVar, newEmptyMVar, putMVar, takeMVar)
9import Control.Concurrent.STM (atomically)
7import Control.Concurrent.STM (atomically)
10import Control.Concurrent.STM.TChan
8import Control.Concurrent.STM.TChan
11 ( TChan
9 ( TChan
12 , newBroadcastTChanIO
10 , newBroadcastTChanIO
13− , readTChan
14 , writeTChan
11 , writeTChan
15 , dupTChan
12 , dupTChan
16 )
13 )
@@ -25,10 +22,10 @@ import Control.Distributed.Process.Internal.CQueue
25 ( enqueueSTM
22 ( enqueueSTM
26 , CQueue
23 , CQueue
27 )
24 )
28−import Control.Distributed.Process.Management.Internal.Types
25+import Control.Distributed.Process.Management.Types
29 ( Fork
26 ( Fork
30 )
27 )
31−import Control.Distributed.Process.Management.Internal.Trace.Tracer
28+import Control.Distributed.Process.Management.Trace.Tracer
32 ( traceController
29 ( traceController
33 )
30 )
34import Control.Distributed.Process.Internal.Types
31import Control.Distributed.Process.Internal.Types
@@ -44,7 +41,6 @@ import Control.Monad (void)
44import Control.Monad.IO.Class (liftIO)
41import Control.Monad.IO.Class (liftIO)
45import Control.Monad.Reader (ask)
42import Control.Monad.Reader (ask)
46import GHC.Weak (Weak, deRefWeak)
43import GHC.Weak (Weak, deRefWeak)
47−import Prelude
48
44
49--------------------------------------------------------------------------------
45--------------------------------------------------------------------------------
50-- Agent Controller Implementation --
46-- Agent Controller Implementation --
@@ -77,7 +73,6 @@ mxAgentController :: Fork
77mxAgentController forkProcess mv = do
73mxAgentController forkProcess mv = do
78 trc <- liftIO $ startTracing forkProcess
74 trc <- liftIO $ startTracing forkProcess
79 sigbus <- liftIO $ newBroadcastTChanIO
75 sigbus <- liftIO $ newBroadcastTChanIO
80− liftIO $ startDeadLetterQueue sigbus
81 weakQueue <- processWeakQ <$> ask
76 weakQueue <- processWeakQ <$> ask
82 liftIO $ putMVar mv (trc, weakQueue, mxStartAgent forkProcess sigbus)
77 liftIO $ putMVar mv (trc, weakQueue, mxStartAgent forkProcess sigbus)
83 go sigbus trc
78 go sigbus trc
@@ -99,7 +94,7 @@ mxAgentController forkProcess mv = do
99 -- (e.g., passing unevaluated thunks that will crash when
94 -- (e.g., passing unevaluated thunks that will crash when
100 -- they're eventually forced) are thus silently ignored.
95 -- they're eventually forced) are thus silently ignored.
101 --
96 --
102− matchAny (liftIO . broadcast bus tracer)
97+ matchAny (\msg -> liftIO $ broadcast bus tracer msg)
103 ] `catches` [Handler (\ThreadKilled -> die "Killed"),
98 ] `catches` [Handler (\ThreadKilled -> die "Killed"),
104 Handler (\(_ :: SomeException) -> return ())]
99 Handler (\(_ :: SomeException) -> return ())]
105
100
@@ -120,7 +115,6 @@ mxAgentController forkProcess mv = do
120 liftIO $ atomically $ enqueueSTM q msg >> writeTChan ch msg
115 liftIO $ atomically $ enqueueSTM q msg >> writeTChan ch msg
121
116
122-- | Forks a new process in which an mxAgent is run.
117-- | Forks a new process in which an mxAgent is run.
123−--
124mxStartAgent :: Fork
118mxStartAgent :: Fork
125 -> TChan Message
119 -> TChan Message
126 -> ((TChan Message, TChan Message) -> Process ())
120 -> ((TChan Message, TChan Message) -> Process ())
@@ -130,8 +124,6 @@ mxStartAgent fork chan handler = do
130 let proc = handler (chan, chan')
124 let proc = handler (chan, chan')
131 fork proc
125 fork proc
132
126
133−-- | Start the tracer controller.
134−--
135startTracing :: Fork -> IO Tracer
127startTracing :: Fork -> IO Tracer
136startTracing forkProcess = do
128startTracing forkProcess = do
137 mv <- newEmptyMVar
129 mv <- newEmptyMVar
@@ -139,19 +131,3 @@ startTracing forkProcess = do
139 wQ <- liftIO $ takeMVar mv
131 wQ <- liftIO $ takeMVar mv
140 return $ Tracer pid wQ
132 return $ Tracer pid wQ
141
133
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+13−3
@@ -1,16 +1,26 @@
1-- | Interface to the management event bus.
1-- | Interface to the management event bus.
2−module Control.Distributed.Process.Management.Internal.Bus
2+module Control.Distributed.Process.Management.Bus
3 ( publishEvent
3 ( publishEvent
4 ) where
4 ) where
5
5
6import Control.Distributed.Process.Internal.CQueue
6import Control.Distributed.Process.Internal.CQueue
7+ ( CQueue
7− ( enqueue
8+ , enqueue
8 )
9 )
9import Control.Distributed.Process.Internal.Types
10import Control.Distributed.Process.Internal.Types
11+ ( LocalNode(..)
10− ( MxEventBus(..)
12+ , MxEventBus(..)
11 , Message
13 , Message
14+ , ProcessId
15+ , DiedReason
16+ , NodeId
12 )
17 )
13import Data.Foldable (forM_)
18import Data.Foldable (forM_)
19+import Data.Typeable (Typeable)
20+import Network.Transport
21+ ( ConnectionId
22+ , EndPointAddress
23+ )
14import System.Mem.Weak (deRefWeak)
24import System.Mem.Weak (deRefWeak)
15
25
16publishEvent :: MxEventBus -> Message -> IO ()
26publishEvent :: MxEventBus -> Message -> IO ()
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+12−16
@@ -1,5 +1,3 @@
1−{-# LANGUAGE FlexibleInstances #-}
2−{-# LANGUAGE TypeSynonymInstances #-}
3-- | Keeps the tracing API calls separate from the Tracer implementation,
1-- | Keeps the tracing API calls separate from the Tracer implementation,
4-- which allows us to avoid a nasty import cycle between tracing and
2-- which allows us to avoid a nasty import cycle between tracing and
5-- the messaging primitives that rely on it, and also between the node
3-- the messaging primitives that rely on it, and also between the node
@@ -7,7 +5,7 @@
7-- our RemoteTable) and the Debug module, which requires @forkProcess@.
5-- our RemoteTable) and the Debug module, which requires @forkProcess@.
8-- This module is also used by the management agent, which relies on the
6-- This module is also used by the management agent, which relies on the
9-- tracing infrastructure's messaging fabric.
7-- tracing infrastructure's messaging fabric.
10−module Control.Distributed.Process.Management.Internal.Trace.Primitives
8+module Control.Distributed.Process.Management.Trace.Primitives
11 ( -- * Sending Trace Data
9 ( -- * Sending Trace Data
12 traceLog
10 traceLog
13 , traceLogFmt
11 , traceLogFmt
@@ -28,21 +26,23 @@ module Control.Distributed.Process.Management.Internal.Trace.Primitives
28 , withRegisteredTracer
26 , withRegisteredTracer
29 ) where
27 ) where
30
28
31−import Control.Applicative
29+import Control.Applicative ((<$>))
32import Control.Distributed.Process.Internal.Primitives
30import Control.Distributed.Process.Internal.Primitives
33 ( whereis
31 ( whereis
34 , newChan
32 , newChan
35 , receiveChan
33 , receiveChan
36− , die
37 )
34 )
38−import Control.Distributed.Process.Management.Internal.Trace.Types
35+import Control.Distributed.Process.Management.Types
36+ ( MxEvent(..)
37+ )
38+import Control.Distributed.Process.Management.Trace.Types
39 ( TraceArg(..)
39 ( TraceArg(..)
40 , TraceFlags(..)
40 , TraceFlags(..)
41 , TraceOk(..)
41 , TraceOk(..)
42 , TraceSubject(..)
42 , TraceSubject(..)
43 , defaultTraceFlags
43 , defaultTraceFlags
44 )
44 )
45−import qualified Control.Distributed.Process.Management.Internal.Trace.Types as Tracer
45+import qualified Control.Distributed.Process.Management.Trace.Types as Tracer
46 ( traceLog
46 ( traceLog
47 , traceLogFmt
47 , traceLogFmt
48 , traceMessage
48 , traceMessage
@@ -56,7 +56,8 @@ import qualified Control.Distributed.Process.Management.Internal.Trace.Types as
56 , getCurrentTraceClient
56 , getCurrentTraceClient
57 )
57 )
58import Control.Distributed.Process.Internal.Types
58import Control.Distributed.Process.Internal.Types
59+ ( Tracer(..)
59− ( Process
60+ , Process
60 , ProcessId
61 , ProcessId
61 , LocalProcess(..)
62 , LocalProcess(..)
62 , LocalNode(localEventBus)
63 , LocalNode(localEventBus)
@@ -67,8 +68,8 @@ import Control.Distributed.Process.Serializable
67import Control.Monad.IO.Class (liftIO)
68import Control.Monad.IO.Class (liftIO)
68import Control.Monad.Reader (ask)
69import Control.Monad.Reader (ask)
69
70
71+import Data.Maybe (isJust)
70import qualified Data.Set as Set (fromList)
72import qualified Data.Set as Set (fromList)
71−import Prelude
72
73
73--------------------------------------------------------------------------------
74--------------------------------------------------------------------------------
74-- Main API --
75-- Main API --
@@ -169,11 +170,6 @@ withRegisteredTracer act = do
169 withLocalTracer $ \t -> liftIO $ Tracer.getCurrentTraceClient t sp
170 withLocalTracer $ \t -> liftIO $ Tracer.getCurrentTraceClient t sp
170 currentTracer <- receiveChan rp
171 currentTracer <- receiveChan rp
171 case currentTracer of
172 case currentTracer of
172− Nothing -> do mTP <- whereis "tracer.initial"
173+ Nothing -> do { (Just p') <- whereis "tracer.initial"; act p' }
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)"
179 (Just p) -> act p
174 (Just p) -> act p
175+
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
2 ( -- * Configuring A Remote Tracer
2 ( -- * Configuring A Remote Tracer
3 setTraceFlagsRemote
3 setTraceFlagsRemote
4 , startTraceRelay
4 , startTraceRelay
@@ -14,11 +14,11 @@ import Control.Distributed.Process.Internal.Primitives
14 , relay
14 , relay
15 , nsendRemote
15 , nsendRemote
16 )
16 )
17−import Control.Distributed.Process.Management.Internal.Trace.Types
17+import Control.Distributed.Process.Management.Trace.Types
18 ( TraceFlags(..)
18 ( TraceFlags(..)
19 , TraceOk(..)
19 , TraceOk(..)
20 )
20 )
21−import Control.Distributed.Process.Management.Internal.Trace.Primitives
21+import Control.Distributed.Process.Management.Trace.Primitives
22 ( withRegisteredTracer
22 ( withRegisteredTracer
23 , enableTrace
23 , enableTrace
24 )
24 )
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 #-}
3-- | Tracing/Debugging support - Trace Implementation
1-- | Tracing/Debugging support - Trace Implementation
4−module Control.Distributed.Process.Management.Internal.Trace.Tracer
2+module Control.Distributed.Process.Management.Trace.Tracer
5 ( -- * API for the Management Agent
3 ( -- * API for the Management Agent
6 traceController
4 traceController
7 -- * Built in tracers
5 -- * Built in tracers
@@ -11,7 +9,7 @@ module Control.Distributed.Process.Management.Internal.Trace.Tracer
11 , eventLogTracer
9 , eventLogTracer
12 ) where
10 ) where
13
11
14−import Control.Applicative
12+import Control.Applicative ((<$>))
15import Control.Concurrent.Chan (writeChan)
13import Control.Concurrent.Chan (writeChan)
16import Control.Concurrent.MVar
14import Control.Concurrent.MVar
17 ( MVar
15 ( MVar
@@ -21,7 +19,9 @@ import Control.Distributed.Process.Internal.CQueue
21 ( CQueue
19 ( CQueue
22 )
20 )
23import Control.Distributed.Process.Internal.Primitives
21import Control.Distributed.Process.Internal.Primitives
22+ ( catch
23+ , finally
24− ( die
24+ , die
25 , receiveWait
25 , receiveWait
26 , forward
26 , forward
27 , sendChan
27 , sendChan
@@ -31,18 +31,18 @@ import Control.Distributed.Process.Internal.Primitives
31 , handleMessage
31 , handleMessage
32 , matchUnknown
32 , matchUnknown
33 )
33 )
34−import Control.Distributed.Process.Management.Internal.Types
34+import Control.Distributed.Process.Management.Types
35 ( MxEvent(..)
35 ( MxEvent(..)
36 , Addressable(..)
36 , Addressable(..)
37 )
37 )
38−import Control.Distributed.Process.Management.Internal.Trace.Types
38+import Control.Distributed.Process.Management.Trace.Types
39 ( SetTrace(..)
39 ( SetTrace(..)
40 , TraceSubject(..)
40 , TraceSubject(..)
41 , TraceFlags(..)
41 , TraceFlags(..)
42 , TraceOk(..)
42 , TraceOk(..)
43 , defaultTraceFlags
43 , defaultTraceFlags
44 )
44 )
45−import Control.Distributed.Process.Management.Internal.Trace.Primitives
45+import Control.Distributed.Process.Management.Trace.Primitives
46 ( traceOn )
46 ( traceOn )
47import Control.Distributed.Process.Internal.Types
47import Control.Distributed.Process.Internal.Types
48 ( LocalNode(..)
48 ( LocalNode(..)
@@ -61,10 +61,6 @@ import Control.Distributed.Process.Internal.Types
61
61
62import Control.Monad.IO.Class (liftIO)
62import Control.Monad.IO.Class (liftIO)
63import Control.Monad.Reader (ask)
63import Control.Monad.Reader (ask)
64−import Control.Monad.Catch
65− ( catch
66− , finally
67− )
68
64
69import Data.Set (Set)
65import Data.Set (Set)
70import qualified Data.Set as Set
66import qualified Data.Set as Set
@@ -75,7 +71,6 @@ import Data.Maybe (fromMaybe)
75import Data.Time.Clock (getCurrentTime)
71import Data.Time.Clock (getCurrentTime)
76import Data.Time.Format (formatTime)
72import Data.Time.Format (formatTime)
77import Debug.Trace (traceEventIO)
73import Debug.Trace (traceEventIO)
78−import Prelude
79
74
80#if ! MIN_VERSION_base(4,6,0)
75#if ! MIN_VERSION_base(4,6,0)
81import Prelude hiding (catch)
76import Prelude hiding (catch)
@@ -91,11 +86,7 @@ import System.IO
91 , hPutStrLn
86 , hPutStrLn
92 , hSetBuffering
87 , hSetBuffering
93 )
88 )
94−#if MIN_VERSION_time(1,5,0)
95−import Data.Time.Format (defaultTimeLocale)
96−#else
97import System.Locale (defaultTimeLocale)
89import System.Locale (defaultTimeLocale)
98−#endif
99import System.Mem.Weak
90import System.Mem.Weak
100 ( Weak
91 ( Weak
101 )
92 )
@@ -153,7 +144,7 @@ systemLoggerTracer = do
153 emptyPid <- return $ (nullProcessId (localNodeId node))
144 emptyPid <- return $ (nullProcessId (localNodeId node))
154 traceMsg <- return $ NCMsg {
145 traceMsg <- return $ NCMsg {
155 ctrlMsgSender = ProcessIdentifier (emptyPid)
146 ctrlMsgSender = ProcessIdentifier (emptyPid)
156− , ctrlMsgSignal = (NamedSend "trace.logger"
147+ , ctrlMsgSignal = (NamedSend "logger"
157 (createUnencodedMessage msg))
148 (createUnencodedMessage msg))
158 }
149 }
159 liftIO $ writeChan (localCtrlChan node) traceMsg
150 liftIO $ writeChan (localCtrlChan node) traceMsg
@@ -352,3 +343,4 @@ sendTrace st ev msg = do
352sendTraceMsg :: Maybe ProcessId -> Message -> Process ()
343sendTraceMsg :: Maybe ProcessId -> Message -> Process ()
353sendTraceMsg Nothing _ = return ()
344sendTraceMsg Nothing _ = return ()
354sendTraceMsg (Just p) msg = (flip forward) p msg
345sendTraceMsg (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+27−8
@@ -1,12 +1,7 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE ExistentialQuantification #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE TypeSynonymInstances #-}
5−{-# LANGUAGE GADTs #-}
6{-# LANGUAGE DeriveGeneric #-}
1{-# LANGUAGE DeriveGeneric #-}
7
2
8-- | Tracing/Debugging support - Types
3-- | Tracing/Debugging support - Types
9−module Control.Distributed.Process.Management.Internal.Trace.Types
4+module Control.Distributed.Process.Management.Trace.Types
10 ( SetTrace(..)
5 ( SetTrace(..)
11 , TraceSubject(..)
6 , TraceSubject(..)
12 , TraceFlags(..)
7 , TraceFlags(..)
@@ -27,24 +22,38 @@ module Control.Distributed.Process.Management.Internal.Trace.Types
27 , getCurrentTraceClient
22 , getCurrentTraceClient
28 ) where
23 ) where
29
24
25+import Control.Applicative ((<$>), (<*>))
26+import Control.Distributed.Process.Internal.CQueue (enqueue)
30import Control.Distributed.Process.Internal.Types
27import Control.Distributed.Process.Internal.Types
31 ( MxEventBus(..)
28 ( MxEventBus(..)
29+ , Tracer(..)
30+ , NodeId
32 , ProcessId
31 , ProcessId
32+ , DiedReason
33+ , Message
33 , SendPort
34 , SendPort
34 , unsafeCreateUnencodedMessage
35 , unsafeCreateUnencodedMessage
35 )
36 )
36−import Control.Distributed.Process.Management.Internal.Bus
37+import Control.Distributed.Process.Management.Bus
37 ( publishEvent
38 ( publishEvent
38 )
39 )
39−import Control.Distributed.Process.Management.Internal.Types
40+import Control.Distributed.Process.Management.Types
40 ( MxEvent(..)
41 ( MxEvent(..)
42+ , Addressable(..)
41 )
43 )
42import Control.Distributed.Process.Serializable
44import Control.Distributed.Process.Serializable
43import Data.Binary
45import Data.Binary
46+import Data.Foldable (forM_)
44import Data.List (intersperse)
47import Data.List (intersperse)
45import Data.Set (Set)
48import Data.Set (Set)
49+import qualified Data.Set as Set (fromList)
46import Data.Typeable
50import Data.Typeable
47import GHC.Generics
51import GHC.Generics
52+import System.Mem.Weak (deRefWeak)
53+import Network.Transport
54+ ( ConnectionId
55+ , EndPointAddress
56+ )
48
57
49--------------------------------------------------------------------------------
58--------------------------------------------------------------------------------
50-- Types --
59-- Types --
@@ -157,3 +166,13 @@ getTraceFlags t s = publishEvent t (unsafeCreateUnencodedMessage s)
157
166
158getCurrentTraceClient :: MxEventBus -> SendPort (Maybe ProcessId) -> IO ()
167getCurrentTraceClient :: MxEventBus -> SendPort (Maybe ProcessId) -> IO ()
159getCurrentTraceClient t s = publishEvent t (unsafeCreateUnencodedMessage s)
168getCurrentTraceClient t s = publishEvent t (unsafeCreateUnencodedMessage s)
169+
170+class Traceable a where
171+ uod :: [a] -> TraceSubject
172+
173+instance Traceable ProcessId where
174+ uod = TraceProcs . Set.fromList
175+
176+instance Traceable String where
177+ uod = TraceNames . Set.fromList
178+
src/Control/Distributed/Process/Management/Internal/Types.hs → src/Control/Distributed/Process/Management/Types.hsrenamed+60−25
@@ -1,28 +1,26 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE ExistentialQuantification #-}
3−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4{-# LANGUAGE DeriveGeneric #-}
1{-# LANGUAGE DeriveGeneric #-}
5−module Control.Distributed.Process.Management.Internal.Types
2+module Control.Distributed.Process.Management.Types
6 ( MxAgentId(..)
3 ( MxAgentId(..)
4+ , MxTableId(..)
7 , MxAgentState(..)
5 , MxAgentState(..)
8 , MxAgent(..)
6 , MxAgent(..)
9 , MxAction(..)
7 , MxAction(..)
10− , ChannelSelector(..)
8+ , MxAgentStart(..)
11 , Fork
9 , Fork
12 , MxSink
10 , MxSink
13 , MxEvent(..)
11 , MxEvent(..)
14 , Addressable(..)
12 , Addressable(..)
15 ) where
13 ) where
16
14
17−import Control.Applicative (Applicative)
15+import Control.Applicative ((<$>), (<*>), Applicative)
18import Control.Concurrent.STM
16import Control.Concurrent.STM
19 ( TChan
17 ( TChan
20 )
18 )
21import Control.Distributed.Process.Internal.Types
19import Control.Distributed.Process.Internal.Types
22 ( Process
20 ( Process
23 , ProcessId
21 , ProcessId
24− , SendPortId
25 , Message
22 , Message
23+ , SendPort
26 , DiedReason
24 , DiedReason
27 , NodeId
25 , NodeId
28 )
26 )
@@ -30,9 +28,12 @@ import Control.Monad.IO.Class (MonadIO)
30import qualified Control.Monad.State as ST
28import qualified Control.Monad.State as ST
31 ( MonadState
29 ( MonadState
32 , StateT
30 , StateT
31+ , get
32+ , lift
33+ , runStateT
33 )
34 )
34−import Control.Monad.Fix (MonadFix)
35import Data.Binary
35import Data.Binary
36+import Data.Map.Strict (Map)
36import Data.Typeable (Typeable)
37import Data.Typeable (Typeable)
37import GHC.Generics
38import GHC.Generics
38import Network.Transport
39import Network.Transport
@@ -40,6 +41,8 @@ import Network.Transport
40 , EndPointAddress
41 , EndPointAddress
41 )
42 )
42
43
44+-- TODO: consider factoring out MxEvent's tracing specific constructors
45+
43-- | This is the /default/ management event, fired for various internal
46-- | This is the /default/ management event, fired for various internal
44-- events around the NT connection and Process lifecycle. All published
47-- events around the NT connection and Process lifecycle. All published
45-- events that conform to this type, are eligible for tracing - i.e.,
48-- events that conform to this type, are eligible for tracing - i.e.,
@@ -58,14 +61,8 @@ data MxEvent =
58 -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
61 -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
59 | MxSent ProcessId ProcessId Message
62 | MxSent ProcessId ProcessId Message
60 -- ^ fired whenever a message is sent from a local process
63 -- ^ fired whenever a message is sent from a local process
61− | MxSentToName String ProcessId Message
62− -- ^ fired whenever a named send occurs
63− | MxSentToPort ProcessId SendPortId Message
64− -- ^ fired whenever a sendChan occurs
65 | MxReceived ProcessId Message
64 | MxReceived ProcessId Message
66 -- ^ fired whenever a message is received by a local process
65 -- ^ fired whenever a message is received by a local process
67− | MxReceivedPort SendPortId Message
68− -- ^ fired whenever a message is received via a typed channel
69 | MxConnected ConnectionId EndPointAddress
66 | MxConnected ConnectionId EndPointAddress
70 -- ^ fired when a network-transport connection is first established
67 -- ^ fired when a network-transport connection is first established
71 | MxDisconnected ConnectionId EndPointAddress
68 | MxDisconnected ConnectionId EndPointAddress
@@ -82,8 +79,38 @@ data MxEvent =
82
79
83instance Binary MxEvent where
80instance Binary MxEvent where
84
81
85−-- | The class of things that we might be able to resolve to
82+ -- put (MxSpawned pid) = putWord8 1 >> put pid
86−-- a @ProcessId@ (or not).
83+ -- put (MxRegistered pid str) = putWord8 2 >> put pid >> put str
84+ -- put (MxUnRegistered pid str) = putWord8 3 >> put pid >> put str
85+ -- put (MxProcessDied pid res) = putWord8 4 >> put pid >> put res
86+ -- put (MxNodeDied nid res) = putWord8 5 >> put nid >> put res
87+ -- put (MxSent to fro msg) = putWord8 6 >> put to >> put fro >> put msg
88+ -- put (MxReceived pid msg) = putWord8 7 >> put pid >> put msg
89+ -- put (MxConnected cid epid) = putWord8 8 >> put cid >> put epid
90+ -- put (MxDisconnected cid epid) = putWord8 9 >> put cid >> put epid
91+ -- put (MxUser msg) = putWord8 10 >> put msg
92+ -- put (MxLog msg) = putWord8 11 >> put msg
93+ -- put (MxTraceTakeover pid) = putWord8 12 >> put pid
94+ -- put MxTraceDisable = putWord8 13
95+
96+ -- get = do
97+ -- header <- getWord8
98+ -- case header of
99+ -- 1 -> MxSpawned <$> get
100+ -- 2 -> MxRegistered <$> get <*> get
101+ -- 3 -> MxUnRegistered <$> get <*> get
102+ -- 4 -> MxProcessDied <$> get <*> get
103+ -- 5 -> MxNodeDied <$> get <*> get
104+ -- 6 -> MxSent <$> get <*> get <*> get
105+ -- 7 -> MxReceived <$> get <*> get
106+ -- 8 -> MxConnected <$> get <*> get
107+ -- 9 -> MxDisconnected <$> get <*> get
108+ -- 10 -> MxUser <$> get
109+ -- 11 -> MxLog <$> get
110+ -- 12 -> MxTraceTakeover <$> get
111+ -- 13 -> return MxTraceDisable
112+ -- _ -> error "MxEvent.get - invalid header"
113+
87class Addressable a where
114class Addressable a where
88 resolveToPid :: a -> Maybe ProcessId
115 resolveToPid :: a -> Maybe ProcessId
89
116
@@ -104,15 +131,22 @@ type Fork = (Process () -> IO ProcessId)
104newtype MxAgentId = MxAgentId { agentId :: String }
131newtype MxAgentId = MxAgentId { agentId :: String }
105 deriving (Typeable, Binary, Eq, Ord)
132 deriving (Typeable, Binary, Eq, Ord)
106
133
134+data MxTableId =
135+ MxForAgent !MxAgentId
136+ | MxForPid !ProcessId
137+ deriving (Typeable, Generic)
138+instance Binary MxTableId where
139+
107data MxAgentState s = MxAgentState
140data MxAgentState s = MxAgentState
108 {
141 {
109 mxAgentId :: !MxAgentId
142 mxAgentId :: !MxAgentId
110 , mxBus :: !(TChan Message)
143 , mxBus :: !(TChan Message)
144+ , mxSharedTable :: !ProcessId
111 , mxLocalState :: !s
145 , mxLocalState :: !s
112 }
146 }
113
147
114−-- | Monad for management agents.
148+-- | Monad for management agents, encapsulting the
115−--
149+-- agent's state and private
116newtype MxAgent s a =
150newtype MxAgent s a =
117 MxAgent
151 MxAgent
118 {
152 {
@@ -120,22 +154,23 @@ newtype MxAgent s a =
120 } deriving ( Functor
154 } deriving ( Functor
121 , Monad
155 , Monad
122 , MonadIO
156 , MonadIO
123− , MonadFix
124 , ST.MonadState (MxAgentState s)
157 , ST.MonadState (MxAgentState s)
125 , Typeable
158 , Typeable
126 , Applicative
159 , Applicative
127 )
160 )
128
161
129−data ChannelSelector = InputChan | Mailbox
162+data MxAgentStart = MxAgentStart
163+ {
164+ mxAgentTableChan :: SendPort ProcessId
165+ , mxAgentIdStart :: MxAgentId
166+ }
167+ deriving (Typeable, Generic)
168+instance Binary MxAgentStart where
130
169
131−-- | Represents the actions a management agent can take
132−-- when evaluating an /event sink/.
133−--
134data MxAction =
170data MxAction =
135 MxAgentDeactivate !String
171 MxAgentDeactivate !String
136− | MxAgentPrioritise !ChannelSelector
137 | MxAgentReady
172 | MxAgentReady
138− | MxAgentSkip
139
173
140-- | Type of a management agent's event sink.
174-- | Type of a management agent's event sink.
141type MxSink s = Message -> MxAgent s (Maybe MxAction)
175type MxSink s = Message -> MxAgent s (Maybe MxAction)
176+
src/Control/Distributed/Process/Node.hs+200−344
@@ -1,11 +1,4 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE ScopedTypeVariables #-}
4−{-# LANGUAGE RankNTypes #-}
5−{-# LANGUAGE BangPatterns #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7{-# LANGUAGE RecordWildCards #-}
1{-# LANGUAGE RecordWildCards #-}
8−{-# LANGUAGE MagicHash #-}
9
2
10-- | Local nodes
3-- | Local nodes
11--
4--
@@ -21,6 +14,10 @@ module Control.Distributed.Process.Node
21
14
22-- TODO: Calls to 'sendBinary' and co (by the NC) may stall the node controller.
15-- TODO: Calls to 'sendBinary' and co (by the NC) may stall the node controller.
23
16
17+#if ! MIN_VERSION_base(4,6,0)
18+import Prelude hiding (catch)
19+#endif
20+
24import System.IO (fixIO, hPutStrLn, stderr)
21import System.IO (fixIO, hPutStrLn, stderr)
25import System.Mem.Weak (Weak, deRefWeak)
22import System.Mem.Weak (Weak, deRefWeak)
26import qualified Data.ByteString.Lazy as BSL (fromChunks)
23import qualified Data.ByteString.Lazy as BSL (fromChunks)
@@ -28,67 +25,46 @@ import Data.Binary (decode)
28import Data.Map (Map)
25import Data.Map (Map)
29import qualified Data.Map as Map
26import qualified Data.Map as Map
30 ( empty
27 ( empty
31− , delete
32 , toList
28 , toList
33 , fromList
29 , fromList
34− , insert
30+ , filter
35− , lookup
36− , partition
37 , partitionWithKey
31 , partitionWithKey
38 , elems
32 , elems
39− , size
40 , filterWithKey
33 , filterWithKey
41 , foldlWithKey
34 , foldlWithKey
42 )
35 )
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
49import Data.Set (Set)
36import Data.Set (Set)
50import qualified Data.Set as Set
37import qualified Data.Set as Set
51 ( empty
38 ( empty
52 , insert
39 , insert
53 , delete
40 , delete
54− , map
55 , member
41 , member
56 , toList
42 , toList
57− , union
58 )
43 )
59import Data.Foldable (forM_)
44import Data.Foldable (forM_)
60import Data.Maybe (isJust, fromJust, isNothing, catMaybes)
45import Data.Maybe (isJust, fromJust, isNothing, catMaybes)
61import Data.Typeable (Typeable)
46import Data.Typeable (Typeable)
62import Control.Category ((>>>))
47import Control.Category ((>>>))
63−import Control.Applicative
48+import Control.Applicative ((<$>))
64−import Control.Monad (void, when, join)
49+import Control.Monad (void, when)
65import Control.Monad.IO.Class (MonadIO, liftIO)
50import Control.Monad.IO.Class (MonadIO, liftIO)
66import Control.Monad.State.Strict (MonadState, StateT, evalStateT, gets)
51import Control.Monad.State.Strict (MonadState, StateT, evalStateT, gets)
67import qualified Control.Monad.State.Strict as StateT (get, put)
52import qualified Control.Monad.State.Strict as StateT (get, put)
68import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask)
53import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask)
69import Control.Exception
54import Control.Exception
70 ( throwIO
55 ( throwIO
56+ , AsyncException(ThreadKilled)
71 , SomeException
57 , SomeException
72 , Exception
58 , Exception
73 , throwTo
59 , throwTo
74− , uninterruptibleMask_
75− , getMaskingState
76− , MaskingState(..)
77 )
60 )
78−import qualified Control.Exception as Exception
61+import qualified Control.Exception as Exception (Handler(..), catches, finally)
79− ( Handler(..)
80− , catch
81− , catches
82− , finally
83− )
84−import Control.Concurrent (forkIO, killThread)
62+import Control.Concurrent (forkIO, myThreadId)
85−import Control.Distributed.Process.Internal.BiMultiMap (BiMultiMap)
86−import qualified Control.Distributed.Process.Internal.BiMultiMap as BiMultiMap
87import Control.Distributed.Process.Internal.StrictMVar
63import Control.Distributed.Process.Internal.StrictMVar
88 ( newMVar
64 ( newMVar
89 , withMVar
65 , withMVar
90− , modifyMVarMasked
91 , modifyMVar
66 , modifyMVar
67+ , modifyMVar_
92 , newEmptyMVar
68 , newEmptyMVar
93 , putMVar
69 , putMVar
94 , takeMVar
70 , takeMVar
@@ -103,7 +79,6 @@ import Control.Distributed.Process.Internal.CQueue
103 , enqueue
79 , enqueue
104 , newCQueue
80 , newCQueue
105 , mkWeakCQueue
81 , mkWeakCQueue
106− , queueSize
107 )
82 )
108import qualified Network.Transport as NT
83import qualified Network.Transport as NT
109 ( Transport
84 ( Transport
@@ -115,8 +90,8 @@ import qualified Network.Transport as NT
115 , TransportError(..)
90 , TransportError(..)
116 , address
91 , address
117 , closeEndPoint
92 , closeEndPoint
118− , Connection
119 , ConnectionId
93 , ConnectionId
94+ , Connection
120 , close
95 , close
121 , EndPointAddress
96 , EndPointAddress
122 , Reliability(ReliableOrdered)
97 , Reliability(ReliableOrdered)
@@ -135,9 +110,6 @@ import Control.Distributed.Process.Internal.Types
135 , LocalNode(..)
110 , LocalNode(..)
136 , MxEventBus(..)
111 , MxEventBus(..)
137 , LocalNodeState(..)
112 , LocalNodeState(..)
138− , ValidLocalNodeState(..)
139− , withValidLocalState
140− , modifyValidLocalState
141 , LocalProcess(..)
113 , LocalProcess(..)
142 , LocalProcessState(..)
114 , LocalProcessState(..)
143 , Process(..)
115 , Process(..)
@@ -147,11 +119,9 @@ import Control.Distributed.Process.Internal.Types
147 , localPidCounter
119 , localPidCounter
148 , localPidUnique
120 , localPidUnique
149 , localProcessWithId
121 , localProcessWithId
150− , localProcesses
151 , localConnections
122 , localConnections
152 , forever'
123 , forever'
153 , MonitorRef(..)
124 , MonitorRef(..)
154− , NodeClosedException(..)
155 , ProcessMonitorNotification(..)
125 , ProcessMonitorNotification(..)
156 , NodeMonitorNotification(..)
126 , NodeMonitorNotification(..)
157 , PortMonitorNotification(..)
127 , PortMonitorNotification(..)
@@ -171,7 +141,6 @@ import Control.Distributed.Process.Internal.Types
171 , nodeOf
141 , nodeOf
172 , ProcessInfo(..)
142 , ProcessInfo(..)
173 , ProcessInfoNone(..)
143 , ProcessInfoNone(..)
174− , NodeStats(..)
175 , SendPortId(..)
144 , SendPortId(..)
176 , typedChannelWithId
145 , typedChannelWithId
177 , RegisterReply(..)
146 , RegisterReply(..)
@@ -183,40 +152,46 @@ import Control.Distributed.Process.Internal.Types
183 , firstNonReservedProcessId
152 , firstNonReservedProcessId
184 , ImplicitReconnect(WithImplicitReconnect)
153 , ImplicitReconnect(WithImplicitReconnect)
185 )
154 )
186−import Control.Distributed.Process.Management.Internal.Agent
155+import Control.Distributed.Process.Management.Agent
187 ( mxAgentController
156 ( mxAgentController
188 )
157 )
189−import Control.Distributed.Process.Management.Internal.Types
158+import qualified Control.Distributed.Process.Management.Bus as Mx
190− ( MxEvent(..)
159+ ( publishEvent
160+ )
161+import qualified Control.Distributed.Process.Management.Table as Table
162+ ( mxTableCoordinator
163+ , startTableCoordinator
191 )
164 )
192−import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Trace
165+import qualified Control.Distributed.Process.Management.Trace.Remote as Trace
193 ( remoteTable
166 ( remoteTable
194 )
167 )
195−import Control.Distributed.Process.Management.Internal.Trace.Tracer
168+import Control.Distributed.Process.Management.Trace.Tracer
196 ( defaultTracer
169 ( defaultTracer
197 )
170 )
198−import Control.Distributed.Process.Management.Internal.Trace.Types
171+import Control.Distributed.Process.Management.Trace.Types
199 ( TraceArg(..)
172 ( TraceArg(..)
200 , traceEvent
173 , traceEvent
201 , traceLogFmt
174 , traceLogFmt
202 , enableTrace
175 , enableTrace
203 )
176 )
177+import Control.Distributed.Process.Management.Types
178+ ( MxEvent(..)
179+ )
204import Control.Distributed.Process.Serializable (Serializable)
180import Control.Distributed.Process.Serializable (Serializable)
205import Control.Distributed.Process.Internal.Messaging
181import Control.Distributed.Process.Internal.Messaging
206 ( sendBinary
182 ( sendBinary
183+ , sendMessage
207 , closeImplicitReconnections
184 , closeImplicitReconnections
208 , impliesDeathOf
185 , impliesDeathOf
209 )
186 )
210import Control.Distributed.Process.Internal.Primitives
187import Control.Distributed.Process.Internal.Primitives
211 ( register
188 ( register
189+ , finally
212 , receiveWait
190 , receiveWait
213 , match
191 , match
214 , sendChan
192 , sendChan
193+ , catch
215 , unwrapMessage
194 , unwrapMessage
216− , monitor
217− , unmonitorAsync
218− , getSelfNode
219− , SayMessage(..)
220 )
195 )
221import Control.Distributed.Process.Internal.Types (SendPort, Tracer(..))
196import Control.Distributed.Process.Internal.Types (SendPort, Tracer(..))
222import qualified Control.Distributed.Process.Internal.Closure.BuiltIn as BuiltIn (remoteTable)
197import qualified Control.Distributed.Process.Internal.Closure.BuiltIn as BuiltIn (remoteTable)
@@ -225,20 +200,7 @@ import qualified Control.Distributed.Process.Internal.StrictContainerAccessors a
225 ( mapMaybe
200 ( mapMaybe
226 , mapDefault
201 , mapDefault
227 )
202 )
228−import Control.Monad.Catch (try)
229−import GHC.IO (IO(..), unsafeUnmask)
230−import GHC.Base ( maskAsyncExceptions# )
231−
232import Unsafe.Coerce
203import 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
242
204
243--------------------------------------------------------------------------------
205--------------------------------------------------------------------------------
244-- Initialization --
206-- Initialization --
@@ -262,7 +224,7 @@ newLocalNode transport rtable = do
262createBareLocalNode :: NT.EndPoint -> RemoteTable -> IO LocalNode
224createBareLocalNode :: NT.EndPoint -> RemoteTable -> IO LocalNode
263createBareLocalNode endPoint rtable = do
225createBareLocalNode endPoint rtable = do
264 unq <- randomIO
226 unq <- randomIO
265− state <- newMVar $ LocalNodeValid $ ValidLocalNodeState
227+ state <- newMVar LocalNodeState
266 { _localProcesses = Map.empty
228 { _localProcesses = Map.empty
267 , _localPidCounter = firstNonReservedProcessId
229 , _localPidCounter = firstNonReservedProcessId
268 , _localPidUnique = unq
230 , _localPidUnique = unq
@@ -324,19 +286,17 @@ startServiceProcesses node = do
324 -- before /that/ process has started - this is a totally harmless race
286 -- before /that/ process has started - this is a totally harmless race
325 -- however, so we deliberably ignore it
287 -- however, so we deliberably ignore it
326 startDefaultTracer node
288 startDefaultTracer node
289+ tableCoordinatorPid <- fork $ Table.startTableCoordinator fork
290+ runProcess node $ register Table.mxTableCoordinator tableCoordinatorPid
327 logger <- forkProcess node loop
291 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
292+ runProcess node $ register "logger" logger
334 where
293 where
294+ fork = forkProcess node
295+
335 loop = do
296 loop = do
336 receiveWait
297 receiveWait
337− [ match $ \(SayMessage time pid string) -> do
298+ [ match $ \((time, pid, string) ::(String, ProcessId, String)) -> do
338− let time' = formatTime defaultTimeLocale "%c" time
339− liftIO . hPutStrLn stderr $ time' ++ " " ++ show pid ++ ": " ++ string
299+ liftIO . hPutStrLn stderr $ time ++ " " ++ show pid ++ ": " ++ string
340 loop
300 loop
341 , match $ \((time, string) :: (String, String)) -> do
301 , match $ \((time, string) :: (String, String)) -> do
342 -- this is a 'trace' message from the local node tracer
302 -- this is a 'trace' message from the local node tracer
@@ -346,48 +306,32 @@ startServiceProcesses node = do
346 sendChan ch ()
306 sendChan ch ()
347 ]
307 ]
348
308
349−-- | Force-close a local node, killing all processes on that node.
309+-- | Force-close a local node
310+--
311+-- TODO: for now we just close the associated endpoint
350closeLocalNode :: LocalNode -> IO ()
312closeLocalNode :: LocalNode -> IO ()
351−closeLocalNode node = do
313+closeLocalNode node =
352− -- Kill processes after refilling the mvar. Otherwise, there is potential for
314+ -- TODO: close all our processes, surely!?
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').
368 NT.closeEndPoint (localEndPoint node)
315 NT.closeEndPoint (localEndPoint node)
369
316
370-- | Run a process on a local node and wait for it to finish
317-- | Run a process on a local node and wait for it to finish
371runProcess :: LocalNode -> Process () -> IO ()
318runProcess :: LocalNode -> Process () -> IO ()
372runProcess node proc = do
319runProcess node proc = do
373 done <- newEmptyMVar
320 done <- newEmptyMVar
374− -- TODO; When forkProcess inherits the masking state, protect the forked
321+ tid <- myThreadId
375− -- thread against async exceptions that could occur before 'try' is evaluated.
376− void $ forkProcess node $ try proc >>= liftIO . putMVar done
322+ void $ forkProcess node $ do
377− takeMVar done >>= either (throwIO :: SomeException -> IO a) return
323+ catch (proc `finally` liftIO (putMVar done ()))
324+ (\(ex :: SomeException) -> liftIO $ throwTo tid ex)
325+ takeMVar done
378
326
379-- | Spawn a new process on a local node
327-- | Spawn a new process on a local node
380forkProcess :: LocalNode -> Process () -> IO ProcessId
328forkProcess :: LocalNode -> Process () -> IO ProcessId
381−forkProcess node proc = do
382− ms <- getMaskingState
383− modifyMVarMasked (localState node) (startProcess ms)
329+forkProcess node proc = modifyMVar (localState node) startProcess
384 where
330 where
385− startProcess :: MaskingState
386− -> LocalNodeState
387− -> IO (LocalNodeState, ProcessId)
331+ startProcess :: LocalNodeState -> IO (LocalNodeState, ProcessId)
388− startProcess ms (LocalNodeValid vst) = do
332+ startProcess st = do
389− let lpid = LocalProcessId { lpidCounter = vst ^. localPidCounter
333+ let lpid = LocalProcessId { lpidCounter = st ^. localPidCounter
390− , lpidUnique = vst ^. localPidUnique
334+ , lpidUnique = st ^. localPidUnique
391 }
335 }
392 let pid = ProcessId { processNodeId = localNodeId node
336 let pid = ProcessId { processNodeId = localNodeId node
393 , processLocalId = lpid
337 , processLocalId = lpid
@@ -407,15 +351,9 @@ forkProcess node proc = do
407 , processThread = tid
351 , processThread = tid
408 , processNode = node
352 , processNode = node
409 }
353 }
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
354+ tid' <- forkIO $ do
417 reason <- Exception.catches
355 reason <- Exception.catches
418− (unmask $ runLocalProcess lproc proc >> return DiedNormal)
356+ (runLocalProcess lproc proc >> return DiedNormal)
419 [ (Exception.Handler (\ex@(ProcessExitException from msg) -> do
357 [ (Exception.Handler (\ex@(ProcessExitException from msg) -> do
420 mMsg <- unwrapMessage msg :: IO (Maybe String)
358 mMsg <- unwrapMessage msg :: IO (Maybe String)
421 case mMsg of
359 case mMsg of
@@ -425,12 +363,7 @@ forkProcess node proc = do
425 (return . DiedException . (show :: SomeException -> String)))]
363 (return . DiedException . (show :: SomeException -> String)))]
426
364
427 -- [Unified: Table 4, rules termination and exiting]
365 -- [Unified: Table 4, rules termination and exiting]
428− mconns <- modifyValidLocalState node (cleanupProcess pid)
366+ modifyMVar_ (localState 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−
434 writeChan (localCtrlChan node) NCMsg
367 writeChan (localCtrlChan node) NCMsg
435 { ctrlMsgSender = ProcessIdentifier pid
368 { ctrlMsgSender = ProcessIdentifier pid
436 , ctrlMsgSignal = Died (ProcessIdentifier pid) reason
369 , ctrlMsgSignal = Died (ProcessIdentifier pid) reason
@@ -445,34 +378,27 @@ forkProcess node proc = do
445 -- TODO: this doesn't look right at all - how do we know
378 -- TODO: this doesn't look right at all - how do we know
446 -- that newUnique represents a process id that is available!?
379 -- that newUnique represents a process id that is available!?
447 newUnique <- randomIO
380 newUnique <- randomIO
448− return ( LocalNodeValid
449− $ (localProcessWithId lpid ^= Just lproc)
381+ return ( (localProcessWithId lpid ^= Just lproc)
450 . (localPidCounter ^= firstNonReservedProcessId)
382 . (localPidCounter ^= firstNonReservedProcessId)
451 . (localPidUnique ^= newUnique)
383 . (localPidUnique ^= newUnique)
452− $ vst
384+ $ st
453 , pid
385 , pid
454 )
386 )
455 else
387 else
456− return ( LocalNodeValid
457− $ (localProcessWithId lpid ^= Just lproc)
388+ return ( (localProcessWithId lpid ^= Just lproc)
458 . (localPidCounter ^: (+ 1))
389 . (localPidCounter ^: (+ 1))
459− $ vst
390+ $ st
460 , pid
391 , pid
461 )
392 )
462− startProcess _ LocalNodeClosed =
463− throwIO $ NodeClosedException $ localNodeId node
464
393
465− cleanupProcess :: ProcessId
394+ cleanupProcess :: ProcessId -> LocalNodeState -> IO LocalNodeState
466− -> ValidLocalNodeState
467− -> IO (ValidLocalNodeState, [NT.Connection])
468− cleanupProcess pid vst = do
395+ cleanupProcess pid st = do
469 let pid' = ProcessIdentifier pid
396 let pid' = ProcessIdentifier pid
470− let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (vst ^. localConnections)
397+ let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (st ^. localConnections)
398+ mapM_ (NT.close . fst) (Map.elems affected)
471− return ( (localProcessWithId (processLocalId pid) ^= Nothing)
399+ return $ (localProcessWithId (processLocalId pid) ^= Nothing)
472− . (localConnections ^= unaffected)
400+ . (localConnections ^= unaffected)
473− $ vst
401+ $ st
474− , map fst $ Map.elems affected
475− )
476
402
477-- note [tracer/forkProcess races]
403-- note [tracer/forkProcess races]
478--
404--
@@ -492,7 +418,7 @@ type IncomingConnection = (NT.EndPointAddress, IncomingTarget)
492data IncomingTarget =
418data IncomingTarget =
493 Uninit
419 Uninit
494 | ToProc ProcessId (Weak (CQueue Message))
420 | ToProc ProcessId (Weak (CQueue Message))
495− | ToChan SendPortId TypedChannel
421+ | ToChan TypedChannel
496 | ToNode
422 | ToNode
497
423
498data ConnectionState = ConnectionState {
424data ConnectionState = ConnectionState {
@@ -519,7 +445,6 @@ incomingFrom addr = aux >>> DAC.mapDefault Set.empty addr
519
445
520handleIncomingMessages :: LocalNode -> IO ()
446handleIncomingMessages :: LocalNode -> IO ()
521handleIncomingMessages node = go initConnectionState
447handleIncomingMessages node = go initConnectionState
522− `Exception.catch` \(NodeClosedException _) -> return ()
523 where
448 where
524 go :: ConnectionState -> IO ()
449 go :: ConnectionState -> IO ()
525 go !st = do
450 go !st = do
@@ -534,8 +459,7 @@ handleIncomingMessages node = go initConnectionState
534 . (incomingFrom theirAddr ^: Set.insert cid)
459 . (incomingFrom theirAddr ^: Set.insert cid)
535 $ st
460 $ st
536 )
461 )
537− else invalidRequest cid st $
462+ else invalidRequest cid st
538− "attempt to connect with unsupported reliability " ++ show rel
539 NT.Received cid payload ->
463 NT.Received cid payload ->
540 case st ^. incomingAt cid of
464 case st ^. incomingAt cid of
541 Just (_, ToProc pid weakQueue) -> do
465 Just (_, ToProc pid weakQueue) -> do
@@ -547,17 +471,13 @@ handleIncomingMessages node = go initConnectionState
547 enqueue queue msg -- 'enqueue' is strict
471 enqueue queue msg -- 'enqueue' is strict
548 trace node (MxReceived pid msg)
472 trace node (MxReceived pid msg)
549 go st
473 go st
550− Just (_, ToChan chId (TypedChannel chan')) -> do
474+ Just (_, ToChan (TypedChannel chan')) -> do
551 mChan <- deRefWeak chan'
475 mChan <- deRefWeak chan'
552 -- If mChan is Nothing, the process has given up the read end of
476 -- If mChan is Nothing, the process has given up the read end of
553 -- the channel and we simply ignore the incoming message
477 -- the channel and we simply ignore the incoming message
554− forM_ mChan $ \chan -> do
478+ forM_ mChan $ \chan -> atomically $
555− msg' <- atomically $ do
556− msg <- return $! decode (BSL.fromChunks payload)
557− -- We make sure the message is fully decoded when it is enqueued
479+ -- We make sure the message is fully decoded when it is enqueued
558− writeTQueue chan msg
480+ writeTQueue chan $! decode (BSL.fromChunks payload)
559− return msg
560− trace node $ MxReceivedPort chId $ unsafeCreateUnencodedMessage msg'
561 go st
481 go st
562 Just (_, ToNode) -> do
482 Just (_, ToNode) -> do
563 let ctrlMsg = decode . BSL.fromChunks $ payload
483 let ctrlMsg = decode . BSL.fromChunks $ payload
@@ -567,47 +487,36 @@ handleIncomingMessages node = go initConnectionState
567 case decode (BSL.fromChunks payload) of
487 case decode (BSL.fromChunks payload) of
568 ProcessIdentifier pid -> do
488 ProcessIdentifier pid -> do
569 let lpid = processLocalId pid
489 let lpid = processLocalId pid
570− mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
490+ mProc <- withMVar state $ return . (^. localProcessWithId lpid)
571 case mProc of
491 case mProc of
572 Just proc ->
492 Just proc ->
573 go (incomingAt cid ^= Just (src, ToProc pid (processWeakQ proc)) $ st)
493 go (incomingAt cid ^= Just (src, ToProc pid (processWeakQ proc)) $ st)
574 Nothing ->
494 Nothing ->
575− -- incoming attempt to connect to unknown process - might
495+ invalidRequest cid st
576− -- be dead already
577− go (incomingAt cid ^= Nothing $ st)
578 SendPortIdentifier chId -> do
496 SendPortIdentifier chId -> do
579 let lcid = sendPortLocalId chId
497 let lcid = sendPortLocalId chId
580 lpid = processLocalId (sendPortProcessId chId)
498 lpid = processLocalId (sendPortProcessId chId)
581− mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
499+ mProc <- withMVar state $ return . (^. localProcessWithId lpid)
582 case mProc of
500 case mProc of
583 Just proc -> do
501 Just proc -> do
584 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
502 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
585 case mChannel of
503 case mChannel of
586 Just channel ->
504 Just channel ->
587− go (incomingAt cid ^= Just (src, ToChan chId channel) $ st)
505+ go (incomingAt cid ^= Just (src, ToChan channel) $ st)
588 Nothing ->
506 Nothing ->
589− invalidRequest cid st $
507+ invalidRequest cid st
590− "incoming attempt to connect to unknown channel of"
591− ++ " process " ++ show (sendPortProcessId chId)
592 Nothing ->
508 Nothing ->
593− -- incoming attempt to connect to channel of unknown
509+ invalidRequest cid st
594− -- process - might be dead already
595− go (incomingAt cid ^= Nothing $ st)
596 NodeIdentifier nid ->
510 NodeIdentifier nid ->
597 if nid == localNodeId node
511 if nid == localNodeId node
598 then go (incomingAt cid ^= Just (src, ToNode) $ st)
512 then go (incomingAt cid ^= Just (src, ToNode) $ st)
599− else invalidRequest cid st $
513+ 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
604 Nothing ->
514 Nothing ->
605 invalidRequest cid st
515 invalidRequest cid st
606− "message received from an unknown connection"
607 NT.ConnectionClosed cid ->
516 NT.ConnectionClosed cid ->
608 case st ^. incomingAt cid of
517 case st ^. incomingAt cid of
609 Nothing ->
518 Nothing ->
610− invalidRequest cid st "closed unknown connection"
519+ invalidRequest cid st
611 Just (src, _) -> do
520 Just (src, _) -> do
612 trace node (MxDisconnected cid src)
521 trace node (MxDisconnected cid src)
613 go ( (incomingAt cid ^= Nothing)
522 go ( (incomingAt cid ^= Nothing)
@@ -638,20 +547,19 @@ handleIncomingMessages node = go initConnectionState
638 -- and we just give up
547 -- and we just give up
639 fail "Cloud Haskell fatal error: received unexpected multicast"
548 fail "Cloud Haskell fatal error: received unexpected multicast"
640
549
641− invalidRequest :: NT.ConnectionId -> ConnectionState -> String -> IO ()
550+ invalidRequest :: NT.ConnectionId -> ConnectionState -> IO ()
642− invalidRequest cid st msg = do
551+ invalidRequest cid st = do
643 -- TODO: We should treat this as a fatal error on the part of the remote
552 -- TODO: We should treat this as a fatal error on the part of the remote
644 -- node. That is, we should report the remote node as having died, and we
553 -- node. That is, we should report the remote node as having died, and we
645 -- should close incoming connections (this requires a Transport layer
554 -- should close incoming connections (this requires a Transport layer
646 -- extension).
555 -- extension).
647− traceEventFmtIO node "" [ TraceStr $ " [network] invalid request"
556+ traceEventFmtIO node "" [(TraceStr " [network] invalid request: "),
648− ++ " (" ++ msg ++ "): "
649− , (Trace cid)
557+ (Trace cid)]
650− ]
651 go ( incomingAt cid ^= Nothing
558 go ( incomingAt cid ^= Nothing
652 $ st
559 $ st
653 )
560 )
654
561
562+ state = localState node
655 endpoint = localEndPoint node
563 endpoint = localEndPoint node
656 ctrlChan = localCtrlChan node
564 ctrlChan = localCtrlChan node
657
565
@@ -660,9 +568,8 @@ handleIncomingMessages node = go initConnectionState
660--------------------------------------------------------------------------------
568--------------------------------------------------------------------------------
661
569
662runNodeController :: LocalNode -> IO ()
570runNodeController :: LocalNode -> IO ()
663−runNodeController node =
571+runNodeController =
664− runReaderT (evalStateT (unNC nodeController) initNCState) node
572+ runReaderT (evalStateT (unNC nodeController) initNCState)
665− `Exception.catch` \(NodeClosedException _) -> return ()
666
573
667--------------------------------------------------------------------------------
574--------------------------------------------------------------------------------
668-- Internal data types --
575-- Internal data types --
@@ -670,26 +577,20 @@ runNodeController node =
670
577
671data NCState = NCState
578data NCState = NCState
672 { -- Mapping from remote processes to linked local processes
579 { -- Mapping from remote processes to linked local processes
673− _links :: !(BiMultiMap Identifier ProcessId ())
580+ _links :: !(Map Identifier (Set ProcessId))
674 -- Mapping from remote processes to monitoring local processes
581 -- Mapping from remote processes to monitoring local processes
675− , _monitors :: !(BiMultiMap Identifier ProcessId MonitorRef)
582+ , _monitors :: !(Map Identifier (Set (ProcessId, MonitorRef)))
676 -- Process registry: names and where they live, mapped to the PIDs
583 -- Process registry: names and where they live, mapped to the PIDs
677 , _registeredHere :: !(Map String ProcessId)
584 , _registeredHere :: !(Map String ProcessId)
678 , _registeredOnNodes :: !(Map ProcessId [(NodeId,Int)])
585 , _registeredOnNodes :: !(Map ProcessId [(NodeId,Int)])
679 }
586 }
680
587
681newtype NC a = NC { unNC :: StateT NCState (ReaderT LocalNode IO) a }
588newtype 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
589+ deriving (Functor, Monad, MonadIO, MonadState NCState, MonadReader LocalNode)
688− )
689
590
690initNCState :: NCState
591initNCState :: NCState
691−initNCState = NCState { _links = BiMultiMap.empty
592+initNCState = NCState { _links = Map.empty
692− , _monitors = BiMultiMap.empty
593+ , _monitors = Map.empty
693 , _registeredHere = Map.empty
594 , _registeredHere = Map.empty
694 , _registeredOnNodes = Map.empty
595 , _registeredOnNodes = Map.empty
695 }
596 }
@@ -705,33 +606,6 @@ instance Show ProcessKillException where
705 show (ProcessKillException pid reason) =
606 show (ProcessKillException pid reason) =
706 "killed-by=" ++ show pid ++ ",reason=" ++ reason
607 "killed-by=" ++ show pid ++ ",reason=" ++ reason
707
608
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−
735--------------------------------------------------------------------------------
609--------------------------------------------------------------------------------
736-- Tracing/Debugging --
610-- Tracing/Debugging --
737--------------------------------------------------------------------------------
611--------------------------------------------------------------------------------
@@ -774,7 +648,11 @@ nodeController = do
774 -- [Unified: Table 7, rule nc_forward]
648 -- [Unified: Table 7, rule nc_forward]
775 case destNid (ctrlMsgSignal msg) of
649 case destNid (ctrlMsgSignal msg) of
776 Just nid' | nid' /= localNodeId node ->
650 Just nid' | nid' /= localNodeId node ->
777− ncSendToNode nid' msg
651+ liftIO $ sendBinary node
652+ (ctrlMsgSender msg)
653+ (NodeIdentifier nid')
654+ WithImplicitReconnect
655+ msg
778 _ ->
656 _ ->
779 return ()
657 return ()
780
658
@@ -797,8 +675,6 @@ nodeController = do
797 ncEffectWhereIs from label
675 ncEffectWhereIs from label
798 NCMsg _ (NamedSend label msg') ->
676 NCMsg _ (NamedSend label msg') ->
799 ncEffectNamedSend label msg'
677 ncEffectNamedSend label msg'
800− NCMsg _ (UnreliableSend lpid msg') ->
801− ncEffectLocalSend node (ProcessId (localNodeId node) lpid) msg'
802 NCMsg _ (LocalSend to msg') ->
678 NCMsg _ (LocalSend to msg') ->
803 ncEffectLocalSend node to msg'
679 ncEffectLocalSend node to msg'
804 NCMsg _ (LocalPortSend to msg') ->
680 NCMsg _ (LocalPortSend to msg') ->
@@ -812,9 +688,8 @@ nodeController = do
812 NCMsg _ SigShutdown ->
688 NCMsg _ SigShutdown ->
813 liftIO $ do
689 liftIO $ do
814 NT.closeEndPoint (localEndPoint node)
690 NT.closeEndPoint (localEndPoint node)
815− `Exception.finally` throwIO (NodeClosedException $ localNodeId node)
691+ `Exception.finally` throwIO ThreadKilled
816− NCMsg (ProcessIdentifier from) (GetNodeStats nid) ->
692+ -- ThreadKilled seems to make more sense than fail/error here
817− ncEffectGetNodeStats from nid
818 unexpected ->
693 unexpected ->
819 error $ "nodeController: unexpected message " ++ show unexpected
694 error $ "nodeController: unexpected message " ++ show unexpected
820
695
@@ -832,18 +707,22 @@ ncEffectMonitor from them mRef = do
832 case (shouldLink, isLocal node (ProcessIdentifier from)) of
707 case (shouldLink, isLocal node (ProcessIdentifier from)) of
833 (True, _) -> -- [Unified: first rule]
708 (True, _) -> -- [Unified: first rule]
834 case mRef of
709 case mRef of
835− Just ref -> modify' $ monitors ^: BiMultiMap.insert them from ref
710+ Just ref -> modify' $ monitorsFor them ^: Set.insert (from, ref)
836− Nothing -> modify' $ links ^: BiMultiMap.insert them from ()
711+ Nothing -> modify' $ linksFor them ^: Set.insert from
837 (False, True) -> -- [Unified: second rule]
712 (False, True) -> -- [Unified: second rule]
838 notifyDied from them DiedUnknownId mRef
713 notifyDied from them DiedUnknownId mRef
839 (False, False) -> -- [Unified: third rule]
714 (False, False) -> -- [Unified: third rule]
840 -- TODO: this is the right sender according to the Unified semantics,
715 -- TODO: this is the right sender according to the Unified semantics,
841 -- but perhaps having 'them' as the sender would make more sense
716 -- but perhaps having 'them' as the sender would make more sense
842 -- (see also: notifyDied)
717 -- (see also: notifyDied)
718+ liftIO $ sendBinary node
719+ (NodeIdentifier $ localNodeId node)
843− ncSendToNode (processNodeId from) $ NCMsg
720+ (NodeIdentifier $ processNodeId from)
721+ WithImplicitReconnect
722+ NCMsg
844− { ctrlMsgSender = NodeIdentifier (localNodeId node)
723+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
845− , ctrlMsgSignal = Died them DiedUnknownId
724+ , ctrlMsgSignal = Died them DiedUnknownId
846− }
725+ }
847
726
848-- [Unified: Table 11]
727-- [Unified: Table 11]
849ncEffectUnlink :: ProcessId -> Identifier -> NC ()
728ncEffectUnlink :: ProcessId -> Identifier -> NC ()
@@ -857,7 +736,7 @@ ncEffectUnlink from them = do
857 postAsMessage from $ DidUnlinkNode nid
736 postAsMessage from $ DidUnlinkNode nid
858 SendPortIdentifier cid ->
737 SendPortIdentifier cid ->
859 postAsMessage from $ DidUnlinkPort cid
738 postAsMessage from $ DidUnlinkPort cid
860− modify' $ links ^: BiMultiMap.delete them from ()
739+ modify' $ linksFor them ^: Set.delete from
861
740
862-- [Unified: Table 11]
741-- [Unified: Table 11]
863ncEffectUnmonitor :: ProcessId -> MonitorRef -> NC ()
742ncEffectUnmonitor :: ProcessId -> MonitorRef -> NC ()
@@ -865,7 +744,7 @@ ncEffectUnmonitor from ref = do
865 node <- ask
744 node <- ask
866 when (isLocal node (ProcessIdentifier from)) $
745 when (isLocal node (ProcessIdentifier from)) $
867 postAsMessage from $ DidUnmonitor ref
746 postAsMessage from $ DidUnmonitor ref
868− modify' $ monitors ^: BiMultiMap.delete (monitorRefIdent ref) from ref
747+ modify' $ monitorsFor (monitorRefIdent ref) ^: Set.delete (from, ref)
869
748
870-- [Unified: Table 12]
749-- [Unified: Table 12]
871ncEffectDied :: Identifier -> DiedReason -> NC ()
750ncEffectDied :: Identifier -> DiedReason -> NC ()
@@ -880,7 +759,7 @@ ncEffectDied ident reason = do
880 let localOnly = case ident of NodeIdentifier _ -> True ; _ -> False
759 let localOnly = case ident of NodeIdentifier _ -> True ; _ -> False
881
760
882 forM_ (Map.toList affectedLinks) $ \(them, uss) ->
761 forM_ (Map.toList affectedLinks) $ \(them, uss) ->
883− forM_ uss $ \(us, _) ->
762+ forM_ uss $ \us ->
884 when (localOnly <= isLocal node (ProcessIdentifier us)) $
763 when (localOnly <= isLocal node (ProcessIdentifier us)) $
885 notifyDied us them reason Nothing
764 notifyDied us them reason Nothing
886
765
@@ -889,35 +768,9 @@ ncEffectDied ident reason = do
889 when (localOnly <= isLocal node (ProcessIdentifier us)) $
768 when (localOnly <= isLocal node (ProcessIdentifier us)) $
890 notifyDied us them reason (Just ref)
769 notifyDied us them reason (Just ref)
891
770
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')
771+ modify' $ (links ^= unaffectedLinks) . (monitors ^= unaffectedMons)
915−
772+
916− -- we now consider all labels for this identifier unregistered
917− let toDrop pid = not $ ident `impliesDeathOf` ProcessIdentifier pid
773+ modify' $ registeredHere ^: Map.filter (\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
921
774
922 remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
775 remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
923 mapM (\(pid,nidlist) ->
776 mapM (\(pid,nidlist) ->
@@ -925,15 +778,20 @@ ncEffectDied ident reason = do
925 True ->
778 True ->
926 do forM_ nidlist $ \(nid,_) ->
779 do forM_ nidlist $ \(nid,_) ->
927 when (not $ isLocal node (NodeIdentifier nid))
780 when (not $ isLocal node (NodeIdentifier nid))
928− (forwardDeath node nid)
781+ (forwardNameDeath node nid)
929 return Nothing
782 return Nothing
930 False -> return $ Just (pid,nidlist) )
783 False -> return $ Just (pid,nidlist) )
931 modify' $ registeredOnNodes ^= (Map.fromList (catMaybes remaining))
784 modify' $ registeredOnNodes ^= (Map.fromList (catMaybes remaining))
932 where
785 where
933− forwardDeath node nid = ncSendToNode nid
786+ forwardNameDeath node nid =
787+ liftIO $ sendBinary node
788+ (NodeIdentifier $ localNodeId node)
789+ (NodeIdentifier $ nid)
790+ WithImplicitReconnect
791+ NCMsg
934− NCMsg { ctrlMsgSender = NodeIdentifier (localNodeId node)
792+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
935− , ctrlMsgSignal = Died ident reason
793+ , ctrlMsgSignal = Died ident reason
936− }
794+ }
937
795
938-- [Unified: Table 13]
796-- [Unified: Table 13]
939ncEffectSpawn :: ProcessId -> Closure (Process ()) -> SpawnRef -> NC ()
797ncEffectSpawn :: ProcessId -> Closure (Process ()) -> SpawnRef -> NC ()
@@ -947,7 +805,11 @@ ncEffectSpawn pid cProc ref = do
947 Right p -> p
805 Right p -> p
948 node <- ask
806 node <- ask
949 pid' <- liftIO $ forkProcess node proc
807 pid' <- liftIO $ forkProcess node proc
950− ncSendToProcess pid $ unsafeCreateUnencodedMessage $ DidSpawn ref pid'
808+ liftIO $ sendMessage node
809+ (NodeIdentifier (localNodeId node))
810+ (ProcessIdentifier pid)
811+ WithImplicitReconnect
812+ (DidSpawn ref pid')
951
813
952-- Unified semantics does not explicitly describe how to implement 'register',
814-- Unified semantics does not explicitly describe how to implement 'register',
953-- but mentions it's "very similar to nsend" (Table 14)
815-- but mentions it's "very similar to nsend" (Table 14)
@@ -965,19 +827,17 @@ ncEffectRegister from label atnode mPid reregistration = do
965 return $ (isNothing currentVal /= reregistration) &&
827 return $ (isNothing currentVal /= reregistration) &&
966 (not (isLocal node (ProcessIdentifier thepid) ) || isvalidlocal )
828 (not (isLocal node (ProcessIdentifier thepid) ) || isvalidlocal )
967 if isLocal node (NodeIdentifier atnode)
829 if isLocal node (NodeIdentifier atnode)
968− then do when isOk $
830+ then do when (isOk) $
969 do modify' $ registeredHereFor label ^= mPid
831 do modify' $ registeredHereFor label ^= mPid
970 updateRemote node currentVal mPid
832 updateRemote node currentVal mPid
971 case mPid of
833 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)
834+ (Just p) -> liftIO $ trace node (MxRegistered p label)
977 Nothing -> liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
835 Nothing -> liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
978− newVal <- gets (^. registeredHereFor label)
836+ liftIO $ sendMessage node
979− ncSendToProcess from $ unsafeCreateUnencodedMessage $
837+ (NodeIdentifier (localNodeId node))
838+ (ProcessIdentifier from)
839+ WithImplicitReconnect
980− RegisterReply label isOk newVal
840+ (RegisterReply label isOk)
981 else let operation =
841 else let operation =
982 case reregistration of
842 case reregistration of
983 True -> flip decList
843 True -> flip decList
@@ -1007,36 +867,40 @@ ncEffectRegister from label atnode mPid reregistration = do
1007 decList (x:xs) tag = x:decList xs tag
867 decList (x:xs) tag = x:decList xs tag
1008 forward node to reg =
868 forward node to reg =
1009 when (not $ isLocal node (NodeIdentifier to)) $
869 when (not $ isLocal node (NodeIdentifier to)) $
870+ liftIO $ sendBinary node
871+ (ProcessIdentifier from)
872+ (NodeIdentifier to)
873+ WithImplicitReconnect
874+ NCMsg
1010− ncSendToNode to $ NCMsg { ctrlMsgSender = ProcessIdentifier from
875+ { ctrlMsgSender = ProcessIdentifier from
1011− , ctrlMsgSignal = reg
876+ , ctrlMsgSignal = reg
1012− }
877+ }
1013
878
1014
879
1015-- Unified semantics does not explicitly describe 'whereis'
880-- Unified semantics does not explicitly describe 'whereis'
1016ncEffectWhereIs :: ProcessId -> String -> NC ()
881ncEffectWhereIs :: ProcessId -> String -> NC ()
1017ncEffectWhereIs from label = do
882ncEffectWhereIs from label = do
883+ node <- ask
1018 mPid <- gets (^. registeredHereFor label)
884 mPid <- gets (^. registeredHereFor label)
885+ liftIO $ sendMessage node
886+ (NodeIdentifier (localNodeId node))
887+ (ProcessIdentifier from)
888+ WithImplicitReconnect
1019− ncSendToProcess from $ unsafeCreateUnencodedMessage $ WhereIsReply label mPid
889+ (WhereIsReply label mPid)
1020
890
1021-- [Unified: Table 14]
891-- [Unified: Table 14]
1022ncEffectNamedSend :: String -> Message -> NC ()
892ncEffectNamedSend :: String -> Message -> NC ()
1023ncEffectNamedSend label msg = do
893ncEffectNamedSend label msg = do
1024 mPid <- gets (^. registeredHereFor label)
894 mPid <- gets (^. registeredHereFor label)
1025 -- If mPid is Nothing, we just ignore the named send (as per Table 14)
895 -- If mPid is Nothing, we just ignore the named send (as per Table 14)
1026− forM_ mPid $ \to ->
896+ forM_ mPid $ \pid -> postMessage pid msg
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
1030
897
1031-- [Issue #DP-20]
898-- [Issue #DP-20]
1032ncEffectLocalSend :: LocalNode -> ProcessId -> Message -> NC ()
899ncEffectLocalSend :: LocalNode -> ProcessId -> Message -> NC ()
1033−ncEffectLocalSend = ncEffectLocalSendAndTrace True
900+ncEffectLocalSend node to msg =
1034−
1035−ncEffectLocalSendAndTrace :: Bool -> LocalNode -> ProcessId -> Message -> NC ()
1036−ncEffectLocalSendAndTrace shouldTrace node to msg =
1037 liftIO $ withLocalProc node to $ \p -> do
901 liftIO $ withLocalProc node to $ \p -> do
1038 enqueue (processQueue p) msg
902 enqueue (processQueue p) msg
1039− when shouldTrace $ trace node (MxReceived to msg)
903+ trace node (MxReceived to msg)
1040
904
1041-- [Issue #DP-20]
905-- [Issue #DP-20]
1042ncEffectLocalPortSend :: SendPortId -> Message -> NC ()
906ncEffectLocalPortSend :: SendPortId -> Message -> NC ()
@@ -1054,12 +918,11 @@ ncEffectLocalPortSend from msg = do
1054 -- If ch is Nothing, the process has given up the read end of
918 -- If ch is Nothing, the process has given up the read end of
1055 -- the channel and we simply ignore the incoming message - this
919 -- the channel and we simply ignore the incoming message - this
1056 ch <- deRefWeak chan'
920 ch <- deRefWeak chan'
1057− forM_ ch $ \chan -> deliverChan node from msg chan
921+ forM_ ch $ \chan -> deliverChan msg chan
1058− where deliverChan :: forall a . LocalNode -> SendPortId -> Message -> TQueue a -> IO ()
922+ where deliverChan :: forall a . Message -> TQueue a -> IO ()
1059− deliverChan n p (UnencodedMessage _ raw) chan' = do
923+ deliverChan (UnencodedMessage _ raw) chan' =
1060 atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
924 atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
1061− trace n (MxReceivedPort p $ unsafeCreateUnencodedMessage raw)
1062− deliverChan _ _ (EncodedMessage _ _) _ =
925+ deliverChan (EncodedMessage _ _) _ =
1063 -- this will not happen unless someone screws with Primitives.hs
926 -- this will not happen unless someone screws with Primitives.hs
1064 error "invalid local channel delivery"
927 error "invalid local channel delivery"
1065
928
@@ -1084,56 +947,46 @@ ncEffectGetInfo from pid =
1084 them = (ProcessIdentifier pid)
947 them = (ProcessIdentifier pid)
1085 in do
948 in do
1086 node <- ask
949 node <- ask
1087− mProc <- liftIO $ withValidLocalState node
950+ mProc <- liftIO $
1088− $ return . (^. localProcessWithId lpid)
951+ withMVar (localState node) $ return . (^. localProcessWithId lpid)
1089 case mProc of
952 case mProc of
1090 Nothing -> dispatch (isLocal node (ProcessIdentifier from))
953 Nothing -> dispatch (isLocal node (ProcessIdentifier from))
1091− from (ProcessInfoNone DiedUnknownId)
954+ from node (ProcessInfoNone DiedUnknownId)
1092− Just proc -> do
955+ Just _ -> do
1093− itsLinks <- Set.map fst . BiMultiMap.lookupBy1st them <$>
956+ itsLinks <- gets (^. linksFor them)
1094− gets (^. links)
957+ itsMons <- gets (^. monitorsFor them)
1095− itsMons <- BiMultiMap.lookupBy1st them <$> gets (^. monitors)
1096 registered <- gets (^. registeredHere)
958 registered <- gets (^. registeredHere)
1097− size <- liftIO $ queueSize $ processQueue $ proc
1098
959
1099 let reg = registeredNames registered
960 let reg = registeredNames registered
1100 dispatch (isLocal node (ProcessIdentifier from))
961 dispatch (isLocal node (ProcessIdentifier from))
1101 from
962 from
963+ node
1102 ProcessInfo {
964 ProcessInfo {
1103 infoNode = (processNodeId pid)
965 infoNode = (processNodeId pid)
1104 , infoRegisteredNames = reg
966 , infoRegisteredNames = reg
967+ -- we cannot populate this field
1105− , infoMessageQueueLength = size
968+ , infoMessageQueueLength = Nothing
1106− , infoMonitors = Set.toList itsMons
969+ , infoMonitors = Set.toList itsMons
1107− , infoLinks = Set.toList itsLinks
970+ , infoLinks = Set.toList itsLinks
1108 }
971 }
1109− where dispatch :: (Serializable a)
972+ where dispatch :: (Serializable a, Show a)
1110 => Bool
973 => Bool
1111 -> ProcessId
974 -> ProcessId
975+ -> LocalNode
1112 -> a
976 -> a
1113 -> NC ()
977 -> NC ()
1114− dispatch True dest pInfo = postAsMessage dest $ pInfo
978+ dispatch True dest _ pInfo = postAsMessage dest $ pInfo
1115− dispatch False dest pInfo =
979+ dispatch False dest node pInfo = do
1116− ncSendToProcess dest $ unsafeCreateUnencodedMessage pInfo
980+ liftIO $ sendMessage node
981+ (NodeIdentifier (localNodeId node))
982+ (ProcessIdentifier dest)
983+ WithImplicitReconnect
984+ pInfo
1117
985
1118 registeredNames = Map.foldlWithKey (\ks k v -> if v == pid
986 registeredNames = Map.foldlWithKey (\ks k v -> if v == pid
1119 then (k:ks)
987 then (k:ks)
1120 else ks) []
988 else ks) []
1121
989
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−
1137--------------------------------------------------------------------------------
990--------------------------------------------------------------------------------
1138-- Auxiliary --
991-- Auxiliary --
1139--------------------------------------------------------------------------------
992--------------------------------------------------------------------------------
@@ -1160,10 +1013,14 @@ notifyDied dest src reason mRef = do
1160 throwException dest $ PortLinkException pid reason
1013 throwException dest $ PortLinkException pid reason
1161 (False, _, _) ->
1014 (False, _, _) ->
1162 -- The change in sender comes from [Unified: Table 10]
1015 -- The change in sender comes from [Unified: Table 10]
1016+ liftIO $ sendBinary node
1017+ (NodeIdentifier $ localNodeId node)
1163− ncSendToNode (processNodeId dest) $ NCMsg
1018+ (NodeIdentifier $ processNodeId dest)
1019+ WithImplicitReconnect
1020+ NCMsg
1164− { ctrlMsgSender = NodeIdentifier (localNodeId node)
1021+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
1165− , ctrlMsgSignal = Died src reason
1022+ , ctrlMsgSignal = Died src reason
1166− }
1023+ }
1167
1024
1168-- | [Unified: Table 8]
1025-- | [Unified: Table 8]
1169destNid :: ProcessSignal -> Maybe NodeId
1026destNid :: ProcessSignal -> Maybe NodeId
@@ -1175,7 +1032,6 @@ destNid (Spawn _ _) = Nothing
1175destNid (Register _ _ _ _) = Nothing
1032destNid (Register _ _ _ _) = Nothing
1176destNid (WhereIs _) = Nothing
1033destNid (WhereIs _) = Nothing
1177destNid (NamedSend _ _) = Nothing
1034destNid (NamedSend _ _) = Nothing
1178−destNid (UnreliableSend _ _) = Nothing
1179-- We don't need to forward 'Died' signals; if monitoring/linking is setup,
1035-- We don't need to forward 'Died' signals; if monitoring/linking is setup,
1180-- then when a local process dies the monitoring/linking machinery will take
1036-- then when a local process dies the monitoring/linking machinery will take
1181-- care of notifying remote nodes
1037-- care of notifying remote nodes
@@ -1183,7 +1039,6 @@ destNid (Died _ _) = Nothing
1183destNid (Kill pid _) = Just $ processNodeId pid
1039destNid (Kill pid _) = Just $ processNodeId pid
1184destNid (Exit pid _) = Just $ processNodeId pid
1040destNid (Exit pid _) = Just $ processNodeId pid
1185destNid (GetInfo pid) = Just $ processNodeId pid
1041destNid (GetInfo pid) = Just $ processNodeId pid
1186−destNid (GetNodeStats nid) = Just nid
1187destNid (LocalSend pid _) = Just $ processNodeId pid
1042destNid (LocalSend pid _) = Just $ processNodeId pid
1188destNid (LocalPortSend cid _) = Just $ processNodeId (sendPortProcessId cid)
1043destNid (LocalPortSend cid _) = Just $ processNodeId (sendPortProcessId cid)
1189destNid (SigShutdown) = Nothing
1044destNid (SigShutdown) = Nothing
@@ -1202,7 +1057,7 @@ unClosure closure = do
1202isValidLocalIdentifier :: Identifier -> NC Bool
1057isValidLocalIdentifier :: Identifier -> NC Bool
1203isValidLocalIdentifier ident = do
1058isValidLocalIdentifier ident = do
1204 node <- ask
1059 node <- ask
1205− liftIO . withValidLocalState node $ \nSt ->
1060+ liftIO . withMVar (localState node) $ \nSt ->
1206 case ident of
1061 case ident of
1207 NodeIdentifier nid ->
1062 NodeIdentifier nid ->
1208 return $ nid == localNodeId node
1063 return $ nid == localNodeId node
@@ -1233,9 +1088,6 @@ postMessage pid msg = do
1233throwException :: Exception e => ProcessId -> e -> NC ()
1088throwException :: Exception e => ProcessId -> e -> NC ()
1234throwException pid e = do
1089throwException pid e = do
1235 node <- ask
1090 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.
1239 liftIO $ withLocalProc node pid $ \p -> throwTo (processThread p) e
1091 liftIO $ withLocalProc node pid $ \p -> throwTo (processThread p) e
1240
1092
1241withLocalProc :: LocalNode -> ProcessId -> (LocalProcess -> IO ()) -> IO ()
1093withLocalProc :: LocalNode -> ProcessId -> (LocalProcess -> IO ()) -> IO ()
@@ -1243,17 +1095,17 @@ withLocalProc node pid p =
1243 -- By [Unified: table 6, rule missing_process] messages to dead processes
1095 -- By [Unified: table 6, rule missing_process] messages to dead processes
1244 -- can silently be dropped
1096 -- can silently be dropped
1245 let lpid = processLocalId pid in do
1097 let lpid = processLocalId pid in do
1246− join $ withValidLocalState node $ \vst ->
1247− return $ forM_ (vst ^. localProcessWithId lpid) p
1098+ mProc <- withMVar (localState node) $ return . (^. localProcessWithId lpid)
1099+ forM_ mProc p
1248
1100
1249--------------------------------------------------------------------------------
1101--------------------------------------------------------------------------------
1250-- Accessors --
1102-- Accessors --
1251--------------------------------------------------------------------------------
1103--------------------------------------------------------------------------------
1252
1104
1253−links :: Accessor NCState (BiMultiMap Identifier ProcessId ())
1105+links :: Accessor NCState (Map Identifier (Set ProcessId))
1254links = accessor _links (\ls st -> st { _links = ls })
1106links = accessor _links (\ls st -> st { _links = ls })
1255
1107
1256−monitors :: Accessor NCState (BiMultiMap Identifier ProcessId MonitorRef)
1108+monitors :: Accessor NCState (Map Identifier (Set (ProcessId, MonitorRef)))
1257monitors = accessor _monitors (\ms st -> st { _monitors = ms })
1109monitors = accessor _monitors (\ms st -> st { _monitors = ms })
1258
1110
1259registeredHere :: Accessor NCState (Map String ProcessId)
1111registeredHere :: Accessor NCState (Map String ProcessId)
@@ -1262,6 +1114,12 @@ registeredHere = accessor _registeredHere (\ry st -> st { _registeredHere = ry }
1262registeredOnNodes :: Accessor NCState (Map ProcessId [(NodeId, Int)])
1114registeredOnNodes :: Accessor NCState (Map ProcessId [(NodeId, Int)])
1263registeredOnNodes = accessor _registeredOnNodes (\ry st -> st { _registeredOnNodes = ry })
1115registeredOnNodes = accessor _registeredOnNodes (\ry st -> st { _registeredOnNodes = ry })
1264
1116
1117+linksFor :: Identifier -> Accessor NCState (Set ProcessId)
1118+linksFor ident = links >>> DAC.mapDefault Set.empty ident
1119+
1120+monitorsFor :: Identifier -> Accessor NCState (Set (ProcessId, MonitorRef))
1121+monitorsFor ident = monitors >>> DAC.mapDefault Set.empty ident
1122+
1265registeredHereFor :: String -> Accessor NCState (Maybe ProcessId)
1123registeredHereFor :: String -> Accessor NCState (Maybe ProcessId)
1266registeredHereFor ident = registeredHere >>> DAC.mapMaybe ident
1124registeredHereFor ident = registeredHere >>> DAC.mapMaybe ident
1267
1125
@@ -1288,12 +1146,10 @@ registeredOnNodesFor ident = registeredOnNodes >>> DAC.mapMaybe ident
1288-- * the notifications for typed channels to that process.
1146-- * the notifications for typed channels to that process.
1289--
1147--
1290-- See https://github.com/haskell/containers/issues/14 for the bang on _v.
1148-- See https://github.com/haskell/containers/issues/14 for the bang on _v.
1291−splitNotif :: (Ord a, Ord v)
1292− => Identifier
1149+splitNotif :: Identifier
1293− -> BiMultiMap Identifier a v
1150+ -> Map Identifier a
1294− -> (Map Identifier (Set (a,v)), BiMultiMap Identifier a v)
1151+ -> (Map Identifier a, Map Identifier a)
1295−splitNotif ident =
1152+splitNotif ident = Map.partitionWithKey (\k !_v -> ident `impliesDeathOf` k)
1296− BiMultiMap.partitionWithKeyBy1st (\k !_v -> ident `impliesDeathOf` k)
1297
1153
1298--------------------------------------------------------------------------------
1154--------------------------------------------------------------------------------
1299-- Auxiliary --
1155-- 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 #-}
6module Control.Distributed.Process.Serializable
1module Control.Distributed.Process.Serializable
7 ( Serializable
2 ( Serializable
8 , encodeFingerprint
3 , encodeFingerprint
@@ -12,33 +7,28 @@ module Control.Distributed.Process.Serializable
12 , Fingerprint
7 , Fingerprint
13 , showFingerprint
8 , showFingerprint
14 , SerializableDict(SerializableDict)
9 , SerializableDict(SerializableDict)
15− , TypeableDict(TypeableDict)
16 ) where
10 ) where
17
11
18import Data.Binary (Binary)
12import Data.Binary (Binary)
19−
20−import Data.Typeable (Typeable, typeRepFingerprint, typeOf)
13+import Data.Typeable (Typeable(..))
21−
14+import Data.Typeable.Internal (TypeRep(TypeRep))
22import Numeric (showHex)
15import Numeric (showHex)
23import Control.Exception (throw)
16import Control.Exception (throw)
24import GHC.Fingerprint.Type (Fingerprint(..))
17import GHC.Fingerprint.Type (Fingerprint(..))
25import Data.ByteString (ByteString)
18import Data.ByteString (ByteString)
26import qualified Data.ByteString as BS
19import 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+ )
28import Foreign.Storable (pokeByteOff, peekByteOff, sizeOf)
24import Foreign.Storable (pokeByteOff, peekByteOff, sizeOf)
29import Foreign.ForeignPtr (withForeignPtr)
25import Foreign.ForeignPtr (withForeignPtr)
30−import System.IO.Unsafe (unsafePerformIO)
31
26
32-- | Reification of 'Serializable' (see "Control.Distributed.Process.Closure")
27-- | Reification of 'Serializable' (see "Control.Distributed.Process.Closure")
33data SerializableDict a where
28data SerializableDict a where
34 SerializableDict :: Serializable a => SerializableDict a
29 SerializableDict :: Serializable a => SerializableDict a
35 deriving (Typeable)
30 deriving (Typeable)
36
31
37−-- | Reification of 'Typeable'.
38−data TypeableDict a where
39− TypeableDict :: Typeable a => TypeableDict a
40− deriving (Typeable)
41−
42-- | Objects that can be sent across the network
32-- | Objects that can be sent across the network
43class (Binary a, Typeable a) => Serializable a
33class (Binary a, Typeable a) => Serializable a
44instance (Binary a, Typeable a) => Serializable a
34instance (Binary a, Typeable a) => Serializable a
@@ -55,7 +45,7 @@ decodeFingerprint :: ByteString -> Fingerprint
55decodeFingerprint bs
45decodeFingerprint bs
56 | BS.length bs /= sizeOfFingerprint =
46 | BS.length bs /= sizeOfFingerprint =
57 throw $ userError "decodeFingerprint: Invalid length"
47 throw $ userError "decodeFingerprint: Invalid length"
58− | otherwise = unsafePerformIO $ do
48+ | otherwise = BSI.inlinePerformIO $ do
59 let (fp, offset, _) = BSI.toForeignPtr bs
49 let (fp, offset, _) = BSI.toForeignPtr bs
60 withForeignPtr fp $ \p -> peekByteOff p offset
50 withForeignPtr fp $ \p -> peekByteOff p offset
61
51
@@ -65,7 +55,7 @@ sizeOfFingerprint = sizeOf (undefined :: Fingerprint)
65
55
66-- | The fingerprint of the typeRep of the argument
56-- | The fingerprint of the typeRep of the argument
67fingerprint :: Typeable a => a -> Fingerprint
57fingerprint :: Typeable a => a -> Fingerprint
68−fingerprint = typeRepFingerprint . typeOf
58+fingerprint a = let TypeRep fp _ _ = typeOf a in fp
69
59
70-- | Show fingerprint (for debugging purposes)
60-- | Show fingerprint (for debugging purposes)
71showFingerprint :: Fingerprint -> ShowS
61showFingerprint :: Fingerprint -> ShowS
src/Control/Distributed/Process/UnsafePrimitives.hs+36−122
@@ -24,32 +24,14 @@
24-- by several orders of magnitude.
24-- by several orders of magnitude.
25--
25--
26-- This module provides variants of Cloud Haskell's messaging primitives
26-- This module provides variants of Cloud Haskell's messaging primitives
27−-- ('send', 'sendChan', 'nsend' and 'wrapMessage') which do /not/ force binary
27+-- ('send', 'sendChan' and 'nsend') which do /not/ force binary serialisation in
28−-- serialisation in the local case, thereby offering superior intra-node
28+-- the local case, thereby offering superior intra-node messaging performance.
29−-- messaging performance. The /catch/ is that any evaluation problems lurking
29+-- The /catch/ is that any evaluation problems lurking within the passed data
30−-- within the passed data structure (e.g., fields set to @undefined@ and so on)
30+-- structure - e.g., fields set to @undefined@ and so on - will show up in the
31−-- will show up in the receiver rather than in the caller (as they would with
31+-- receiver rather than in the caller (as they would with the /normal/ strategy).
32−-- the /normal/ strategy).
33--
32--
34-- Use of the functions in this module can potentially change the runtime
33-- 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!
34+-- behaviour of your application. You have been warned!
53--
35--
54-- This module is exported so that you can replace the use of Cloud Haskell's
36-- This module is exported so that you can replace the use of Cloud Haskell's
55-- /safe/ messaging primitives. If you want to use both variants, then you can
37-- /safe/ messaging primitives. If you want to use both variants, then you can
@@ -62,9 +44,6 @@ module Control.Distributed.Process.UnsafePrimitives
62 send
44 send
63 , sendChan
45 , sendChan
64 , nsend
46 , nsend
65− , nsendRemote
66− , usend
67− , wrapMessage
68 ) where
47 ) where
69
48
70import Control.Distributed.Process.Internal.Messaging
49import Control.Distributed.Process.Internal.Messaging
@@ -72,15 +51,9 @@ import Control.Distributed.Process.Internal.Messaging
72 , sendBinary
51 , sendBinary
73 , sendCtrlMsg
52 , sendCtrlMsg
74 )
53 )
75−import Control.Distributed.Process.Management.Internal.Types
54+
76− ( MxEvent(..)
77− )
78−import Control.Distributed.Process.Management.Internal.Trace.Types
79− ( traceEvent
80− )
81import Control.Distributed.Process.Internal.Types
55import Control.Distributed.Process.Internal.Types
82 ( ProcessId(..)
56 ( ProcessId(..)
83− , NodeId(..)
84 , LocalNode(..)
57 , LocalNode(..)
85 , LocalProcess(..)
58 , LocalProcess(..)
86 , Process(..)
59 , Process(..)
@@ -89,112 +62,53 @@ import Control.Distributed.Process.Internal.Types
89 , Identifier(..)
62 , Identifier(..)
90 , ImplicitReconnect(..)
63 , ImplicitReconnect(..)
91 , SendPortId(..)
64 , SendPortId(..)
92− , Message
93− , createMessage
94 , sendPortProcessId
65 , sendPortProcessId
95 , unsafeCreateUnencodedMessage
66 , unsafeCreateUnencodedMessage
96 )
67 )
97import Control.Distributed.Process.Serializable (Serializable)
68import Control.Distributed.Process.Serializable (Serializable)
98
69
99−import Control.Monad.IO.Class (liftIO)
70+import Control.Monad.IO.Class (MonadIO, liftIO)
100import Control.Monad.Reader (ask)
71import Control.Monad.Reader (ask)
101
72
102-- | Named send to a process in the local registry (asynchronous)
73-- | Named send to a process in the local registry (asynchronous)
103nsend :: Serializable a => String -> a -> Process ()
74nsend :: Serializable a => String -> a -> Process ()
104−nsend label msg = do
75+nsend label msg =
105− proc <- ask
106− let us = processId proc
107− let msg' = wrapMessage msg
108− -- see [note: tracing]
109− liftIO $ traceEvent (localEventBus (processNode proc))
110− (MxSentToName label us msg')
111− sendCtrlMsg Nothing (NamedSend label msg')
76+ sendCtrlMsg Nothing (NamedSend label (unsafeCreateUnencodedMessage 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))
127
77
128-- | Send a message
78-- | Send a message
129send :: Serializable a => ProcessId -> a -> Process ()
79send :: Serializable a => ProcessId -> a -> Process ()
130send them msg = do
80send them msg = do
131 proc <- ask
81 proc <- ask
132 let node = localNodeId (processNode proc)
82 let node = localNodeId (processNode proc)
133− destNode = (processNodeId them)
83+ destNode = (processNodeId them) in do
134− us = (processId proc)
135− msg' = wrapMessage msg in do
136− -- see [note: tracing]
137− liftIO $ traceEvent (localEventBus (processNode proc))
138− (MxSent them us msg')
139− if destNode == node
84+ case destNode == node of
140− then sendCtrlMsg Nothing $ LocalSend them msg'
85+ True -> unsafeSendLocal them msg
141− else liftIO $ sendMessage (processNode proc)
86+ False -> liftIO $ sendMessage (processNode proc)
142− (ProcessIdentifier (processId proc))
87+ (ProcessIdentifier (processId proc))
143− (ProcessIdentifier them)
88+ (ProcessIdentifier them)
144− NoImplicitReconnect
89+ NoImplicitReconnect
145− msg
90+ 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−--
176
91
177-- | Send a message on a typed channel
92-- | Send a message on a typed channel
178sendChan :: Serializable a => SendPort a -> a -> Process ()
93sendChan :: Serializable a => SendPort a -> a -> Process ()
179sendChan (SendPort cid) msg = do
94sendChan (SendPort cid) msg = do
180 proc <- ask
95 proc <- ask
181− let node = processNode proc
182− pid = processId proc
183− us = localNodeId node
96+ let node = localNodeId (processNode proc)
184− them = processNodeId (sendPortProcessId cid)
97+ destNode = processNodeId (sendPortProcessId cid) in do
185− msg' = wrapMessage msg in do
98+ case destNode == node of
186− liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid msg')
187− if them == us
188− then unsafeSendChanLocal cid msg' -- NB: we wrap to P.Message !!!
99+ True -> unsafeSendChanLocal cid msg
100+ False -> do
189− else liftIO $ sendBinary node
101+ liftIO $ sendBinary (processNode proc)
190− (ProcessIdentifier pid)
102+ (ProcessIdentifier (processId proc))
191− (SendPortIdentifier cid)
103+ (SendPortIdentifier cid)
192− NoImplicitReconnect
104+ NoImplicitReconnect
193− msg
105+ msg
194− where
106+
107+unsafeSendLocal :: (Serializable a) => ProcessId -> a -> Process ()
108+unsafeSendLocal pid msg =
109+ sendCtrlMsg Nothing $ LocalSend pid (unsafeCreateUnencodedMessage msg)
110+
195− unsafeSendChanLocal :: SendPortId -> Message -> Process ()
111+unsafeSendChanLocal :: (Serializable a) => SendPortId -> a -> Process ()
112+unsafeSendChanLocal spId msg =
196− unsafeSendChanLocal p m = sendCtrlMsg Nothing $ LocalPortSend p m
113+ sendCtrlMsg Nothing $ LocalPortSend spId (unsafeCreateUnencodedMessage msg)
197
114
198−-- | Create an unencoded @Message@ for any @Serializable@ type.
199−wrapMessage :: Serializable a => a -> Message
200−wrapMessage = unsafeCreateUnencodedMessage
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 #-}
2{-# OPTIONS_GHC -Wall #-}
2{-# 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)
12import Control.Distributed.Process
3import Control.Distributed.Process
4+import Control.Distributed.Process.Closure
13import Control.Distributed.Process.Node
5import Control.Distributed.Process.Node
14
6
7+import Network.Transport (Transport)
8+import Network.Transport.TCP
9+ ( createTransportExposeInternals
10+ , defaultTCPParameters
11+ , TransportInternals(socketBetween)
12+ )
13+
15import Control.Monad
14import Control.Monad
15+import Text.Printf
16+import Data.DeriveTH
17+import Data.Binary
18+import Data.Typeable
16
19
17import Test.HUnit (Assertion, (@?=))
20import Test.HUnit (Assertion, (@?=))
18−import Test.Framework (Test)
21+import Test.Framework (Test, defaultMain)
19import Test.Framework.Providers.HUnit (testCase)
22import Test.Framework.Providers.HUnit (testCase)
20
23
21-- Tests:
24-- Tests:
@@ -42,7 +45,7 @@ recTest2 :: ReceivePort ()
42 -> SendPort String
45 -> SendPort String
43 -> ReceivePort String -> ReceivePort String
46 -> ReceivePort String -> ReceivePort String
44 -> Process ()
47 -> Process ()
45−recTest2 wait sync r1 _ = do
48+recTest2 wait sync r1 r2 = do
46 forever $ do
49 forever $ do
47 receiveChan wait
50 receiveChan wait
48 r <- receiveWait
51 r <- receiveWait
@@ -55,7 +58,7 @@ recTest3 :: ReceivePort ()
55 -> SendPort String
58 -> SendPort String
56 -> ReceivePort String -> ReceivePort String
59 -> ReceivePort String -> ReceivePort String
57 -> Process ()
60 -> Process ()
58−recTest3 wait sync r1 _ = do
61+recTest3 wait sync r1 r2 = do
59 forever $ do
62 forever $ do
60 receiveChan wait
63 receiveChan wait
61 r <- receiveWait
64 r <- receiveWait
@@ -68,7 +71,7 @@ recTest4 :: ReceivePort ()
68 -> SendPort String
71 -> SendPort String
69 -> ReceivePort String -> ReceivePort String
72 -> ReceivePort String -> ReceivePort String
70 -> Process ()
73 -> Process ()
71−recTest4 wait sync r1 _ = do
74+recTest4 wait sync r1 r2 = do
72 forever $ do
75 forever $ do
73 receiveChan wait
76 receiveChan wait
74 r <- receiveWait
77 r <- receiveWait
@@ -78,15 +81,17 @@ recTest4 wait sync r1 _ = do
78 ]
81 ]
79 sendChan sync r
82 sendChan sync r
80
83
84+
81master :: Process ()
85master :: Process ()
82master = do
86master = do
87+
83 (waits,waitr) <- newChan
88 (waits,waitr) <- newChan
84 (syncs,syncr) <- newChan
89 (syncs,syncr) <- newChan
85− let go expected = do
90+ let go expect = do
86 sendChan waits ()
91 sendChan waits ()
87 r <- receiveChan syncr
92 r <- receiveChan syncr
88− liftIO $ print (r, expected, r == expected)
93+ liftIO $ print (r,expect, r == expect)
89− liftIO $ r @?= expected
94+ liftIO $ r @?= expect
90
95
91 liftIO $ putStrLn "---- Test 1 ----"
96 liftIO $ putStrLn "---- Test 1 ----"
92 (s1,r1) <- newChan
97 (s1,r1) <- newChan
@@ -142,13 +147,22 @@ master = do
142
147
143 terminate
148 terminate
144
149
150+
145testReceive :: Transport -> RemoteTable -> Assertion
151testReceive :: Transport -> RemoteTable -> Assertion
146testReceive transport rtable = do
152testReceive transport rtable = do
147 node <- newLocalNode transport rtable
153 node <- newLocalNode transport rtable
148 runProcess node $ master
154 runProcess node $ master
149
155
150−tests :: TestTransport -> IO [Test]
156+tests :: (Transport, TransportInternals) -> RemoteTable -> [Test]
151−tests TestTransport{..} = do
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
152− let rtable = initRemoteTable
167+ let rtable = initRemoteTable
153− return
168+ defaultMain (tests transport rtable)
154− [ testCase "testReceive" (testReceive testTransport rtable) ]
distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hs → tests/TestStats.hsrenamed+34−24
@@ -1,9 +1,6 @@
1{-# LANGUAGE DeriveDataTypeable #-}
1{-# LANGUAGE DeriveDataTypeable #-}
2{-# OPTIONS_GHC -fno-warn-orphans #-}
2{-# OPTIONS_GHC -fno-warn-orphans #-}
3−module Control.Distributed.Process.Tests.Stats (tests) where
3+module Main where
4−
5−import Control.Distributed.Process.Tests.Internal.Utils
6−import Network.Transport.Test (TestTransport(..))
7
4
8import Control.Concurrent.MVar
5import Control.Concurrent.MVar
9 ( MVar
6 ( MVar
@@ -13,8 +10,15 @@ import Control.Concurrent.MVar
13 )
10 )
14import Control.Distributed.Process
11import Control.Distributed.Process
15import Control.Distributed.Process.Node
12import Control.Distributed.Process.Node
13+ ( forkProcess
14+ , newLocalNode
15+ , initRemoteTable
16+ , closeLocalNode
17+ , LocalNode)
16−import Data.Binary ()
18+import Data.Binary()
17−import Data.Typeable ()
19+import Data.Typeable()
20+import Network.Transport.TCP
21+import qualified Network.Transport as NT
18
22
19#if ! MIN_VERSION_base(4,6,0)
23#if ! MIN_VERSION_base(4,6,0)
20import Prelude hiding (catch)
24import Prelude hiding (catch)
@@ -22,14 +26,17 @@ import Prelude hiding (catch)
22
26
23import Test.Framework
27import Test.Framework
24 ( Test
28 ( Test
29+ , defaultMain
25 , testGroup
30 , testGroup
26 )
31 )
27import Test.HUnit (Assertion)
32import Test.HUnit (Assertion)
33+import Test.HUnit.Base (assertBool)
28import Test.Framework.Providers.HUnit (testCase)
34import Test.Framework.Providers.HUnit (testCase)
35+import TestUtils
29
36
30testLocalDeadProcessInfo :: TestResult (Maybe ProcessInfo) -> Process ()
37testLocalDeadProcessInfo :: TestResult (Maybe ProcessInfo) -> Process ()
31testLocalDeadProcessInfo result = do
38testLocalDeadProcessInfo result = do
32− pid <- spawnLocal $ do (_ :: String) <- expect; return ()
39+ pid <- spawnLocal $ do "finish" <- expect; return ()
33 mref <- monitor pid
40 mref <- monitor pid
34 send pid "finish"
41 send pid "finish"
35 _ <- receiveWait [
42 _ <- receiveWait [
@@ -52,10 +59,8 @@ testLocalLiveProcessInfo result = do
52 link self
59 link self
53 mRef <- monitor self
60 mRef <- monitor self
54 stash mon mRef
61 stash mon mRef
55− res <- expect
62+ "die" <- expect
56− case res of
57− "die" -> return ()
63+ return ()
58− _ -> die $ "unexpected message received: " ++ res
59
64
60 monRef <- liftIO $ takeMVar mon
65 monRef <- liftIO $ takeMVar mon
61
66
@@ -75,8 +80,8 @@ testLocalLiveProcessInfo result = do
75-- infoMessageQueueLength pInfo == Just 4 &&
80-- infoMessageQueueLength pInfo == Just 4 &&
76 infoRegisteredNames pInfo == ["foobar"]
81 infoRegisteredNames pInfo == ["foobar"]
77
82
78−testRemoteLiveProcessInfo :: TestTransport -> LocalNode -> Assertion
83+testRemoteLiveProcessInfo :: LocalNode -> Assertion
79−testRemoteLiveProcessInfo TestTransport{..} node1 = do
84+testRemoteLiveProcessInfo node1 = do
80 serverAddr <- liftIO $ newEmptyMVar :: IO (MVar ProcessId)
85 serverAddr <- liftIO $ newEmptyMVar :: IO (MVar ProcessId)
81 liftIO $ launchRemote serverAddr
86 liftIO $ launchRemote serverAddr
82 serverPid <- liftIO $ takeMVar serverAddr
87 serverPid <- liftIO $ takeMVar serverAddr
@@ -86,23 +91,21 @@ testRemoteLiveProcessInfo TestTransport{..} node1 = do
86 -- our send op shouldn't overtake link or monitor requests AFAICT
91 -- our send op shouldn't overtake link or monitor requests AFAICT
87 -- so a little table tennis should get us synchronised properly
92 -- so a little table tennis should get us synchronised properly
88 send serverPid (self, "ping")
93 send serverPid (self, "ping")
89− pong <- expect
94+ "pong" <- expect
90 pInfo <- getProcessInfo serverPid
95 pInfo <- getProcessInfo serverPid
91− stash result $ pong == "pong" && pInfo /= Nothing
96+ stash result $ pInfo /= Nothing
92 where
97 where
93 launchRemote :: MVar ProcessId -> IO ()
98 launchRemote :: MVar ProcessId -> IO ()
94 launchRemote locMV = do
99 launchRemote locMV = do
95− node2 <- liftIO $ newLocalNode testTransport initRemoteTable
100+ node2 <- liftIO $ mkNode "8082"
96 _ <- liftIO $ forkProcess node2 $ do
101 _ <- liftIO $ forkProcess node2 $ do
97 self <- getSelfPid
102 self <- getSelfPid
98 liftIO $ putMVar locMV self
103 liftIO $ putMVar locMV self
99 _ <- receiveWait [
104 _ <- receiveWait [
100 match (\(pid, "ping") -> send pid "pong")
105 match (\(pid, "ping") -> send pid "pong")
101 ]
106 ]
102− res <- expect
107+ "stop" <- expect
103− case res of
104− "stop" -> return ()
108+ return ()
105− _ -> die $ "unexpected message received: " ++ res
106 return ()
109 return ()
107
110
108 withActiveRemote :: LocalNode
111 withActiveRemote :: LocalNode
@@ -111,9 +114,8 @@ testRemoteLiveProcessInfo TestTransport{..} node1 = do
111 a <- delayedAssertion "getProcessInfo remotePid failed" n True
114 a <- delayedAssertion "getProcessInfo remotePid failed" n True
112 return a
115 return a
113
116
114−tests :: TestTransport -> IO [Test]
117+tests :: LocalNode -> IO [Test]
115−tests testtrans@TestTransport{..} = do
118+tests node1 = do
116− node1 <- newLocalNode testTransport initRemoteTable
117 return [
119 return [
118 testGroup "Process Info" [
120 testGroup "Process Info" [
119 testCase "testLocalDeadProcessInfo"
121 testCase "testLocalDeadProcessInfo"
@@ -125,5 +127,13 @@ tests testtrans@TestTransport{..} = do
125 "expected process-info to be correctly populated"
127 "expected process-info to be correctly populated"
126 node1 True testLocalLiveProcessInfo)
128 node1 True testLocalLiveProcessInfo)
127 , testCase "testRemoveLiveProcessInfo"
129 , testCase "testRemoveLiveProcessInfo"
128− (testRemoteLiveProcessInfo testtrans node1)
130+ (testRemoteLiveProcessInfo node1)
129 ] ]
131 ] ]
132+
133+statsTests :: NT.Transport -> IO [Test]
134+statsTests transport = do
135+ mkNode "8080" >>= tests >>= return
136+
137+main :: IO ()
138+main = testMain $ statsTests
139+
distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hs → tests/TestTracing.hsrenamed+31−127
@@ -1,11 +1,7 @@
1{-# LANGUAGE DeriveDataTypeable #-}
1{-# LANGUAGE DeriveDataTypeable #-}
2{-# OPTIONS_GHC -fno-warn-orphans #-}
2{-# OPTIONS_GHC -fno-warn-orphans #-}
3−module Control.Distributed.Process.Tests.Tracing (tests) where
3+module Main where
4
4
5−import Control.Distributed.Process.Tests.Internal.Utils
6−import Network.Transport.Test (TestTransport(..))
7−
8−import Control.Applicative ((<*))
9import Control.Concurrent (threadDelay)
5import Control.Concurrent (threadDelay)
10import Control.Concurrent.MVar
6import Control.Concurrent.MVar
11 ( MVar
7 ( MVar
@@ -15,18 +11,18 @@ import Control.Concurrent.MVar
15 , takeMVar
11 , takeMVar
16 )
12 )
17import Control.Distributed.Process
13import Control.Distributed.Process
18−import Control.Distributed.Process.Node
19import Control.Distributed.Process.Debug
14import Control.Distributed.Process.Debug
20import Control.Distributed.Process.Management
15import Control.Distributed.Process.Management
21 ( MxEvent(..)
16 ( MxEvent(..)
22 )
17 )
23−import qualified Control.Exception as IO (bracket)
18+import Control.Distributed.Process.Node
24−import Data.List (isPrefixOf, isSuffixOf)
19+ ( forkProcess
20+ , closeLocalNode
21+ , LocalNode)
22+import qualified Network.Transport as NT
25
23
26#if ! MIN_VERSION_base(4,6,0)
24#if ! MIN_VERSION_base(4,6,0)
27import Prelude hiding (catch, log)
25import Prelude hiding (catch, log)
28−#else
29−import Prelude hiding ((<*))
30#endif
26#endif
31
27
32import Test.Framework
28import Test.Framework
@@ -34,10 +30,7 @@ import Test.Framework
34 , testGroup
30 , testGroup
35 )
31 )
36import Test.Framework.Providers.HUnit (testCase)
32import Test.Framework.Providers.HUnit (testCase)
37−import System.Environment (getEnvironment)
33+import TestUtils
38−-- These are available in System.Environment only since base 4.7
39−import System.SetEnv (setEnv, unsetEnv)
40−
41
34
42testSpawnTracing :: TestResult Bool -> Process ()
35testSpawnTracing :: TestResult Bool -> Process ()
43testSpawnTracing result = do
36testSpawnTracing result = do
@@ -125,11 +118,9 @@ testTraceSending result = do
125 (\ev ->
118 (\ev ->
126 case ev of
119 case ev of
127 (MxSent to from msg) -> do
120 (MxSent to from msg) -> do
128− mS <- unwrapMessage msg :: Process (Maybe String)
121+ (Just s) <- unwrapMessage msg :: Process (Maybe String)
129− case mS of
130− (Just s) -> do stash res (to == pid && from == self && s == "hello there")
122+ stash res (to == pid && from == self && s == "hello there")
131− stash res (to == pid && from == self)
123+ stash res (to == pid && from == self)
132− _ -> die "failed state invariant, message type unmatched..."
133 _ ->
124 _ ->
134 return ()) $ do
125 return ()) $ do
135 send pid "hello there"
126 send pid "hello there"
@@ -235,11 +226,11 @@ testTraceLayering result = do
235 })
226 })
236 liftIO $ putMVar result' ()
227 liftIO $ putMVar result' ()
237
228
238−testRemoteTraceRelay :: TestTransport -> TestResult Bool -> Process ()
229+testRemoteTraceRelay :: TestResult Bool -> Process ()
239−testRemoteTraceRelay TestTransport{..} result =
230+testRemoteTraceRelay result =
240 let flags = defaultTraceFlags { traceSpawned = traceOn }
231 let flags = defaultTraceFlags { traceSpawned = traceOn }
241 in do
232 in do
242− node2 <- liftIO $ newLocalNode testTransport initRemoteTable
233+ node2 <- liftIO $ mkNode "8082"
243 mvNid <- liftIO $ newEmptyMVar
234 mvNid <- liftIO $ newEmptyMVar
244
235
245 -- As well as needing node2's NodeId, we want to
236 -- As well as needing node2's NodeId, we want to
@@ -248,8 +239,12 @@ testRemoteTraceRelay TestTransport{..} result =
248 -- Here we set up that relay, and then wait for a signal
239 -- Here we set up that relay, and then wait for a signal
249 -- that the tracer (on node1) has seen the expected
240 -- that the tracer (on node1) has seen the expected
250 -- MxSpawned message, at which point we're finished
241 -- 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 ())
251
247
252− pid <- splinchLogger node2 mvNid
253 nid <- liftIO $ takeMVar mvNid
248 nid <- liftIO $ takeMVar mvNid
254 mref <- monitor pid
249 mref <- monitor pid
255 observedPid <- liftIO $ newEmptyMVar
250 observedPid <- liftIO $ newEmptyMVar
@@ -270,8 +265,8 @@ testRemoteTraceRelay TestTransport{..} result =
270 stash spawnedPid p
265 stash spawnedPid p
271
266
272 -- Now we wait for (the outer) pid to exit. This won't happen until
267 -- 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
268+ -- our tracer has seen the trace event for `p' and send `p' the
274− -- message it's waiting for prior to exiting
269+ -- message its waiting for prior to exiting
275 receiveWait [
270 receiveWait [
276 matchIf (\(ProcessMonitorNotification mref' _ _) -> mref == mref')
271 matchIf (\(ProcessMonitorNotification mref' _ _) -> mref == mref')
277 (\_ -> return ())
272 (\_ -> return ())
@@ -289,99 +284,8 @@ testRemoteTraceRelay TestTransport{..} result =
289 -- and just to be polite...
284 -- and just to be polite...
290 liftIO $ closeLocalNode node2
285 liftIO $ closeLocalNode node2
291
286
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]
287+tests :: LocalNode -> IO [Test]
383−tests testtrans@TestTransport{..} = do
288+tests node1 = do
384− node1 <- newLocalNode testTransport initRemoteTable
385 -- if we execute the test cases in parallel, the
289 -- if we execute the test cases in parallel, the
386 -- various tracers will race with one another and
290 -- various tracers will race with one another and
387 -- we'll get garbage results (or worse, deadlocks)
291 -- we'll get garbage results (or worse, deadlocks)
@@ -419,13 +323,13 @@ tests testtrans@TestTransport{..} = do
419 , testCase "Remote Trace Relay"
323 , testCase "Remote Trace Relay"
420 (synchronisedAssertion
324 (synchronisedAssertion
421 "expected blah"
325 "expected blah"
422− node1 True (testRemoteTraceRelay testtrans) lock)
326+ node1 True testRemoteTraceRelay 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− ]
431 ] ]
327 ] ]
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+89
@@ -0,0 +1,89 @@
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
8+ ( ThreadId
9+ , myThreadId
10+ , forkIO
11+ )
12+import Control.Concurrent.STM
13+ ( TQueue
14+ , newTQueueIO
15+ , readTQueue
16+ , writeTQueue
17+ )
18+import Control.Concurrent.MVar
19+ ( MVar
20+ , newEmptyMVar
21+ , takeMVar
22+ , putMVar
23+ )
24+
25+import Control.Distributed.Process
26+import Control.Distributed.Process.Node
27+import Control.Distributed.Process.Serializable()
28+import Control.Exception hiding (finally)
29+import Control.Monad (forever)
30+import Control.Monad.STM (atomically)
31+import Test.HUnit (Assertion, assertFailure)
32+import Test.HUnit.Base (assertBool)
33+import Test.Framework (Test, defaultMain)
34+
35+import Network.Transport.TCP
36+import qualified Network.Transport as NT
37+
38+-- these utilities have been cribbed from distributed-process-platform
39+-- we should really find a way to share them...
40+
41+mkNode :: String -> IO LocalNode
42+mkNode port = do
43+ Right (transport1, _) <- createTransportExposeInternals
44+ "127.0.0.1" port defaultTCPParameters
45+ newLocalNode transport1 initRemoteTable
46+
47+-- | Given a @builder@ function, make and run a test suite on a single transport
48+testMain :: (NT.Transport -> IO [Test]) -> IO ()
49+testMain builder = do
50+ Right (transport, _) <- createTransportExposeInternals
51+ "127.0.0.1" "10001" defaultTCPParameters
52+ testData <- builder transport
53+ defaultMain testData
54+
55+-- | A mutable cell containing a test result.
56+type TestResult a = MVar a
57+
58+synchronisedAssertion :: (Eq a)
59+ => String
60+ -> LocalNode
61+ -> a
62+ -> (TestResult a -> Process ())
63+ -> MVar ()
64+ -> Assertion
65+synchronisedAssertion note localNode expected testProc lock = do
66+ result <- newEmptyMVar
67+ _ <- forkProcess localNode $ do
68+ acquire lock
69+ finally (testProc result)
70+ (release lock)
71+ assertComplete note result expected
72+ where acquire lock' = liftIO $ takeMVar lock'
73+ release lock' = liftIO $ putMVar lock' ()
74+
75+delayedAssertion :: (Eq a) => String -> LocalNode -> a ->
76+ (TestResult a -> Process ()) -> Assertion
77+delayedAssertion note localNode expected testProc = do
78+ result <- newEmptyMVar
79+ _ <- forkProcess localNode $ testProc result
80+ assertComplete note result expected
81+
82+assertComplete :: (Eq a) => String -> MVar a -> a -> IO ()
83+assertComplete msg mv a = do
84+ b <- takeMVar mv
85+ assertBool msg (a == b)
86+
87+stash :: TestResult a -> a -> Process ()
88+stash mvar x = liftIO $ putMVar mvar x
89+