git.iko.soy/distributed-process
on master help sign in
67 files changed+8150−3368
since splitsnapshots
unifiedsplit
.gitignore+3−13 .travis.yml+42−13 CONTRIBUTING.md+1 ChangeLog+138 LICENSE+1 Makefile−37 README.md+7−10 REPOS−4 benchmarks/Channels.hs+6−4 benchmarks/Latency.hs+7−4 benchmarks/ProcessRing.hs+29−17 benchmarks/Spawns.hs+8−4 benchmarks/Throughput.hs+8−4 distributed-process-tests/.gitignore+4 distributed-process-tests/CONTRIBUTING.md+1 distributed-process-tests/LICENSE+31 distributed-process-tests/README.md+14 distributed-process-tests/Setup.hs+2 distributed-process-tests/distributed-process-tests.cabal+158 distributed-process-tests/src/Control/Distributed/Process/Tests/CH.hs+1879 distributed-process-tests/src/Control/Distributed/Process/Tests/Closure.hs+589 distributed-process-tests/src/Control/Distributed/Process/Tests/Internal/Utils.hs+243 distributed-process-tests/src/Control/Distributed/Process/Tests/Mx.hs+542 tests/TestReceive.hs → distributed-process-tests/src/Control/Distributed/Process/Tests/Receive.hs+22−36 tests/TestStats.hs → distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hs+29−62 tests/TestTracing.hs → distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hs+159−116 distributed-process-tests/src/Network/Transport/Test.hs+12 distributed-process-tests/tests/runInMemory.hs+30 distributed-process-tests/tests/runTCP.hs+47 distributed-process.cabal+121−209 doc/semantics/CloudHaskellSemantics.tex+706 doc/semantics/Makefile+11 doc/semantics/references.bib+72 src/Control/Distributed/Process.hs+90−25 src/Control/Distributed/Process/Closure.hs+20 src/Control/Distributed/Process/Debug.hs+62−66 src/Control/Distributed/Process/Internal/BiMultiMap.hs+135 src/Control/Distributed/Process/Internal/CQueue.hs+72−15 src/Control/Distributed/Process/Internal/Closure/BuiltIn.hs+27−8 src/Control/Distributed/Process/Internal/Closure/Explicit.hs+147 src/Control/Distributed/Process/Internal/Closure/TH.hs+24−8 src/Control/Distributed/Process/Internal/Messaging.hs+63−25 src/Control/Distributed/Process/Internal/Primitives.hs+411−171 src/Control/Distributed/Process/Internal/Spawn.hs+15−18 src/Control/Distributed/Process/Internal/StrictMVar.hs+37−5 src/Control/Distributed/Process/Internal/Trace/Types.hs−294 src/Control/Distributed/Process/Internal/Types.hs+253−55 src/Control/Distributed/Process/Internal/WeakTQueue.hs+9−3 src/Control/Distributed/Process/Management.hs+509 src/Control/Distributed/Process/Management/Internal/Agent.hs+157 src/Control/Distributed/Process/Management/Internal/Bus.hs+21 src/Control/Distributed/Process/Internal/Trace/Primitives.hs → src/Control/Distributed/Process/Management/Internal/Trace/Primitives.hs+28−55 src/Control/Distributed/Process/Internal/Trace/Remote.hs → src/Control/Distributed/Process/Management/Internal/Trace/Remote.hs+6−25 src/Control/Distributed/Process/Internal/Trace/Tracer.hs → src/Control/Distributed/Process/Management/Internal/Trace/Tracer.hs+78−83 src/Control/Distributed/Process/Management/Internal/Trace/Types.hs+159 src/Control/Distributed/Process/Management/Internal/Types.hs+141 src/Control/Distributed/Process/Node.hs+413−255 src/Control/Distributed/Process/Serializable.hs+18−8 src/Control/Distributed/Process/UnsafePrimitives.hs+200 stack-ghc-7.10.3.yaml+21 stack-ghc-8.0.2.yaml+23 stack-ghc-8.2.2.yaml+21 stack-ghc-8.4.4.yaml+20 stack-nightly.yaml+26 stack.yaml+22 tests/TestCH.hs−1236 tests/TestClosure.hs−480
.gitignore+3−13
@@ -1,14 +1,4 @@
1−tags
2−TAGS
31dist/
4−\#*#
5−*~
6−*.aux
7−*.hp
8−*.hi
9−*.o
10−*.prof
11−*.ps
12−*.swp
13−cabal-dev
14−.DS_Store
2+.cabal-sandbox
3+cabal.sandbox.config
4+.stack*
.travis.yml+42−13
@@ -1,14 +1,43 @@
1−language: haskell
2−script: "make ci"
1+language: c
2+
3+sudo: false
4+
5+matrix:
6+ include:
7+ - env: ARGS="--stack-yaml stack-ghc-7.10.3.yaml"
8+ addons: {apt: {packages: [libgmp-dev]}}
9+ - env: ARGS="--stack-yaml stack-ghc-8.2.2.yaml"
10+ addons: {apt: {packages: [libgmp-dev]}}
11+ - env: ARGS="--stack-yaml stack-ghc-8.4.4.yaml"
12+ addons: {apt: {packages: [libgmp-dev]}}
13+ - env: ARGS="--stack-yaml stack-nightly.yaml --resolver nightly"
14+ addons: {apt: {packages: [libgmp-dev]}}
15+
16+cache:
17+ directories:
18+ - $HOME/.stack
19+
20+before_install:
21+- export PATH=$HOME/.local/bin:$PATH;
22+ mkdir -p ~/.local/bin;
23+ travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack';
24+ stack --version
25+
26+install:
27+- stack $ARGS setup --no-terminal;
28+ stack $ARGS build --no-terminal --only-snapshot --test --no-run-tests;
29+
30+script:
31+- export ARG='--test-arguments'
32+ export TEST_PACKAGE="distributed-process-tests:"
33+- stack ${ARGS} test $ARG='--plain -t "!Flaky"' ${TEST_PACKAGE}TestCHInMemory
34+- stack ${ARGS} test $ARG='--plain -t "!Flaky"' ${TEST_PACKAGE}TestCHInTCP
35+- stack ${ARGS} test $ARG='--plain -t "!SpawnReconnect"' ${TEST_PACKAGE}TestClosure
36+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestStats
37+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestMxInMemory
38+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestMxInTCP
39+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestTracingInMemory
40+
341notifications:
4− email:
5− recipients:
6− - cloud.haskell@gmail.com
7− irc:
8− channels:
9− - "irc.freenode.org#haskell-distributed"
10− use_notice: true
11−branches:
12− only:
13− - master
14− - development
42+ slack:
43+ secure: LbqbNjK1KiHNiQo/i/Za4vkMD9l9mhmN+PWYFBQkNvGFWffSRayRKFrTqt4znV2p7h4dY1XZFoC7T5RemBVQLq2ppZAUWxkITeu1OUlnmVLDfJLeVYGTR/fn90nP6Y5ITE7T3A07nKmWaRbKpIgFBAOjzgqaM0csscDx3z0WW18=
CONTRIBUTING.mdnew file+1
@@ -0,0 +1 @@
1+See https://github.com/haskell-distributed/cloud-haskell/blob/master/CONTRIBUTING.md.
ChangeLog+138
@@ -1,3 +1,141 @@
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+
11392013-01-27 Tim Watson <watson.timothy@gmail.com> 0.4.2
2140
3141* Improved exception handling for deferred type checked exit reasons
LICENSE+1
@@ -1,4 +1,5 @@
11Copyright Well-Typed LLP, 2011-2012
2+Copyright Tweag I/O Limited, 2015
23
34All rights reserved.
45
Makefiledeleted−37
@@ -1,37 +0,0 @@
1−# CI build
2−
3−GHC ?= $(shell which ghc)
4−CABAL ?= $(shell which cabal)
5−CABAL_DEV ?= $(shell which cabal-fav)
6−
7−BASE_GIT := git://github.com/haskell-distributed
8−REPOS=$(shell cat REPOS | sed '/^$$/d')
9−
10−.PHONY: all
11−all: dev-install
12−
13−.PHONY: dev-install
14−ifneq (,$(CABAL_DEV))
15−dev-install:
16− $(CABAL_DEV) install
17−else
18−dev-install:
19− $(error install cabal-dev to proceed)
20−endif
21−
22−.PHONY: ci
23−ci: travis-install travis-test
24−
25−.PHONY: travis-install
26−travis-install: $(REPOS)
27− $(CABAL) install --with-ghc=$(GHC) $(REPOS) --force-reinstalls
28− $(CABAL) install
29−
30−.PHONY: travis-test
31−travis-test:
32− $(CABAL) configure --enable-tests
33− $(CABAL) build
34− $(CABAL) test --show-details=always
35−
36−$(REPOS):
37− git clone $(BASE_GIT)/$@.git
README.md+7−10
@@ -1,19 +1,16 @@
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)
24
35This repository is part of Cloud Haskell.
46
57See http://haskell-distributed.github.com for documentation, user guides,
68tutorials and assistance.
79
8−### Getting Help / Raising Issues
10+## Getting Help / Raising Issues
911
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.
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.
1313
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.
14+## License
1615
17−### License
18−
19−distributed-process is made available under a BSD-3 license.
16+This package is made available under a 3-clause BSD-style license.
REPOSdeleted−4
@@ -1,4 +0,0 @@
1−rank1dynamic
2−distributed-static
3−network-transport
4−network-transport-tcp
benchmarks/Channels.hs+6−4
@@ -4,7 +4,7 @@ import Control.Monad
44import Control.Applicative
55import Control.Distributed.Process
66import Control.Distributed.Process.Node
7−import Network.Transport.TCP (createTransport, defaultTCPParameters)
7+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
88import Data.Binary (encode, decode)
99import qualified Data.ByteString.Lazy as BSL
1010
@@ -36,6 +36,8 @@ initialProcess "CLIENT" = do
3636main :: IO ()
3737main = do
3838 [role, host, port] <- getArgs
39− Right transport <- createTransport host port defaultTCPParameters
40− node <- newLocalNode transport initRemoteTable
41− runProcess node $ initialProcess role
39+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
40+ case trans of
41+ Right transport -> do node <- newLocalNode transport initRemoteTable
42+ runProcess node $ initialProcess role
43+ Left other -> error $ show other
benchmarks/Latency.hs+7−4
@@ -3,7 +3,7 @@ import Control.Monad
33import Control.Applicative
44import Control.Distributed.Process
55import Control.Distributed.Process.Node
6−import Network.Transport.TCP (createTransport, defaultTCPParameters)
6+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
77import Data.Binary (encode, decode)
88import qualified Data.ByteString.Lazy as BSL
99
@@ -31,6 +31,9 @@ initialProcess "CLIENT" = do
3131main :: IO ()
3232main = do
3333 [role, host, port] <- getArgs
34− Right transport <- createTransport host port defaultTCPParameters
35− node <- newLocalNode transport initRemoteTable
36− runProcess node $ initialProcess role
34+ trans <- createTransport
35+ (defaultTCPAddr host port) defaultTCPParameters
36+ case trans of
37+ Right transport -> do node <- newLocalNode transport initRemoteTable
38+ runProcess node $ initialProcess role
39+ Left other -> error $ show other
benchmarks/ProcessRing.hs+29−17
@@ -2,12 +2,17 @@
22
33To run the benchmarks, select a value for the ring size (sz) and
44the number of times to send a message around the ring
5+
56-}
7+
8+{-# LANGUAGE BangPatterns #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+
611import Control.Monad
712import Control.Distributed.Process hiding (catch)
813import Control.Distributed.Process.Node
9−import Control.Exception (SomeException, catch)
10−import Network.Transport.TCP (createTransport, defaultTCPParameters)
14+import Control.Exception (catch, SomeException)
15+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
1116import System.Environment
1217import System.Console.GetOpt
1318
@@ -16,6 +21,7 @@ data Options = Options
1621 , optIterations :: Int
1722 , optForward :: Bool
1823 , optParallel :: Bool
24+ , optUnsafe :: Bool
1925 } deriving Show
2026
2127initialProcess :: Options -> Process ()
@@ -23,28 +29,30 @@ initialProcess op =
2329 let ringSz = optRingSize op
2430 msgCnt = optIterations op
2531 fwd = optForward op
32+ unsafe = optUnsafe op
2633 msg = ("foobar", "baz")
2734 in do
2835 self <- getSelfPid
29− ring <- makeRing fwd ringSz self
36+ ring <- makeRing fwd unsafe ringSz self
3037 forM_ [1..msgCnt] (\_ -> send ring msg)
3138 collect msgCnt
32− where relay' pid = do
39+ where relay fsend pid = do
3340 msg <- expect :: Process (String, String)
34− send pid msg
35− relay' pid
41+ fsend pid msg
42+ relay fsend pid
3643
3744 forward' pid =
3845 receiveWait [ matchAny (\m -> forward m pid) ] >> forward' pid
3946
40− makeRing :: Bool -> Int -> ProcessId -> Process ProcessId
41− makeRing !f !n !pid
42− | n == 0 = go f pid
43− | otherwise = go f pid >>= makeRing f (n - 1)
47+ makeRing :: Bool -> Bool -> Int -> ProcessId -> Process ProcessId
48+ makeRing !f !u !n !pid
49+ | n == 0 = go f u pid
50+ | otherwise = go f u pid >>= makeRing f u (n - 1)
4451
45− go :: Bool -> ProcessId -> Process ProcessId
46− go False next = spawnLocal $ relay' next
47− go True next = spawnLocal $ forward' next
52+ go :: Bool -> Bool -> ProcessId -> Process ProcessId
53+ go False False next = spawnLocal $ relay send next
54+ go False True next = spawnLocal $ relay unsafeSend next
55+ go True _ next = spawnLocal $ forward' next
4856
4957 collect :: Int -> Process ()
5058 collect !n
@@ -63,6 +71,7 @@ defaultOptions = Options
6371 , optIterations = 100
6472 , optForward = False
6573 , optParallel = False
74+ , optUnsafe = False
6675 }
6776
6877options :: [OptDescr (Options -> Options)]
@@ -72,8 +81,11 @@ options =
7281 , Option ['f'] ["forward"]
7382 (NoArg (\opts -> opts { optForward = True }))
7483 "use `forward' instead of send - default = False"
84+ , Option ['u'] ["unsafe-send"]
85+ (NoArg (\opts -> opts { optUnsafe = True }))
86+ "use 'unsafeSend' (ignored with -f) - default = False"
7587 , Option ['p'] ["parallel"]
76− (NoArg (\opts -> opts { optForward = True }))
88+ (NoArg (\opts -> opts { optParallel = True }))
7789 "send in parallel and consume sequentially - default = False"
7890 ]
7991
@@ -98,8 +110,8 @@ main = do
98110 argv <- getArgs
99111 (opt, _) <- parseArgv argv
100112 putStrLn $ "options: " ++ (show opt)
101− Right transport <- createTransport "127.0.0.1" "8090" defaultTCPParameters
113+ Right transport <- createTransport
114+ (defaultTCPAddr "127.0.0.1" "8090" ) defaultTCPParameters
102115 node <- newLocalNode transport initRemoteTable
103− catch (runProcess node $ initialProcess opt)
116+ catch (void $ runProcess node $ initialProcess opt)
104117 (\(e :: SomeException) -> putStrLn $ "ERROR: " ++ (show e))
105−
benchmarks/Spawns.hs+8−4
@@ -1,3 +1,5 @@
1+{-# LANGUAGE BangPatterns #-}
2+
13-- | Like Throughput, but send every ping from a different process
24-- (i.e., require a lightweight connection per ping)
35import System.Environment
@@ -5,7 +7,7 @@ import Control.Monad
57import Control.Applicative
68import Control.Distributed.Process
79import Control.Distributed.Process.Node
8−import Network.Transport.TCP (createTransport, defaultTCPParameters)
10+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
911import Data.Binary (encode, decode)
1012import qualified Data.ByteString.Lazy as BSL
1113
@@ -40,6 +42,8 @@ initialProcess "CLIENT" = do
4042main :: IO ()
4143main = do
4244 [role, host, port] <- getArgs
43− Right transport <- createTransport host port defaultTCPParameters
44− node <- newLocalNode transport initRemoteTable
45− runProcess node $ initialProcess role
45+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
46+ case trans of
47+ Right transport -> do node <- newLocalNode transport initRemoteTable
48+ runProcess node $ initialProcess role
49+ Left other -> error $ show other
benchmarks/Throughput.hs+8−4
@@ -1,10 +1,12 @@
1+{-# LANGUAGE BangPatterns #-}
12{-# LANGUAGE DeriveDataTypeable #-}
3+
24import System.Environment
35import Control.Monad
46import Control.Applicative
57import Control.Distributed.Process
68import Control.Distributed.Process.Node
7−import Network.Transport.TCP (createTransport, defaultTCPParameters)
9+import Network.Transport.TCP (createTransport, defaultTCPParameters, defaultTCPAddr)
810import Data.Binary
911import qualified Data.ByteString.Lazy as BSL
1012import Data.Typeable
@@ -65,6 +67,8 @@ initialProcess "CLIENT" = do
6567main :: IO ()
6668main = do
6769 [role, host, port] <- getArgs
68− Right transport <- createTransport host port defaultTCPParameters
69− node <- newLocalNode transport initRemoteTable
70− runProcess node $ initialProcess role
70+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
71+ case trans of
72+ Right transport -> do node <- newLocalNode transport initRemoteTable
73+ runProcess node $ initialProcess role
74+ Left other -> error $ show other
distributed-process-tests/.gitignorenew file+4
@@ -0,0 +1,4 @@
1+dist/
2+.cabal-sandbox
3+cabal.sandbox.config
4+.stack*
distributed-process-tests/CONTRIBUTING.mdnew file+1
@@ -0,0 +1 @@
1+See https://github.com/haskell-distributed/cloud-haskell/blob/master/CONTRIBUTING.md.
distributed-process-tests/LICENSEnew file+31
@@ -0,0 +1,31 @@
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.mdnew file+14
@@ -0,0 +1,14 @@
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.hsnew file+2
@@ -0,0 +1,2 @@
1+import Distribution.Simple
2+main = defaultMain
distributed-process-tests/distributed-process-tests.cabalnew file+158
@@ -0,0 +1,158 @@
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.hsnew file+1879
@@ -0,0 +1,1879 @@
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.hsnew file+589
@@ -0,0 +1,589 @@
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.hsnew file+243
@@ -0,0 +1,243 @@
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.hsnew file+542
@@ -0,0 +1,542 @@
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+ ]
tests/TestReceive.hs → distributed-process-tests/src/Control/Distributed/Process/Tests/Receive.hsrenamed+22−36
@@ -1,24 +1,21 @@
1−{-# LANGUAGE TemplateHaskell, DeriveDataTypeable #-}
1+{-# LANGUAGE TemplateHaskell #-}
22{-# OPTIONS_GHC -Wall #-}
3−import Control.Distributed.Process
4−import Control.Distributed.Process.Closure
5−import Control.Distributed.Process.Node
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(..))
610
711import Network.Transport (Transport)
8−import Network.Transport.TCP
9− ( createTransportExposeInternals
10− , defaultTCPParameters
11− , TransportInternals(socketBetween)
12− )
12+import Control.Distributed.Process
13+import Control.Distributed.Process.Node
1314
1415import Control.Monad
15−import Text.Printf
16−import Data.DeriveTH
17−import Data.Binary
18−import Data.Typeable
1916
2017import Test.HUnit (Assertion, (@?=))
21−import Test.Framework (Test, defaultMain)
18+import Test.Framework (Test)
2219import Test.Framework.Providers.HUnit (testCase)
2320
2421-- Tests:
@@ -45,7 +42,7 @@ recTest2 :: ReceivePort ()
4542 -> SendPort String
4643 -> ReceivePort String -> ReceivePort String
4744 -> Process ()
48−recTest2 wait sync r1 r2 = do
45+recTest2 wait sync r1 _ = do
4946 forever $ do
5047 receiveChan wait
5148 r <- receiveWait
@@ -58,7 +55,7 @@ recTest3 :: ReceivePort ()
5855 -> SendPort String
5956 -> ReceivePort String -> ReceivePort String
6057 -> Process ()
61−recTest3 wait sync r1 r2 = do
58+recTest3 wait sync r1 _ = do
6259 forever $ do
6360 receiveChan wait
6461 r <- receiveWait
@@ -71,7 +68,7 @@ recTest4 :: ReceivePort ()
7168 -> SendPort String
7269 -> ReceivePort String -> ReceivePort String
7370 -> Process ()
74−recTest4 wait sync r1 r2 = do
71+recTest4 wait sync r1 _ = do
7572 forever $ do
7673 receiveChan wait
7774 r <- receiveWait
@@ -81,17 +78,15 @@ recTest4 wait sync r1 r2 = do
8178 ]
8279 sendChan sync r
8380
84−
8581master :: Process ()
8682master = do
87−
8883 (waits,waitr) <- newChan
8984 (syncs,syncr) <- newChan
90− let go expect = do
85+ let go expected = do
9186 sendChan waits ()
9287 r <- receiveChan syncr
93− liftIO $ print (r,expect, r == expect)
94− liftIO $ r @?= expect
88+ liftIO $ print (r, expected, r == expected)
89+ liftIO $ r @?= expected
9590
9691 liftIO $ putStrLn "---- Test 1 ----"
9792 (s1,r1) <- newChan
@@ -147,22 +142,13 @@ master = do
147142
148143 terminate
149144
150−
151145testReceive :: Transport -> RemoteTable -> Assertion
152146testReceive transport rtable = do
153147 node <- newLocalNode transport rtable
154148 runProcess node $ master
155149
156−tests :: (Transport, TransportInternals) -> RemoteTable -> [Test]
157−tests (transport, transportInternals) rtable = [
158− testCase "testReceive" (testReceive transport rtable)
159− ]
160−
161−-- NB. test doesn't work, because failure exceptions don't get
162−-- propagated. The test always claims to succeed, even if it failed.
163−
164−main :: IO ()
165−main = do
166− Right transport <- createTransportExposeInternals "127.0.0.1" "8080" defaultTCPParameters
167− let rtable = initRemoteTable
168− defaultMain (tests transport rtable)
150+tests :: TestTransport -> IO [Test]
151+tests TestTransport{..} = do
152+ let rtable = initRemoteTable
153+ return
154+ [ testCase "testReceive" (testReceive testTransport rtable) ]
tests/TestStats.hs → distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hsrenamed+29−62
@@ -1,6 +1,9 @@
11{-# LANGUAGE DeriveDataTypeable #-}
22{-# OPTIONS_GHC -fno-warn-orphans #-}
3−module Main where
3+module Control.Distributed.Process.Tests.Stats (tests) where
4+
5+import Control.Distributed.Process.Tests.Internal.Utils
6+import Network.Transport.Test (TestTransport(..))
47
58import Control.Concurrent.MVar
69 ( MVar
@@ -10,50 +13,23 @@ import Control.Concurrent.MVar
1013 )
1114import Control.Distributed.Process
1215import Control.Distributed.Process.Node
13− ( forkProcess
14− , newLocalNode
15− , initRemoteTable
16− , closeLocalNode
17− , LocalNode)
18−import Data.Binary()
19−import Data.Typeable()
20−import Network.Transport.TCP
21−import Prelude hiding (catch, log)
16+import Data.Binary ()
17+import Data.Typeable ()
18+
19+#if ! MIN_VERSION_base(4,6,0)
20+import Prelude hiding (catch)
21+#endif
22+
2223import Test.Framework
2324 ( Test
24− , defaultMain
2525 , testGroup
2626 )
2727import Test.HUnit (Assertion)
28−import Test.HUnit.Base (assertBool)
2928import Test.Framework.Providers.HUnit (testCase)
3029
31−-- these utilities have been cribbed from distributed-process-platform
32−-- we should really find a way to share them...
33−
34−-- | A mutable cell containing a test result.
35−type TestResult a = MVar a
36−
37−delayedAssertion :: (Eq a) => String -> LocalNode -> a ->
38− (TestResult a -> Process ()) -> Assertion
39−delayedAssertion note localNode expected testProc = do
40− result <- newEmptyMVar
41− _ <- forkProcess localNode $ testProc result
42− assertComplete note result expected
43−
44−assertComplete :: (Eq a) => String -> MVar a -> a -> IO ()
45−assertComplete msg mv a = do
46− b <- takeMVar mv
47− assertBool msg (a == b)
48−
49−stash :: TestResult a -> a -> Process ()
50−stash mvar x = liftIO $ putMVar mvar x
51−
52−------
53−
5430testLocalDeadProcessInfo :: TestResult (Maybe ProcessInfo) -> Process ()
5531testLocalDeadProcessInfo result = do
56− pid <- spawnLocal $ do "finish" <- expect; return ()
32+ pid <- spawnLocal $ do (_ :: String) <- expect; return ()
5733 mref <- monitor pid
5834 send pid "finish"
5935 _ <- receiveWait [
@@ -76,8 +52,10 @@ testLocalLiveProcessInfo result = do
7652 link self
7753 mRef <- monitor self
7854 stash mon mRef
79− "die" <- expect
80− return ()
55+ res <- expect
56+ case res of
57+ "die" -> return ()
58+ _ -> die $ "unexpected message received: " ++ res
8159
8260 monRef <- liftIO $ takeMVar mon
8361
@@ -97,8 +75,8 @@ testLocalLiveProcessInfo result = do
9775-- infoMessageQueueLength pInfo == Just 4 &&
9876 infoRegisteredNames pInfo == ["foobar"]
9977
100−testRemoteLiveProcessInfo :: LocalNode -> Assertion
101−testRemoteLiveProcessInfo node1 = do
78+testRemoteLiveProcessInfo :: TestTransport -> LocalNode -> Assertion
79+testRemoteLiveProcessInfo TestTransport{..} node1 = do
10280 serverAddr <- liftIO $ newEmptyMVar :: IO (MVar ProcessId)
10381 liftIO $ launchRemote serverAddr
10482 serverPid <- liftIO $ takeMVar serverAddr
@@ -108,21 +86,23 @@ testRemoteLiveProcessInfo node1 = do
10886 -- our send op shouldn't overtake link or monitor requests AFAICT
10987 -- so a little table tennis should get us synchronised properly
11088 send serverPid (self, "ping")
111− "pong" <- expect
89+ pong <- expect
11290 pInfo <- getProcessInfo serverPid
113− stash result $ pInfo /= Nothing
91+ stash result $ pong == "pong" && pInfo /= Nothing
11492 where
11593 launchRemote :: MVar ProcessId -> IO ()
11694 launchRemote locMV = do
117− node2 <- liftIO $ mkNode "8082"
95+ node2 <- liftIO $ newLocalNode testTransport initRemoteTable
11896 _ <- liftIO $ forkProcess node2 $ do
11997 self <- getSelfPid
12098 liftIO $ putMVar locMV self
12199 _ <- receiveWait [
122100 match (\(pid, "ping") -> send pid "pong")
123101 ]
124− "stop" <- expect
125− return ()
102+ res <- expect
103+ case res of
104+ "stop" -> return ()
105+ _ -> die $ "unexpected message received: " ++ res
126106 return ()
127107
128108 withActiveRemote :: LocalNode
@@ -131,8 +111,9 @@ testRemoteLiveProcessInfo node1 = do
131111 a <- delayedAssertion "getProcessInfo remotePid failed" n True
132112 return a
133113
134−tests :: LocalNode -> IO [Test]
135−tests node1 = do
114+tests :: TestTransport -> IO [Test]
115+tests testtrans@TestTransport{..} = do
116+ node1 <- newLocalNode testTransport initRemoteTable
136117 return [
137118 testGroup "Process Info" [
138119 testCase "testLocalDeadProcessInfo"
@@ -144,19 +125,5 @@ tests node1 = do
144125 "expected process-info to be correctly populated"
145126 node1 True testLocalLiveProcessInfo)
146127 , testCase "testRemoveLiveProcessInfo"
147− (testRemoteLiveProcessInfo node1)
128+ (testRemoteLiveProcessInfo testtrans node1)
148129 ] ]
149−
150−mkNode :: String -> IO LocalNode
151−mkNode port = do
152− Right (transport1, _) <- createTransportExposeInternals
153− "127.0.0.1" port defaultTCPParameters
154− newLocalNode transport1 initRemoteTable
155−
156−main :: IO ()
157−main = do
158− node1 <- mkNode "8081"
159− testData <- tests node1
160− defaultMain testData
161− closeLocalNode node1
162− return ()
tests/TestTracing.hs → distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hsrenamed+159−116
@@ -1,7 +1,11 @@
11{-# LANGUAGE DeriveDataTypeable #-}
22{-# OPTIONS_GHC -fno-warn-orphans #-}
3−module Main where
3+module Control.Distributed.Process.Tests.Tracing (tests) where
44
5+import Control.Distributed.Process.Tests.Internal.Utils
6+import Network.Transport.Test (TestTransport(..))
7+
8+import Control.Applicative ((<*))
59import Control.Concurrent (threadDelay)
610import Control.Concurrent.MVar
711 ( MVar
@@ -11,62 +15,29 @@ import Control.Concurrent.MVar
1115 , takeMVar
1216 )
1317import Control.Distributed.Process
14−import Control.Distributed.Process.Debug
1518import Control.Distributed.Process.Node
16− ( forkProcess
17− , newLocalNode
18− , initRemoteTable
19− , closeLocalNode
20− , LocalNode)
21−import Control.Exception as Ex (catch)
22−import Network.Transport.TCP
19+import Control.Distributed.Process.Debug
20+import Control.Distributed.Process.Management
21+ ( MxEvent(..)
22+ )
23+import qualified Control.Exception as IO (bracket)
24+import Data.List (isPrefixOf, isSuffixOf)
25+
26+#if ! MIN_VERSION_base(4,6,0)
2327import Prelude hiding (catch, log)
28+#else
29+import Prelude hiding ((<*))
30+#endif
31+
2432import Test.Framework
2533 ( Test
26− , defaultMain
2734 , testGroup
2835 )
29−import Test.HUnit (Assertion)
30−import Test.HUnit.Base (assertBool)
3136import Test.Framework.Providers.HUnit (testCase)
37+import System.Environment (getEnvironment)
38+-- These are available in System.Environment only since base 4.7
39+import System.SetEnv (setEnv, unsetEnv)
3240
33−import System.Environment (getEnv)
34−import System.Posix.Env
35− ( setEnv
36− )
37−
38−-- these utilities have been cribbed from distributed-process-platform
39−-- we should really find a way to share them...
40−
41−-- | A mutable cell containing a test result.
42−type TestResult a = MVar a
43−
44−delayedAssertion :: (Eq a)
45− => String
46− -> LocalNode
47− -> a
48− -> (TestResult a -> Process ())
49− -> MVar ()
50− -> Assertion
51−delayedAssertion note localNode expected testProc lock = do
52− result <- newEmptyMVar
53− _ <- forkProcess localNode $ do
54− acquire lock
55− finally (testProc result)
56− (release lock)
57− assertComplete note result expected
58− where acquire lock' = liftIO $ takeMVar lock'
59− release lock' = liftIO $ putMVar lock' ()
60−
61−assertComplete :: (Eq a) => String -> MVar a -> a -> IO ()
62−assertComplete msg mv a = do
63− b <- takeMVar mv
64− assertBool msg (a == b)
65−
66−stash :: TestResult a -> a -> Process ()
67−stash mvar x = liftIO $ putMVar mvar x
68−
69−------
7041
7142testSpawnTracing :: TestResult Bool -> Process ()
7243testSpawnTracing result = do
@@ -79,8 +50,8 @@ testSpawnTracing result = do
7950 evDied <- liftIO $ newEmptyMVar
8051 tracer <- startTracer $ \ev -> do
8152 case ev of
82− (TraceEvSpawned p) -> liftIO $ putMVar evSpawned p
83− (TraceEvDied p r) -> liftIO $ putMVar evDied (p, r)
53+ (MxSpawned p) -> liftIO $ putMVar evSpawned p
54+ (MxProcessDied p r) -> liftIO $ putMVar evDied (p, r)
8455 _ -> return ()
8556
8657 (sp, rp) <- newChan
@@ -113,7 +84,7 @@ testTraceRecvExplicitPid result = do
11384 withTracer
11485 (\ev ->
11586 case ev of
116− (TraceEvReceived pid' _) -> stash res (pid == pid')
87+ (MxReceived pid' _) -> stash res (pid == pid')
11788 _ -> return ()) $ do
11889 (sp, rp) <- newChan
11990 send pid sp
@@ -135,7 +106,7 @@ testTraceRecvNamedPid result = do
135106 withTracer
136107 (\ev ->
137108 case ev of
138− (TraceEvReceived pid' _) -> stash res (pid == pid')
109+ (MxReceived pid' _) -> stash res (pid == pid')
139110 _ -> return ()) $ do
140111 (sp, rp) <- newChan
141112 send pid sp
@@ -153,8 +124,12 @@ testTraceSending result = do
153124 withTracer
154125 (\ev ->
155126 case ev of
156− (TraceEvSent to from _) ->
157− stash res (to == pid && from == self)
127+ (MxSent to from msg) -> do
128+ mS <- unwrapMessage msg :: Process (Maybe String)
129+ case mS of
130+ (Just s) -> do stash res (to == pid && from == self && s == "hello there")
131+ stash res (to == pid && from == self)
132+ _ -> die "failed state invariant, message type unmatched..."
158133 _ ->
159134 return ()) $ do
160135 send pid "hello there"
@@ -176,7 +151,7 @@ testTraceRegistration result = do
176151 withTracer
177152 (\ev ->
178153 case ev of
179− TraceEvRegistered p s ->
154+ MxRegistered p s ->
180155 stash res (p == pid && s == "foobar")
181156 _ ->
182157 return ()) $ do
@@ -203,7 +178,7 @@ testTraceUnRegistration result = do
203178 withTracer
204179 (\ev ->
205180 case ev of
206− TraceEvUnRegistered p n -> do
181+ MxUnRegistered p n -> do
207182 stash res (p == pid && n == "foobar")
208183 send pid ()
209184 _ ->
@@ -237,21 +212,21 @@ testTraceLayering result = do
237212 withTracer
238213 (\ev ->
239214 case ev of
240− TraceEvDied _ _ -> liftIO $ putMVar died ()
241− _ -> return ())
215+ MxProcessDied _ _ -> liftIO $ putMVar died ()
216+ _ -> return ())
242217 ( do {
243218 recv <- liftIO $ newEmptyMVar
244219 ; withTracer
245220 (\ev' ->
246221 case ev' of
247− TraceEvReceived _ _ -> liftIO $ putMVar recv ()
222+ MxReceived _ _ -> liftIO $ putMVar recv ()
248223 _ -> return ())
249224 ( do {
250225 user <- liftIO $ newEmptyMVar
251226 ; withTracer
252227 (\ev'' ->
253228 case ev'' of
254− TraceEvUser _ -> liftIO $ putMVar user ()
229+ MxUser _ -> liftIO $ putMVar user ()
255230 _ -> return ())
256231 (send pid () >> (liftIO $ takeMVar user))
257232 ; liftIO $ takeMVar recv
@@ -260,11 +235,11 @@ testTraceLayering result = do
260235 })
261236 liftIO $ putMVar result' ()
262237
263−testRemoteTraceRelay :: TestResult Bool -> Process ()
264−testRemoteTraceRelay result =
238+testRemoteTraceRelay :: TestTransport -> TestResult Bool -> Process ()
239+testRemoteTraceRelay TestTransport{..} result =
265240 let flags = defaultTraceFlags { traceSpawned = traceOn }
266241 in do
267− node2 <- liftIO $ mkNode "8082"
242+ node2 <- liftIO $ newLocalNode testTransport initRemoteTable
268243 mvNid <- liftIO $ newEmptyMVar
269244
270245 -- As well as needing node2's NodeId, we want to
@@ -272,13 +247,9 @@ testRemoteTraceRelay result =
272247 -- garbage on stderr for the duration of the test run.
273248 -- Here we set up that relay, and then wait for a signal
274249 -- that the tracer (on node1) has seen the expected
275− -- TraceEvSpawned message, at which point we're finished
276− (Just log) <- whereis "logger"
277− pid <- liftIO $ forkProcess node2 $ do
278− logRelay <- spawnLocal $ relay log
279− reregister "logger" logRelay
280− getSelfNode >>= stash mvNid >> (expect :: Process ())
250+ -- MxSpawned message, at which point we're finished
281251
252+ pid <- splinchLogger node2 mvNid
282253 nid <- liftIO $ takeMVar mvNid
283254 mref <- monitor pid
284255 observedPid <- liftIO $ newEmptyMVar
@@ -289,7 +260,7 @@ testRemoteTraceRelay result =
289260 withTracer
290261 (\ev ->
291262 case ev of
292− TraceEvSpawned p -> stash observedPid p >> send pid ()
263+ MxSpawned p -> stash observedPid p >> send pid ()
293264 _ -> return ()) $ do
294265 relayPid <- startTraceRelay nid
295266 liftIO $ threadDelay 1000000
@@ -299,8 +270,8 @@ testRemoteTraceRelay result =
299270 stash spawnedPid p
300271
301272 -- Now we wait for (the outer) pid to exit. This won't happen until
302− -- our tracer has seen the trace event for `p' and send `p' the
303− -- message its waiting for prior to exiting
273+ -- our tracer has seen the trace event for `p' and sent `p' the
274+ -- message it's waiting for prior to exiting
304275 receiveWait [
305276 matchIf (\(ProcessMonitorNotification mref' _ _) -> mref == mref')
306277 (\_ -> return ())
@@ -318,71 +289,143 @@ testRemoteTraceRelay result =
318289 -- and just to be polite...
319290 liftIO $ closeLocalNode node2
320291
321−tests :: LocalNode -> IO [Test]
322−tests node1 = do
292+ where
293+ splinchLogger n2 mv = do
294+ mLog <- whereis "logger"
295+ case mLog of
296+ Nothing -> die "no logger registered"
297+ Just log' -> do liftIO $ forkProcess n2 $ do
298+ logRelay <- spawnLocal $ relay log'
299+ reregister "logger" logRelay
300+ getSelfNode >>= stash mv >> (expect :: Process ())
301+
302+
303+-- | Sets the value of an environment variable while executing the given IO
304+-- computation and restores the preceeding value upon completion.
305+withEnv :: String -> String -> IO a -> IO a
306+withEnv var val =
307+ IO.bracket (fmap (lookup var) getEnvironment <* setEnv var val)
308+ (maybe (unsetEnv var) (setEnv var))
309+ . const
310+
311+-- | Tests that one and only one interesting trace message is produced when a
312+-- given action is performed. A message is considered interesting when the given
313+-- function return @True@.
314+testSystemLoggerMsg :: TestTransport
315+ -> Process a
316+ -> (a -> String -> Bool)
317+ -> IO ()
318+testSystemLoggerMsg t action interestingMessage =
319+ withEnv "DISTRIBUTED_PROCESS_TRACE_CONSOLE" "yes" $
320+ withEnv "DISTRIBUTED_PROCESS_TRACE_FLAGS" "pdnusrl" $ do
321+ n <- newLocalNode (testTransport t) initRemoteTable
322+
323+ runProcess n $ do
324+ self <- getSelfPid
325+ reregister "trace.logger" self
326+ a <- action
327+ let interestingMessage' (_ :: String, msg) = interestingMessage a msg
328+ -- Wait for the trace message.
329+ receiveWait [ matchIf interestingMessage' $ const $ return () ]
330+ -- Only one interesting message should arrive.
331+ expectedTimeout <- receiveTimeout
332+ 100000
333+ [ matchIf interestingMessage' $ const $ return () ]
334+ case expectedTimeout of
335+ Nothing -> return ()
336+ Just _ -> die "Unexpected message arrived..."
337+
338+
339+-- | Tests that one and only one trace message is produced when a message is
340+-- received.
341+testSystemLoggerMxReceive :: TestTransport -> IO ()
342+testSystemLoggerMxReceive t = testSystemLoggerMsg t
343+ (getSelfPid >>= flip send ())
344+ (\_ msg -> "MxReceived" `isPrefixOf` msg
345+ -- discard traces of internal messages
346+ && not (":: RegisterReply" `isSuffixOf` msg)
347+ )
348+
349+-- | Tests that one and only one trace message is produced when a message is
350+-- sent.
351+testSystemLoggerMxSent :: TestTransport -> IO ()
352+testSystemLoggerMxSent t = testSystemLoggerMsg t
353+ (getSelfPid >>= flip send ())
354+ (const $ isPrefixOf "MxSent")
355+
356+-- | Tests that one and only one trace message is produced when a process dies.
357+testSystemLoggerMxProcessDied :: TestTransport -> IO ()
358+testSystemLoggerMxProcessDied t = testSystemLoggerMsg t
359+ (spawnLocal $ return ())
360+ (\pid -> isPrefixOf $ "MxProcessDied " ++ show pid)
361+
362+-- | Tests that one and only one trace message appears when a process spawns.
363+testSystemLoggerMxSpawned :: TestTransport -> IO ()
364+testSystemLoggerMxSpawned t = testSystemLoggerMsg t
365+ (spawnLocal $ return ())
366+ (\pid -> isPrefixOf $ "MxSpawned " ++ show pid)
367+
368+-- | Tests that one and only one trace message appears when a process is
369+-- registered.
370+testSystemLoggerMxRegistered :: TestTransport -> IO ()
371+testSystemLoggerMxRegistered t = testSystemLoggerMsg t
372+ (getSelfPid >>= register "a" >> getSelfPid)
373+ (\self -> isPrefixOf $ "MxRegistered " ++ show self ++ " " ++ show "a")
374+
375+-- | Tests that one and only one trace message appears when a process is
376+-- unregistered.
377+testSystemLoggerMxUnRegistered :: TestTransport -> IO ()
378+testSystemLoggerMxUnRegistered t = testSystemLoggerMsg t
379+ (getSelfPid >>= register "a" >> unregister "a" >> getSelfPid)
380+ (\self -> isPrefixOf $ "MxUnRegistered " ++ show self ++ " " ++ show "a")
381+
382+tests :: TestTransport -> IO [Test]
383+tests testtrans@TestTransport{..} = do
384+ node1 <- newLocalNode testTransport initRemoteTable
323385 -- if we execute the test cases in parallel, the
324386 -- various tracers will race with one another and
325387 -- we'll get garbage results (or worse, deadlocks)
326388 lock <- liftIO $ newMVar ()
327− enabled <- checkTraceEnabled
328− case enabled of
329− True ->
330− return [
331− testGroup "Tracing" [
389+ return [
390+ testGroup "Tracing" [
332391 testCase "Spawn Tracing"
333− (delayedAssertion
392+ (synchronisedAssertion
334393 "expected dead process-info to be ProcessInfoNone"
335394 node1 True testSpawnTracing lock)
336395 , testCase "Recv Tracing (Explicit Pid)"
337− (delayedAssertion
396+ (synchronisedAssertion
338397 "expected a recv trace for the supplied pid"
339398 node1 True testTraceRecvExplicitPid lock)
340399 , testCase "Recv Tracing (Named Pid)"
341− (delayedAssertion
400+ (synchronisedAssertion
342401 "expected a recv trace for the process registered as 'foobar'"
343402 node1 True testTraceRecvNamedPid lock)
344403 , testCase "Trace Send(er)"
345− (delayedAssertion
404+ (synchronisedAssertion
346405 "expected a 'send' trace with the requisite fields set"
347406 node1 True testTraceSending lock)
348407 , testCase "Trace Registration"
349− (delayedAssertion
408+ (synchronisedAssertion
350409 "expected a 'registered' trace"
351410 node1 True testTraceRegistration lock)
352411 , testCase "Trace Unregistration"
353− (delayedAssertion
412+ (synchronisedAssertion
354413 "expected an 'unregistered' trace"
355414 node1 True testTraceUnRegistration lock)
356415 , testCase "Trace Layering"
357− (delayedAssertion
358− "expected blah"
359− node1 () testTraceLayering lock)
416+ (synchronisedAssertion
417+ "expected blah"
418+ node1 () testTraceLayering lock)
360419 , testCase "Remote Trace Relay"
361− (delayedAssertion
362− "expected blah"
363− node1 True testRemoteTraceRelay lock)
420+ (synchronisedAssertion
421+ "expected blah"
422+ node1 True (testRemoteTraceRelay testtrans) lock)
423+ , testGroup "SystemLoggerTracer"
424+ [ testCase "MxReceive" $ testSystemLoggerMxReceive testtrans
425+ , testCase "MxSent" $ testSystemLoggerMxSent testtrans
426+ , testCase "MxProcessDied" $ testSystemLoggerMxProcessDied testtrans
427+ , testCase "MxSpawned" $ testSystemLoggerMxSpawned testtrans
428+ , testCase "MxRegistered" $ testSystemLoggerMxRegistered testtrans
429+ , testCase "MxUnRegistered" $ testSystemLoggerMxUnRegistered testtrans
430+ ]
364431 ] ]
365− False ->
366− return []
367−
368−checkTraceEnabled :: IO Bool
369−checkTraceEnabled =
370− Ex.catch (getEnv "DISTRIBUTED_PROCESS_TRACE_ENABLED" >> return True)
371− (\(_ :: IOError) -> return False)
372−
373−
374−mkNode :: String -> IO LocalNode
375−mkNode port = do
376− Right (transport1, _) <- createTransportExposeInternals
377− "127.0.0.1" port defaultTCPParameters
378− newLocalNode transport1 initRemoteTable
379−
380−main :: IO ()
381−main = do
382− setEnv "DISTRIBUTED_PROCESS_TRACE_ENABLED" "true" True
383− node1 <- mkNode "8081"
384− testData <- tests node1
385− defaultMain testData
386− closeLocalNode node1
387− return ()
388−
distributed-process-tests/src/Network/Transport/Test.hsnew file+12
@@ -0,0 +1,12 @@
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.hsnew file+30
@@ -0,0 +1,30 @@
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.hsnew file+47
@@ -0,0 +1,47 @@
1+-- Run tests using the TCP transport.
2+--
3+module Main where
4+
5+import TEST_SUITE_MODULE (tests)
6+
7+import Network.Transport.Test (TestTransport(..))
8+import Network.Socket (sClose)
9+import Network.Transport.TCP
10+ ( createTransportExposeInternals
11+ , TransportInternals(socketBetween)
12+ , defaultTCPParameters
13+ , defaultTCPAddr
14+ , TCPParameters(..)
15+ )
16+import Test.Framework (defaultMainWithArgs)
17+
18+import Control.Concurrent (threadDelay)
19+import Control.Exception (IOException, try)
20+import System.Environment (getArgs)
21+import System.IO
22+
23+main :: IO ()
24+main = do
25+ hSetBuffering stdout LineBuffering
26+ hSetBuffering stderr LineBuffering
27+ Right (transport, internals) <-
28+ createTransportExposeInternals (defaultTCPAddr "127.0.0.1" "8080")
29+ defaultTCPParameters { transportConnectTimeout = Just 3000000 }
30+ ts <- tests TestTransport
31+ { testTransport = transport
32+ , testBreakConnection = \addr1 addr2 -> do
33+ esock <- try $ socketBetween internals addr1 addr2
34+ either (\e -> const (return ()) (e :: IOException)) sClose esock
35+ threadDelay 10000
36+ }
37+ args <- getArgs
38+ -- Tests are time sensitive. Running the tests concurrently can slow them
39+ -- down enough that threads using threadDelay would wake up later than
40+ -- expected, thus changing the order in which messages were expected.
41+ -- Therefore we run the tests sequentially by passing "-j 1" to
42+ -- test-framework. This does not solve the issue but makes it less likely.
43+ --
44+ -- The problem was first detected with
45+ -- 'Control.Distributed.Process.Tests.CH.testMergeChannels'
46+ -- in particular.
47+ defaultMainWithArgs ts ("-j" : "1" : args)
distributed-process.cabal+121−209
@@ -1,15 +1,15 @@
11Name: distributed-process
2−Version: 0.4.2
2+Version: 0.7.4
33Cabal-Version: >=1.8
44Build-Type: Simple
55License: BSD3
66License-File: LICENSE
7−Copyright: Well-Typed LLP
7+Copyright: Well-Typed LLP, Tweag I/O Limited
88Author: Duncan Coutts, Nicolas Wu, Edsko de Vries
9−Maintainer: watson.timothy@gmail.com, edsko@well-typed.com, duncan@well-typed.com
9+Maintainer: Tim Watson <watson.timothy@gmail.com>
1010Stability: experimental
1111Homepage: http://haskell-distributed.github.com/
12−Bug-Reports: http://cloud-haskell.atlassian.net
12+Bug-Reports: https://github.com/haskell-distributed/distributed-process/issues
1313Synopsis: Cloud Haskell: Erlang-style concurrency in Haskell
1414Description: This is an implementation of Cloud Haskell, as described in
1515 /Towards Haskell in the Cloud/ by Jeff Epstein, Andrew Black,
@@ -17,12 +17,13 @@ Description: This is an implementation of Cloud Haskell, as described in
1717 (<http://research.microsoft.com/en-us/um/people/simonpj/papers/parallel/>),
1818 although some of the details are different. The precise message
1919 passing semantics are based on /A unified semantics for future Erlang/
20− by Hans Svensson, Lars-Åke Fredlund and Clara Benac Earle.
20+ by Hans Svensson, Lars-&#xc5;ke Fredlund and Clara Benac Earle.
2121
2222 You will probably also want to install a Cloud Haskell backend such
2323 as distributed-process-simplelocalnet.
24−Tested-With: GHC==7.2.2 GHC==7.4.1 GHC==7.4.2
24+Tested-With: GHC==7.10.3 GHC==8.0.2 GHC==8.2.2 GHC==8.4.4
2525Category: Control
26+extra-source-files: ChangeLog
2627
2728Source-Repository head
2829 Type: git
@@ -33,224 +34,135 @@ flag th
3334 description: Build with Template Haskell support
3435 default: True
3536
36−flag benchmarks
37− description: Build benchmarks
38− default: False
39−
40−flag prof
41− description: Compiling with profiling enabled
42− default: False
37+flag old-locale
38+ description: If false then depend on time >= 1.5.
39+ .
40+ If true then depend on time < 1.5 together with old-locale.
41+ default: False
4342
4443Library
45− Build-Depends: base >= 4.4 && < 5,
46− binary >= 0.5 && < 0.8,
47− network-transport >= 0.3 && < 0.4,
48− stm >= 2.4 && < 2.5,
49− transformers >= 0.2 && < 0.4,
50− mtl >= 2.0 && < 2.2,
44+ Build-Depends: base >= 4.6 && < 5,
45+ binary >= 0.6.3 && < 0.10,
46+ hashable >= 1.2.0.5 && < 1.3,
47+ network-transport >= 0.4.1.0 && < 0.6,
48+ stm >= 2.4 && < 2.6,
49+ transformers >= 0.2 && < 0.6,
50+ mtl >= 2.0 && < 2.4,
5151 data-accessor >= 0.2 && < 0.3,
5252 bytestring >= 0.9 && < 0.11,
53− containers >= 0.4 && < 0.6,
54− old-locale >= 1.0 && < 1.1,
55− time >= 1.2 && < 1.5,
56− random >= 1.0 && < 1.1,
57− ghc-prim >= 0.2 && < 0.4,
58− distributed-static >= 0.2 && < 0.3,
59− rank1dynamic >= 0.1 && < 0.2,
60− syb >= 0.3 && < 0.4
53+ random >= 1.0 && < 1.2,
54+ distributed-static >= 0.2 && < 0.4,
55+ rank1dynamic >= 0.1 && < 0.5,
56+ syb >= 0.3 && < 0.8,
57+ exceptions >= 0.5,
58+ containers >= 0.5 && < 0.7,
59+ deepseq >= 1.3.0.1 && < 1.6
6160 Exposed-modules: Control.Distributed.Process,
62− Control.Distributed.Process.Internal.Types,
63− Control.Distributed.Process.Serializable,
6461 Control.Distributed.Process.Closure,
6562 Control.Distributed.Process.Debug,
66− Control.Distributed.Process.Node
67− Other-modules: Control.Distributed.Process.Internal.Primitives,
68− Control.Distributed.Process.Internal.Spawn,
69− Control.Distributed.Process.Internal.CQueue,
63+ Control.Distributed.Process.Internal.BiMultiMap,
7064 Control.Distributed.Process.Internal.Closure.BuiltIn,
65+ Control.Distributed.Process.Internal.Closure.Explicit,
66+ Control.Distributed.Process.Internal.CQueue,
7167 Control.Distributed.Process.Internal.Messaging,
68+ Control.Distributed.Process.Internal.Primitives,
69+ Control.Distributed.Process.Internal.Spawn,
70+ Control.Distributed.Process.Internal.StrictContainerAccessors,
7271 Control.Distributed.Process.Internal.StrictList,
7372 Control.Distributed.Process.Internal.StrictMVar,
73+ Control.Distributed.Process.Internal.Types,
7474 Control.Distributed.Process.Internal.WeakTQueue,
75− Control.Distributed.Process.Internal.StrictContainerAccessors,
76− Control.Distributed.Process.Internal.Trace.Types,
77− Control.Distributed.Process.Internal.Trace.Primitives,
78− Control.Distributed.Process.Internal.Trace.Tracer
79− Control.Distributed.Process.Internal.Trace.Remote
80− Extensions: RankNTypes,
81− ScopedTypeVariables,
82− FlexibleInstances,
83− UndecidableInstances,
84− ExistentialQuantification,
85− GADTs,
86− GeneralizedNewtypeDeriving,
87− DeriveDataTypeable,
88− CPP,
89− BangPatterns
75+ Control.Distributed.Process.Management,
76+ Control.Distributed.Process.Node,
77+ Control.Distributed.Process.Serializable,
78+ Control.Distributed.Process.UnsafePrimitives
79+ Control.Distributed.Process.Management.Internal.Agent,
80+ Control.Distributed.Process.Management.Internal.Bus,
81+ Control.Distributed.Process.Management.Internal.Types,
82+ Control.Distributed.Process.Management.Internal.Trace.Primitives,
83+ Control.Distributed.Process.Management.Internal.Trace.Remote,
84+ Control.Distributed.Process.Management.Internal.Trace.Types,
85+ Control.Distributed.Process.Management.Internal.Trace.Tracer
9086 ghc-options: -Wall
9187 HS-Source-Dirs: src
92− if flag(th)
93− Build-Depends: template-haskell >= 2.6 && < 2.9
94− Exposed-modules: Control.Distributed.Process.Internal.Closure.TH
95− CPP-Options: -DTemplateHaskellSupport
96−
97−Test-Suite TestCH
98− Type: exitcode-stdio-1.0
99− Main-Is: TestCH.hs
100− Build-Depends: base >= 4.4 && < 5,
101− random >= 1.0 && < 1.1,
102− ansi-terminal >= 0.5 && < 0.6,
103− distributed-process,
104− network-transport >= 0.3 && < 0.4,
105− network-transport-tcp >= 0.3 && < 0.4,
106− binary >= 0.5 && < 0.8,
107− network >= 2.3 && < 2.5,
108− HUnit >= 1.2 && < 1.3,
109− test-framework >= 0.6 && < 0.9,
110− test-framework-hunit >= 0.2.0 && < 0.4,
111− rematch >= 0.1.2.1
112− Extensions: CPP,
113− ScopedTypeVariables,
114− DeriveDataTypeable,
88+ other-extensions: BangPatterns
89+ CPP
90+ DeriveDataTypeable
91+ DeriveFunctor
92+ DeriveGeneric
93+ ExistentialQuantification
94+ FlexibleInstances
95+ GADTs
11596 GeneralizedNewtypeDeriving
116− ghc-options: -Wall -threaded -debug -eventlog -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
117− HS-Source-Dirs: tests
118−
119−Test-Suite TestClosure
120− Type: exitcode-stdio-1.0
121− Main-Is: TestClosure.hs
122− Build-Depends: base >= 4.4 && < 5,
123− random >= 1.0 && < 1.1,
124− ansi-terminal >= 0.5 && < 0.6,
125− distributed-static >= 0.2 && < 0.3,
126− distributed-process,
127− network-transport >= 0.3 && < 0.4,
128− network-transport-tcp >= 0.3 && < 0.4,
129− bytestring >= 0.9 && < 0.11,
130− network >= 2.3 && < 2.5,
131− HUnit >= 1.2 && < 1.3,
132− test-framework >= 0.6 && < 0.9,
133− test-framework-hunit >= 0.2.0 && < 0.4
134− Extensions: CPP,
97+ KindSignatures
98+ MagicHash
99+ PatternGuards
100+ RankNTypes
101+ RecordWildCards
135102 ScopedTypeVariables
136− ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
137− HS-Source-Dirs: tests
138−
139−Test-Suite TestStats
140− Type: exitcode-stdio-1.0
141− Main-Is: TestStats.hs
142− Build-Depends: base >= 4.4 && < 5,
143− random >= 1.0 && < 1.1,
144− ansi-terminal >= 0.5 && < 0.6,
145− containers >= 0.4 && < 0.6,
146− stm >= 2.4 && < 2.5,
147− distributed-process,
148− network-transport >= 0.3 && < 0.4,
149− network-transport-tcp >= 0.3 && < 0.4,
150− binary >= 0.5 && < 0.8,
151− network >= 2.3 && < 2.5,
152− HUnit >= 1.2 && < 1.3,
153− test-framework >= 0.6 && < 0.9,
154− test-framework-hunit >= 0.2.0 && < 0.4
155− Extensions: CPP,
156− ScopedTypeVariables,
157− DeriveDataTypeable,
158− GeneralizedNewtypeDeriving
159− ghc-options: -Wall -debug -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
160− HS-Source-Dirs: tests
161−
162−Test-Suite TestTracing
163− Type: exitcode-stdio-1.0
164− Main-Is: TestTracing.hs
165− Build-Depends: base >= 4.4 && < 5,
166− random >= 1.0 && < 1.1,
167− ansi-terminal >= 0.5 && < 0.6,
168− containers >= 0.4 && < 0.6,
169− stm >= 2.4 && < 2.5,
170− distributed-process,
171− network-transport >= 0.3 && < 0.4,
172− network-transport-tcp >= 0.3 && < 0.4,
173− binary >= 0.5 && < 0.7,
174− network >= 2.3 && < 2.5,
175− HUnit >= 1.2 && < 1.3,
176− test-framework >= 0.6 && < 0.9,
177− test-framework-hunit >= 0.2.0 && < 0.4,
178− unix >= 2.5.0.0
179− Extensions: CPP,
180− ScopedTypeVariables,
181− DeriveDataTypeable,
182− GeneralizedNewtypeDeriving
183− ghc-options: -Wall -debug -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
184− HS-Source-Dirs: tests
185−
186−
187−Executable distributed-process-throughput
188− if flag(benchmarks)
189− Build-Depends: base >= 4.4 && < 5,
190− distributed-process,
191− network-transport-tcp >= 0.3 && < 0.4,
192− bytestring >= 0.9 && < 0.11,
193− binary >= 0.5 && < 0.8
194− else
195− buildable: False
196− Main-Is: benchmarks/Throughput.hs
197− ghc-options: -Wall
198− Extensions: BangPatterns
199−
200−Executable distributed-process-latency
201− if flag(benchmarks)
202− Build-Depends: base >= 4.4 && < 5,
203− distributed-process,
204− network-transport-tcp >= 0.3 && < 0.4,
205− bytestring >= 0.9 && < 0.11,
206− binary >= 0.5 && < 0.8
207− else
208− buildable: False
209− Main-Is: benchmarks/Latency.hs
210− ghc-options: -Wall
211− Extensions: BangPatterns
212−
213−Executable distributed-process-channels
214− if flag(benchmarks)
215− Build-Depends: base >= 4.4 && < 5,
216− distributed-process,
217− network-transport-tcp >= 0.3 && < 0.4,
218− bytestring >= 0.9 && < 0.11,
219− binary >= 0.5 && < 0.8
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
220110 else
221− buildable: False
222− Main-Is: benchmarks/Channels.hs
223− ghc-options: -Wall
224− Extensions: BangPatterns
225−
226−Executable distributed-process-spawns
227− if flag(benchmarks)
228− Build-Depends: base >= 4.4 && < 5,
229− distributed-process,
230− network-transport-tcp >= 0.3 && < 0.4,
231− bytestring >= 0.9 && < 0.11,
232− binary >= 0.5 && < 0.8
233− else
234− buildable: False
235− Main-Is: benchmarks/Spawns.hs
236− ghc-options: -Wall
237− Extensions: BangPatterns
238−
239−Executable distributed-process-ring
240− if flag(benchmarks)
241− Build-Depends: base >= 4.4 && < 5,
242− distributed-process,
243− network-transport-tcp >= 0.3 && < 0.4,
244− bytestring >= 0.9 && < 0.11,
245− binary >= 0.5 && < 0.8
246− else
247− buildable: False
248− Main-Is: benchmarks/ProcessRing.hs
249− if flag(prof)
250− ghc-options: -Wall -threaded -prof -auto-all -fno-prof-count-entries -rtsopts
251− else
252− ghc-options: -Wall -threaded -O2 -H256m -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
253− Extensions: BangPatterns,
254− ScopedTypeVariables
255−
111+ Build-Depends: time >= 1.5
112+ if flag(th)
113+ other-extensions: TemplateHaskell
114+ Build-Depends: template-haskell >= 2.6
115+ Exposed-modules: Control.Distributed.Process.Internal.Closure.TH
116+ CPP-Options: -DTemplateHaskellSupport
256117
118+-- Tests are in distributed-process-test package, for convenience.
119+
120+benchmark distributed-process-throughput
121+ Type: exitcode-stdio-1.0
122+ Build-Depends: base >= 4.6 && < 5,
123+ distributed-process,
124+ network-transport-tcp >= 0.3 && < 0.7,
125+ bytestring >= 0.9 && < 0.11,
126+ binary >= 0.6.3 && < 0.10
127+ Main-Is: benchmarks/Throughput.hs
128+ ghc-options: -Wall
129+
130+benchmark distributed-process-latency
131+ Type: exitcode-stdio-1.0
132+ Build-Depends: base >= 4.6 && < 5,
133+ distributed-process,
134+ network-transport-tcp >= 0.3 && < 0.7,
135+ bytestring >= 0.9 && < 0.11,
136+ binary >= 0.6.3 && < 0.10
137+ Main-Is: benchmarks/Latency.hs
138+ ghc-options: -Wall
139+
140+benchmark distributed-process-channels
141+ Type: exitcode-stdio-1.0
142+ Build-Depends: base >= 4.6 && < 5,
143+ distributed-process,
144+ network-transport-tcp >= 0.3 && < 0.7,
145+ bytestring >= 0.9 && < 0.11,
146+ binary >= 0.6.3 && < 0.10
147+ Main-Is: benchmarks/Channels.hs
148+ ghc-options: -Wall
149+
150+benchmark distributed-process-spawns
151+ Type: exitcode-stdio-1.0
152+ Build-Depends: base >= 4.6 && < 5,
153+ distributed-process,
154+ network-transport-tcp >= 0.3 && < 0.7,
155+ bytestring >= 0.9 && < 0.11,
156+ binary >= 0.6.3 && < 0.10
157+ Main-Is: benchmarks/Spawns.hs
158+ ghc-options: -Wall
159+
160+benchmark distributed-process-ring
161+ Type: exitcode-stdio-1.0
162+ Build-Depends: base >= 4.6 && < 5,
163+ distributed-process,
164+ network-transport-tcp >= 0.3 && < 0.7,
165+ bytestring >= 0.9 && < 0.11,
166+ binary >= 0.6.3 && < 0.10
167+ Main-Is: benchmarks/ProcessRing.hs
168+ ghc-options: -Wall -threaded -O2 -rtsopts
doc/semantics/CloudHaskellSemantics.texnew file+706
@@ -0,0 +1,706 @@
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/Makefilenew file+11
@@ -0,0 +1,11 @@
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.bibnew file+72
@@ -0,0 +1,72 @@
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+90−25
@@ -1,8 +1,10 @@
1+{-# LANGUAGE CPP #-}
12{- | [Cloud Haskell]
23
34This is an implementation of Cloud Haskell, as described in
45/Towards Haskell in the Cloud/ by Jeff Epstein, Andrew Black, and Simon
5−Peyton Jones (<http://research.microsoft.com/en-us/um/people/simonpj/papers/parallel/>),
6+Peyton Jones (see
7+<http://research.microsoft.com/en-us/um/people/simonpj/papers/parallel/>),
68although some of the details are different. The precise message passing
79semantics are based on /A unified semantics for future Erlang/ by Hans
810Svensson, Lars-Åke Fredlund and Clara Benac Earle.
@@ -15,7 +17,7 @@ please see the distributed-process wiki page on github:
1517module Control.Distributed.Process
1618 ( -- * Basic types
1719 ProcessId
18− , NodeId
20+ , NodeId(..)
1921 , Process
2022 , SendPortId
2123 , processNodeId
@@ -23,6 +25,7 @@ module Control.Distributed.Process
2325 , liftIO -- Reexported for convenience
2426 -- * Basic messaging
2527 , send
28+ , usend
2629 , expect
2730 , expectTimeout
2831 -- * Channels
@@ -35,6 +38,13 @@ module Control.Distributed.Process
3538 , receiveChanTimeout
3639 , mergePortsBiased
3740 , mergePortsRR
41+ -- * Unsafe messaging variants
42+ , unsafeSend
43+ , unsafeUSend
44+ , unsafeSendChan
45+ , unsafeNSend
46+ , unsafeNSendRemote
47+ , unsafeWrapMessage
3848 -- * Advanced messaging
3949 , Match
4050 , receiveWait
@@ -45,13 +55,19 @@ module Control.Distributed.Process
4555 , matchAny
4656 , matchAnyIf
4757 , matchChan
58+ , matchSTM
4859 , Message
4960 , matchMessage
5061 , matchMessageIf
62+ , isEncoded
5163 , wrapMessage
5264 , unwrapMessage
5365 , handleMessage
66+ , handleMessageIf
67+ , handleMessage_
68+ , handleMessageIf_
5469 , forward
70+ , uforward
5571 , delegate
5672 , relay
5773 , proxy
@@ -71,6 +87,9 @@ module Control.Distributed.Process
7187 , getSelfNode
7288 , ProcessInfo(..)
7389 , getProcessInfo
90+ , NodeStats(..)
91+ , getNodeStats
92+ , getLocalNodeStats
7493 -- * Monitoring and linking
7594 , link
7695 , linkNode
@@ -83,6 +102,7 @@ module Control.Distributed.Process
83102 , monitorPort
84103 , unmonitor
85104 , withMonitor
105+ , withMonitor_
86106 , MonitorRef -- opaque
87107 , ProcessLinkException(..)
88108 , NodeLinkException(..)
@@ -119,6 +139,7 @@ module Control.Distributed.Process
119139 , catches
120140 , try
121141 , mask
142+ , mask_
122143 , onException
123144 , bracket
124145 , bracket_
@@ -133,27 +154,27 @@ module Control.Distributed.Process
133154 -- * Local versions of 'spawn'
134155 , spawnLocal
135156 , spawnChannelLocal
157+ , callLocal
136158 -- * Reconnecting
137159 , reconnect
138160 , reconnectPort
139161 ) where
140162
141−#if ! MIN_VERSION_base(4,6,0)
142−import Prelude hiding (catch)
143−#endif
144−
145−import Data.Typeable (Typeable)
146163import Control.Monad.IO.Class (liftIO)
147−import Control.Applicative ((<$>))
164+import Control.Applicative
148165import Control.Monad.Reader (ask)
149−import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
166+import Control.Concurrent (killThread)
167+import Control.Concurrent.MVar
168+ ( MVar
169+ , newEmptyMVar
170+ , takeMVar
171+ , putMVar
172+ )
150173import Control.Distributed.Static
151174 ( Closure
152175 , closure
153176 , Static
154177 , RemoteTable
155− , closureCompose
156− , staticClosure
157178 )
158179import Control.Distributed.Process.Internal.Types
159180 ( NodeId(..)
@@ -177,24 +198,13 @@ import Control.Distributed.Process.Internal.Types
177198 , RegisterReply(..)
178199 , LocalProcess(processNode)
179200 , Message
180− , nullProcessId
181− )
182−import Control.Distributed.Process.Serializable (Serializable, SerializableDict)
183−import Control.Distributed.Process.Internal.Closure.BuiltIn
184− ( sdictSendPort
185− , sndStatic
186− , idCP
187− , seqCP
188− , bindCP
189− , splitCP
190− , cpLink
191− , cpSend
192− , cpNewChan
193− , cpDelay
201+ , localProcessWithId
194202 )
203+import Control.Distributed.Process.Serializable (Serializable)
195204import Control.Distributed.Process.Internal.Primitives
196205 ( -- Basic messaging
197206 send
207+ , usend
198208 , expect
199209 -- Channels
200210 , newChan
@@ -202,6 +212,11 @@ import Control.Distributed.Process.Internal.Primitives
202212 , receiveChan
203213 , mergePortsBiased
204214 , mergePortsRR
215+ , unsafeSend
216+ , unsafeUSend
217+ , unsafeSendChan
218+ , unsafeNSend
219+ , unsafeNSendRemote
205220 -- Advanced messaging
206221 , Match
207222 , receiveWait
@@ -212,12 +227,19 @@ import Control.Distributed.Process.Internal.Primitives
212227 , matchAny
213228 , matchAnyIf
214229 , matchChan
230+ , matchSTM
215231 , matchMessage
216232 , matchMessageIf
233+ , isEncoded
217234 , wrapMessage
235+ , unsafeWrapMessage
218236 , unwrapMessage
219237 , handleMessage
238+ , handleMessageIf
239+ , handleMessage_
240+ , handleMessageIf_
220241 , forward
242+ , uforward
221243 , delegate
222244 , relay
223245 , proxy
@@ -233,6 +255,9 @@ import Control.Distributed.Process.Internal.Primitives
233255 , getSelfNode
234256 , ProcessInfo(..)
235257 , getProcessInfo
258+ , NodeStats(..)
259+ , getNodeStats
260+ , getLocalNodeStats
236261 -- Monitoring and linking
237262 , link
238263 , linkNode
@@ -245,6 +270,7 @@ import Control.Distributed.Process.Internal.Primitives
245270 , monitorPort
246271 , unmonitor
247272 , withMonitor
273+ , withMonitor_
248274 -- Logging
249275 , say
250276 -- Registry
@@ -267,6 +293,7 @@ import Control.Distributed.Process.Internal.Primitives
267293 , catches
268294 , try
269295 , mask
296+ , mask_
270297 , onException
271298 , bracket
272299 , bracket_
@@ -280,6 +307,10 @@ import Control.Distributed.Process.Internal.Primitives
280307 , reconnectPort
281308 )
282309import Control.Distributed.Process.Node (forkProcess)
310+import Control.Distributed.Process.Internal.Types
311+ ( processThread
312+ , withValidLocalState
313+ )
283314import Control.Distributed.Process.Internal.Spawn
284315 ( -- Spawning Processes/Channels
285316 spawn
@@ -289,6 +320,17 @@ import Control.Distributed.Process.Internal.Spawn
289320 , spawnSupervised
290321 , call
291322 )
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+
292334
293335-- INTERNAL NOTES
294336--
@@ -380,3 +422,26 @@ spawnChannelLocal proc = do
380422 proc rport
381423 takeMVar mvar
382424
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,6 +163,8 @@ module Control.Distributed.Process.Closure
163163 , sdictUnit
164164 , sdictProcessId
165165 , sdictSendPort
166+ , sdictStatic
167+ , sdictClosure
166168 -- * The CP type and associated combinators
167169 , CP
168170 , idCP
@@ -177,6 +179,13 @@ module Control.Distributed.Process.Closure
177179 , cpSend
178180 , cpExpect
179181 , cpNewChan
182+ -- * Working with static values and closures (without Template Haskell)
183+ , RemoteRegister
184+ , MkTDict(..)
185+ , mkStaticVal
186+ , mkClosureValSingle
187+ , mkClosureVal
188+ , call'
180189#ifdef TemplateHaskellSupport
181190 -- * Template Haskell support for creating static values and closures
182191 , remotable
@@ -196,6 +205,8 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
196205 , sdictUnit
197206 , sdictProcessId
198207 , sdictSendPort
208+ , sdictStatic
209+ , sdictClosure
199210 -- The CP type and associated combinators
200211 , CP
201212 , idCP
@@ -211,6 +222,15 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
211222 , cpExpect
212223 , cpNewChan
213224 )
225+import Control.Distributed.Process.Internal.Closure.Explicit
226+ (
227+ RemoteRegister
228+ , MkTDict(..)
229+ , mkStaticVal
230+ , mkClosureValSingle
231+ , mkClosureVal
232+ , call'
233+ )
214234#ifdef TemplateHaskellSupport
215235import Control.Distributed.Process.Internal.Closure.TH
216236 ( remotable
src/Control/Distributed/Process/Debug.hs+62−66
@@ -1,3 +1,6 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
3+{-# LANGUAGE RankNTypes #-}
14-----------------------------------------------------------------------------
25-- |
36-- Module : Control.Distributed.Process.Debug
@@ -17,16 +20,14 @@
1720--
1821-- [Enabling Tracing]
1922--
20−-- Tracing is disabled by default, because it carries a relatively small, but
21−-- tangible cost. To enable tracing, the environment variable
22−-- @DISTRIBUTED_PROCESS_TRACE_ENABLED@ must be set to some value (the contents
23−-- are ignored). When the environment variable /is/ set, the system will
24−-- generate /trace events/ in various circumstances - see 'TraceEvent' for a
25−-- list of all the published events. A user can additionally publish custom
26−-- trace events in the form of 'TraceEvLog' log messages or pass custom
27−-- (i.e., completely user defined) event data using the 'traceMessage' function.
28−-- If the environment variable is not set, no trace events will ever be
29−-- published.
23+-- Throughout the lifecycle of a local node, the distributed-process runtime
24+-- generates /trace events/, describing internal runtime activities such as
25+-- 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
27+-- event types, which correspond directly to the types of /management/ events.
28+-- Users can additionally publish custom trace events in the form of
29+-- 'MxLog' log messages or pass custom (i.e., completely user defined)
30+-- event data using the 'traceMessage' function.
3031--
3132-- All published traces are forwarded to a /tracer process/, which can be
3233-- specified (and changed) at runtime using 'traceEnable'. Some pre-defined
@@ -37,15 +38,15 @@
3738--
3839-- [Working with multiple tracer processes]
3940--
40−-- The system tracing facility only ever writes to a single tracer process. This
41+-- The tracing facility only ever writes to a single tracer process. This
4142-- invariant insulates the tracer controller and ensures a fast path for
4243-- handling all trace events. /This/ module provides facilities for layering
4344-- trace handlers using Cloud Haskell's built-in delegation primitives.
4445--
4546-- The 'startTracer' function wraps the registered @tracer@ process with the
46−-- supplied handler and also forwarding trace events to the original tracer.
47+-- supplied handler and also forwards trace events to the original tracer.
4748-- The corresponding 'stopTracer' function terminates tracer processes in
48−-- reverse of the order in which they were started, and re-establishes the
49+-- reverse of the order in which they were started, and re-registers the
4950-- previous tracer process.
5051--
5152-- [Built in tracers]
@@ -53,22 +54,21 @@
5354-- The built in tracers provide a simple /logging/ facility that writes trace
5455-- events out to either a log file, @stderr@ or the GHC eventlog. These tracers
5556-- can be configured using environment variables, or specified manually using
56−-- the 'traceEnable' function. The base tracer process cannot be
57+-- the 'traceEnable' function.
5758--
5859-- When a new local node is started, the contents of several environment
59−-- variables are checked to determine how the default tracer process
60−-- will handle trace events. If none of these variables is set, then the
61−-- trace events will be effectively ignored, although they will still be
62−-- generated and passed through the system. Only one configuration will be
63−-- chosen - the first that contains a (valid) value. These environment
64−-- variables, in the order they're checked, are:
60+-- variables are checked to determine which default tracer process is selected.
61+-- If none of these variables is set, a no-op tracer process is installed,
62+-- which effectively ignores all trace messages. Note that in this case,
63+-- trace events are still generated and passed through the system.
64+-- Only one default tracer will be chosen - the first that contains a (valid)
65+-- value. These environment variables, in the order they're examined, are:
6566--
6667-- 1. @DISTRIBUTED_PROCESS_TRACE_FILE@
6768-- This is checked for a valid file path. If it exists and the file can be
6869-- opened for writing, all trace output will be directed thence. If the supplied
69−-- path is invalid, or the file is unavailable for writing - e.g., because
70−-- another node has already started tracing to it - then this tracer will be
71−-- disabled.
70+-- path is invalid, or the file is unavailable for writing, this tracer will not
71+-- be selected.
7272--
7373-- 2. @DISTRIBUTED_PROCESS_TRACE_CONSOLE@
7474-- This is checked for /any/ non-empty value. If set, then all trace output will
@@ -78,11 +78,26 @@
7878-- This is checked for /any/ non-empty value. If set, all internal traces are
7979-- written to the GHC eventlog.
8080--
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+--
8194-- Users of the /simplelocalnet/ Cloud Haskell backend should also note that
8295-- because the trace file option only supports trace output from a single node
8396-- (so as to avoid interleaving), a file trace configured for the master node
84−-- will prevent slaves from tracing to the file and will need to fall back to
85−-- the console or eventlog tracers instead.
97+-- will prevent slaves from tracing to the file. They will need to fall back to
98+-- the console or eventlog tracers instead, which can be accomplished by setting
99+-- one of these environment variables /as well/, since the latter will only be
100+-- selected on slaves (when the file tracer selection fails).
86101--
87102-- Support for writing to the eventlog requires specific intervention to work,
88103-- without which, written traces are silently dropped/ignored and no output will
@@ -93,11 +108,9 @@
93108module Control.Distributed.Process.Debug
94109 ( -- * Exported Data Types
95110 TraceArg(..)
96− , TraceEvent(..)
97111 , TraceFlags(..)
98112 , TraceSubject(..)
99113 -- * Configuring Tracing
100− , isTracingEnabled
101114 , enableTrace
102115 , enableTraceAsync
103116 , disableTrace
@@ -113,7 +126,7 @@ module Control.Distributed.Process.Debug
113126 -- * Debugging
114127 , startTracer
115128 , stopTracer
116− -- * Sending Trace Data
129+ -- * Sending Custom Trace Data
117130 , traceLog
118131 , traceLogFmt
119132 , traceMessage
@@ -128,49 +141,37 @@ module Control.Distributed.Process.Debug
128141 )
129142 where
130143
131−import Control.Applicative ((<$>))
144+import Control.Applicative
132145import Control.Distributed.Process.Internal.Primitives
133146 ( proxy
134− , finally
135147 , die
136148 , whereis
137149 , send
138− , newChan
139− , receiveChan
140150 , receiveWait
141151 , matchIf
142− , finally
143− , try
144152 , monitor
145− , say
146− )
147−import Control.Distributed.Process.Internal.Spawn
148− ( spawn
149153 )
150154import Control.Distributed.Process.Internal.Types
151− ( Tracer(..)
152− , LocalNode(..)
153− , ProcessId
155+ ( ProcessId
154156 , Process
155157 , LocalProcess(..)
156− , SendPort(..)
157158 , ProcessMonitorNotification(..)
158− , NodeId(..)
159159 )
160−import Control.Distributed.Process.Internal.Trace.Types
160+import Control.Distributed.Process.Management.Internal.Types
161+ ( MxEvent(..)
162+ )
163+import Control.Distributed.Process.Management.Internal.Trace.Types
161164 ( TraceArg(..)
162− , TraceEvent(..)
163165 , TraceFlags(..)
164166 , TraceSubject(..)
165− , TraceOk(..)
166167 , defaultTraceFlags
167168 )
168−import Control.Distributed.Process.Internal.Trace.Tracer
169+import Control.Distributed.Process.Management.Internal.Trace.Tracer
169170 ( systemLoggerTracer
170171 , logfileTracer
171172 , eventLogTracer
172173 )
173−import Control.Distributed.Process.Internal.Trace.Primitives
174+import Control.Distributed.Process.Management.Internal.Trace.Primitives
174175 ( withRegisteredTracer
175176 , enableTrace
176177 , enableTraceAsync
@@ -178,7 +179,6 @@ import Control.Distributed.Process.Internal.Trace.Primitives
178179 , setTraceFlags
179180 , setTraceFlagsAsync
180181 , getTraceFlags
181− , isTracingEnabled
182182 , traceOn
183183 , traceOff
184184 , traceOnly
@@ -186,20 +186,18 @@ import Control.Distributed.Process.Internal.Trace.Primitives
186186 , traceLogFmt
187187 , traceMessage
188188 )
189−import qualified Control.Distributed.Process.Internal.Trace.Remote as Remote
189+import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Remote
190190import Control.Distributed.Process.Node
191−import Control.Distributed.Process.Serializable
192191
193192import Control.Exception (SomeException)
194193
195194import Control.Monad.IO.Class (liftIO)
196195import Control.Monad.Reader (ask)
196+import Control.Monad.Catch (finally, try)
197197
198198import Data.Binary()
199199
200−#if ! MIN_VERSION_base(4,6,0)
201−import Prelude hiding (catch)
202−#endif
200+import Prelude
203201
204202--------------------------------------------------------------------------------
205203-- Debugging/Tracing API --
@@ -212,7 +210,7 @@ import Prelude hiding (catch)
212210-- through all the layers in turn. Once the top layer is stopped, the user
213211-- is responsible for re-registering the original (prior) tracer pid before
214212-- terminating. See 'withTracer' for a mechanism that handles that.
215−startTracer :: (TraceEvent -> Process ()) -> Process ProcessId
213+startTracer :: (MxEvent -> Process ()) -> Process ProcessId
216214startTracer handler = do
217215 withRegisteredTracer $ \pid -> do
218216 node <- processNode <$> ask
@@ -224,7 +222,7 @@ startTracer handler = do
224222-- disable tracing thereafter, before giving the result (or exception
225223-- in case of failure).
226224withTracer :: forall a.
227− (TraceEvent -> Process ())
225+ (MxEvent -> Process ())
228226 -> Process a
229227 -> Process (Either SomeException a)
230228withTracer handler proc = do
@@ -237,9 +235,9 @@ withTracer handler proc = do
237235 stopTracing tracer previousTracer = do
238236 case previousTracer of
239237 Nothing -> return ()
240− Just p -> do
238+ Just _ -> do
241239 ref <- monitor tracer
242− send tracer TraceEvDisable
240+ send tracer MxTraceDisable
243241 receiveWait [
244242 matchIf (\(ProcessMonitorNotification ref' _ _) -> ref == ref')
245243 (\_ -> return ())
@@ -256,12 +254,12 @@ withFlags flags proc = do
256254 finally (setTraceFlags flags >> try proc)
257255 (setTraceFlags oldFlags)
258256
259−traceProxy :: ProcessId -> (TraceEvent -> Process ()) -> Process ()
257+traceProxy :: ProcessId -> (MxEvent -> Process ()) -> Process ()
260258traceProxy pid act = do
261− proxy pid $ \(ev :: TraceEvent) ->
259+ proxy pid $ \(ev :: MxEvent) ->
262260 case ev of
263− (TraceEvTakeover p) -> return False
264− TraceEvDisable -> die "disabled"
261+ (MxTraceTakeover _) -> return False
262+ MxTraceDisable -> die "disabled"
265263 _ -> act ev >> return True
266264
267265-- | Stops a user supplied tracer started with 'startTracer'.
@@ -276,8 +274,7 @@ traceProxy pid act = do
276274-- supplied tracers (i.e., processes started via 'startTracer') have exited,
277275-- subsequent calls to this function will have no effect.
278276--
279−-- If tracing support is disabled for the node, this function will also
280−-- have no effect. If the last tracer to have been registered was not started
277+-- If the last tracer to have been registered was not started
281278-- with 'startTracer' then the behaviour of this function is /undefined/.
282279stopTracer :: Process ()
283280stopTracer =
@@ -288,5 +285,4 @@ stopTracer =
288285 basePid <- whereis "tracer.initial"
289286 case basePid == (Just pid) of
290287 True -> return ()
291− False -> send pid TraceEvDisable
292−
288+ False -> send pid MxTraceDisable
src/Control/Distributed/Process/Internal/BiMultiMap.hsnew file+135
@@ -0,0 +1,135 @@
1+-- | This is an implementation of bidirectional multimaps.
2+module Control.Distributed.Process.Internal.BiMultiMap
3+ ( BiMultiMap
4+ , empty
5+ , singleton
6+ , size
7+ , insert
8+ , lookupBy1st
9+ , lookupBy2nd
10+ , delete
11+ , deleteAllBy1st
12+ , deleteAllBy2nd
13+ , partitionWithKeyBy1st
14+ , partitionWithKeyBy2nd
15+ , flip
16+ ) where
17+
18+import Data.List (foldl')
19+import Data.Map.Strict (Map)
20+import qualified Data.Map.Strict as Map
21+import Data.Set (Set)
22+import qualified Data.Set as Set
23+import Prelude hiding (flip, lookup)
24+
25+-- | A bidirectional multimaps @BiMultiMap a b v@ is a set of triplets of type
26+-- @(a, b, v)@.
27+--
28+-- It is possible to lookup values by using either @a@ or @b@ as keys.
29+--
30+data BiMultiMap a b v = BiMultiMap !(Map a (Set (b, v))) !(Map b (Set (a, v)))
31+
32+-- The bidirectional multimap is implemented with a pair of multimaps.
33+--
34+-- Each multimap represents a set of triples, and one invariant is that both
35+-- multimaps should represent exactly the same set of triples.
36+--
37+-- Each of the multimaps, however, uses a different component of the triplets
38+-- as key. This allows to do efficient deletions by any of the two components.
39+
40+-- | The empty bidirectional multimap.
41+empty :: BiMultiMap a b v
42+empty = BiMultiMap Map.empty Map.empty
43+
44+-- | A bidirectional multimap containing a single triplet.
45+singleton :: (Ord a, Ord b, Ord v) => a -> b -> v -> BiMultiMap a b v
46+singleton a b v = insert a b v empty
47+
48+-- | Yields the amount of triplets in the multimap.
49+size :: BiMultiMap a b v -> Int
50+size (BiMultiMap m _) = foldl' (+) 0 $ map Set.size $ Map.elems m
51+
52+-- | Inserts a triplet in the multimap.
53+insert :: (Ord a, Ord b, Ord v)
54+ => a -> b -> v -> BiMultiMap a b v -> BiMultiMap a b v
55+insert a b v (BiMultiMap m r) =
56+ BiMultiMap (Map.insertWith (\_new old -> Set.insert (b, v) old)
57+ a
58+ (Set.singleton (b, v))
59+ m)
60+ (Map.insertWith (\_new old -> Set.insert (a, v) old)
61+ b
62+ (Set.singleton (a, v))
63+ r)
64+
65+-- | Looks up all the triplets whose first component is the given value.
66+lookupBy1st :: Ord a => a -> BiMultiMap a b v -> Set (b, v)
67+lookupBy1st a (BiMultiMap m _) = maybe Set.empty id $ Map.lookup a m
68+
69+-- | Looks up all the triplets whose second component is the given value.
70+lookupBy2nd :: Ord b => b -> BiMultiMap a b v -> Set (a, v)
71+lookupBy2nd b = lookupBy1st b . flip
72+
73+-- | Deletes a triplet. It yields the original multimap if the triplet is
74+-- not present.
75+delete :: (Ord a, Ord b, Ord v)
76+ => a -> b -> v -> BiMultiMap a b v -> BiMultiMap a b v
77+delete a b v (BiMultiMap m r) =
78+ let m' = Map.update (nothingWhen Set.null . Set.delete (b, v)) a m
79+ r' = Map.update (nothingWhen Set.null . Set.delete (a, v)) b r
80+ in BiMultiMap m' r'
81+
82+-- | Deletes all triplets whose first component is the given value.
83+deleteAllBy1st :: (Ord a, Ord b, Ord v) => a -> BiMultiMap a b v -> BiMultiMap a b v
84+deleteAllBy1st a (BiMultiMap m r) =
85+ let (mm, m') = Map.updateLookupWithKey (\_ _ -> Nothing) a m
86+ r' = case mm of
87+ Nothing -> r
88+ Just mb -> reverseDelete a (Set.toList mb) r
89+ in BiMultiMap m' r'
90+
91+-- | Like 'deleteAllBy1st' but deletes by the second component of the triplets.
92+deleteAllBy2nd :: (Ord a, Ord b, Ord v)
93+ => b -> BiMultiMap a b v -> BiMultiMap a b v
94+deleteAllBy2nd b = flip . deleteAllBy1st b . flip
95+
96+-- | Yields the triplets satisfying the given predicate, and a multimap
97+-- with all this triplets removed.
98+partitionWithKeyBy1st :: (Ord a, Ord b, Ord v)
99+ => (a -> Set (b, v) -> Bool) -> BiMultiMap a b v
100+ -> (Map a (Set (b, v)), BiMultiMap a b v)
101+partitionWithKeyBy1st p (BiMultiMap m r) =
102+ let (m0, m1) = Map.partitionWithKey p m
103+ r1 = foldl' (\rr (a, mb) -> reverseDelete a (Set.toList mb) rr) r $
104+ Map.toList m0
105+ in (m0, BiMultiMap m1 r1)
106+
107+-- | Like 'partitionWithKeyBy1st' but the predicates takes the second component
108+-- of the triplets as first argument.
109+partitionWithKeyBy2nd :: (Ord a, Ord b, Ord v)
110+ => (b -> Set (a, v) -> Bool) -> BiMultiMap a b v
111+ -> (Map b (Set (a, v)), BiMultiMap a b v)
112+partitionWithKeyBy2nd p b = let (m, b') = partitionWithKeyBy1st p $ flip b
113+ in (m, flip b')
114+
115+-- | Exchange the first and the second components of all triplets.
116+flip :: BiMultiMap a b v -> BiMultiMap b a v
117+flip (BiMultiMap m r) = BiMultiMap r m
118+
119+-- Internal functions
120+
121+-- | @reverseDelete a bs m@ removes from @m@ all the triplets wich have @a@ as
122+-- first component and second and third components in @bs@.
123+--
124+-- The @m@ map is in reversed form, meaning that the second component of the
125+-- triplets is used as key.
126+reverseDelete :: (Ord a, Ord b, Ord v)
127+ => a -> [(b, v)] -> Map b (Set (a, v)) -> Map b (Set (a, v))
128+reverseDelete a bs r = foldl' (\rr (b, v) -> Map.update (rmb v) b rr) r bs
129+ where
130+ rmb v = nothingWhen Set.null . Set.delete (a, v)
131+
132+-- | @nothingWhen p a@ is @Just a@ when @a@ satisfies predicate @p@.
133+-- Yields @Nothing@ otherwise.
134+nothingWhen :: (a -> Bool) -> a -> Maybe a
135+nothingWhen p a = if p a then Nothing else Just a
src/Control/Distributed/Process/Internal/CQueue.hs+72−15
@@ -1,13 +1,18 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveFunctor #-}
3+{-# LANGUAGE BangPatterns #-}
4+{-# LANGUAGE MagicHash, UnboxedTuples, PatternGuards, ScopedTypeVariables, RankNTypes #-}
15-- | Concurrent queue for single reader, single writer
2−{-# LANGUAGE MagicHash, UnboxedTuples, PatternGuards #-}
36module Control.Distributed.Process.Internal.CQueue
47 ( CQueue
58 , BlockSpec(..)
69 , MatchOn(..)
710 , newCQueue
811 , enqueue
12+ , enqueueSTM
913 , dequeue
1014 , mkWeakCQueue
15+ , queueSize
1116 ) where
1217
1318import Prelude hiding (length, reverse)
@@ -15,10 +20,14 @@ import Control.Concurrent.STM
1520 ( atomically
1621 , STM
1722 , TChan
23+ , TVar
24+ , modifyTVar'
1825 , tryReadTChan
1926 , newTChan
27+ , newTVarIO
2028 , writeTChan
2129 , readTChan
30+ , readTVarIO
2231 , orElse
2332 , retry
2433 )
@@ -36,35 +45,56 @@ import Control.Distributed.Process.Internal.StrictList
3645 , append
3746 )
3847import Data.Maybe (fromJust)
48+import Data.Traversable (traverse)
3949import GHC.MVar (MVar(MVar))
40−import GHC.IO (IO(IO))
41−import GHC.Prim (mkWeak#)
50+import GHC.IO (IO(IO), unIO)
51+import GHC.Exts (mkWeak#)
4252import GHC.Weak (Weak(Weak))
4353
4454-- We use a TCHan rather than a Chan so that we have a non-blocking read
4555data CQueue a = CQueue (StrictMVar (StrictList a)) -- Arrived
4656 (TChan a) -- Incoming
57+ (TVar Int) -- Queue size
4758
4859newCQueue :: IO (CQueue a)
49−newCQueue = CQueue <$> newMVar Nil <*> atomically newTChan
60+newCQueue = CQueue <$> newMVar Nil <*> atomically newTChan <*> newTVarIO 0
5061
5162-- | Enqueue an element
5263--
5364-- Enqueue is strict.
5465enqueue :: CQueue a -> a -> IO ()
55−enqueue (CQueue _arrived incoming) !a = atomically $ writeTChan incoming a
66+enqueue c !a = atomically (enqueueSTM c a)
67+
68+-- | Variant of enqueue for use in the STM monad.
69+enqueueSTM :: CQueue a -> a -> STM ()
70+enqueueSTM (CQueue _arrived incoming size) !a = do
71+ writeTChan incoming a
72+ modifyTVar' size succ
5673
5774data BlockSpec =
5875 NonBlocking
5976 | Blocking
6077 | Timeout Int
6178
79+-- Match operations
80+--
81+-- They can be either a message match or a channel match.
6282data MatchOn m a
6383 = MatchMsg (m -> Maybe a)
6484 | MatchChan (STM a)
85+ deriving (Functor)
6586
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.
6692type MatchChunks m a = [Either [m -> Maybe a] [STM a]]
6793
94+-- Splits a list of matches into chunks.
95+--
96+-- > concatMap (either (map MatchMsg) (map MatchChan)) . chunkMatches == id
97+--
6898chunkMatches :: [MatchOn m a] -> MatchChunks m a
6999chunkMatches [] = []
70100chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
@@ -72,6 +102,7 @@ chunkMatches (MatchMsg m : ms) = Left (m : chk) : chunkMatches rest
72102chunkMatches (MatchChan r : ms) = Right (r : chk) : chunkMatches rest
73103 where (chk, rest) = spanMatchChan ms
74104
105+-- | @spanMatchMsg = first (map (\(MatchMsg x) -> x)) . span isMatchMsg@
75106spanMatchMsg :: [MatchOn m a] -> ([m -> Maybe a], [MatchOn m a])
76107spanMatchMsg [] = ([],[])
77108spanMatchMsg (m : ms)
@@ -79,6 +110,7 @@ spanMatchMsg (m : ms)
79110 | otherwise = ([], m:ms)
80111 where !(msgs,rest) = spanMatchMsg ms
81112
113+-- | @spanMatchMsg = first (map (\(MatchChan x) -> x)) . span isMatchChan@
82114spanMatchChan :: [MatchOn m a] -> ([STM a], [MatchOn m a])
83115spanMatchChan [] = ([],[])
84116spanMatchChan (m : ms)
@@ -95,7 +127,7 @@ dequeue :: forall m a.
95127 -> BlockSpec -- ^ Blocking behaviour
96128 -> [MatchOn m a] -- ^ List of matches
97129 -> IO (Maybe a) -- ^ 'Nothing' only on timeout
98−dequeue (CQueue arrived incoming) blockSpec matchons =
130+dequeue (CQueue arrived incoming size) blockSpec matchons = mask_ $ decrementJust $
99131 case blockSpec of
100132 Timeout n -> timeout n $ fmap fromJust run
101133 _other ->
@@ -107,9 +139,17 @@ dequeue (CQueue arrived incoming) blockSpec matchons =
107139 -- no onException needed
108140 _other -> run
109141 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+
110150 chunks = chunkMatches matchons
111151
112− run = mask_ $ do
152+ run = do
113153 arr <- takeMVar arrived
114154 let grabNew xs = do
115155 r <- atomically $ tryReadTChan incoming
@@ -119,17 +159,25 @@ dequeue (CQueue arrived incoming) blockSpec matchons =
119159 arr' <- grabNew arr
120160 goCheck chunks arr'
121161
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))
122166 waitChans ports on_block =
123− foldr orElse on_block (map (fmap Just) ports)
167+ foldr orElse on_block (map (fmap (Just . Left)) ports)
124168
125169 --
126170 -- First check the MatchChunks against the messages already in the
127171 -- mailbox. For channel matches, we do a non-blocking check at
128172 -- this point.
129173 --
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+ --
130178 goCheck :: MatchChunks m a
131179 -> StrictList m -- messages to check, in this order
132− -> IO (Maybe a)
180+ -> IO (Maybe (Either a a))
133181
134182 goCheck [] old = goWait old
135183
@@ -146,7 +194,7 @@ dequeue (CQueue arrived incoming) blockSpec matchons =
146194 -- of passing around restore and setting up exception handlers is
147195 -- high. So just don't use expensive matchIfs!
148196 case checkArrived matches old of
149− (old', Just r) -> returnOld old' (Just r)
197+ (old', Just r) -> returnOld old' (Just (Right r))
150198 (old', Nothing) -> goCheck rest old'
151199 -- use the result list, which is now left-biased
152200
@@ -175,6 +223,7 @@ dequeue (CQueue arrived incoming) blockSpec matchons =
175223 -- Contents of 'arrived' from now on is (old ++ new), and
176224 -- messages that arrive are snocced onto new.
177225 --
226+ goWait :: StrictList m -> IO (Maybe (Either a a))
178227 goWait old = do
179228 r <- waitIncoming `onException` putMVar arrived old
180229 case r of
@@ -192,7 +241,7 @@ dequeue (CQueue arrived incoming) blockSpec matchons =
192241 --
193242 -- Right => message arrived on a channel first
194243 --
195− Right a -> returnOld old (Just a)
244+ Right a -> returnOld old (Just (Left a))
196245
197246 --
198247 -- A message arrived in the process inbox; check the MatchChunks for
@@ -201,7 +250,7 @@ dequeue (CQueue arrived incoming) blockSpec matchons =
201250 goCheck1 :: MatchChunks m a
202251 -> m -- single message to check
203252 -> StrictList m -- old messages we have already checked
204− -> IO (Maybe a)
253+ -> IO (Maybe (Either a a))
205254
206255 goCheck1 [] m old = goWait (Snoc old m)
207256
@@ -214,16 +263,17 @@ dequeue (CQueue arrived incoming) blockSpec matchons =
214263 goCheck1 (Left matches : rest) m old = do
215264 case checkMatches matches m of
216265 Nothing -> goCheck1 rest m old
217− Just p -> returnOld old (Just p)
266+ Just p -> returnOld old (Just (Right p))
218267
219268 -- a common pattern for putting back the arrived queue at the end
220− returnOld :: StrictList m -> Maybe a -> IO (Maybe a)
269+ returnOld :: StrictList m -> Maybe (Either a a) -> IO (Maybe (Either a a))
221270 returnOld old r = do putMVar arrived old; return r
222271
223272 -- as a side-effect, this left-biases the list
224273 checkArrived :: [m -> Maybe a] -> StrictList m -> (StrictList m, Maybe a)
225274 checkArrived matches list = go list Nil
226275 where
276+ -- @go xs ys@ searches for a message match in @append xs ys@
227277 go Nil Nil = (Nil, Nothing)
228278 go Nil r = go r Nil
229279 go (Append xs ys) tl = go xs (append ys tl)
@@ -239,5 +289,12 @@ dequeue (CQueue arrived incoming) blockSpec matchons =
239289
240290-- | Weak reference to a CQueue
241291mkWeakCQueue :: CQueue a -> IO () -> IO (Weak (CQueue a))
242−mkWeakCQueue m@(CQueue (StrictMVar (MVar m#)) _) f = IO $ \s ->
292+mkWeakCQueue m@(CQueue (StrictMVar (MVar m#)) _ _) f = IO $ \s ->
293+#if MIN_VERSION_base(4,9,0)
294+ case mkWeak# m# m (unIO f) s of (# s1, w #) -> (# s1, Weak w #)
295+#else
243296 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+27−8
@@ -1,3 +1,5 @@
1+{-# LANGUAGE ScopedTypeVariables #-}
2+{-# LANGUAGE RankNTypes #-}
13module Control.Distributed.Process.Internal.Closure.BuiltIn
24 ( -- * Remote table
35 remoteTable
@@ -6,6 +8,8 @@ module Control.Distributed.Process.Internal.Closure.BuiltIn
68 , sdictUnit
79 , sdictProcessId
810 , sdictSendPort
11+ , sdictStatic
12+ , sdictClosure
913 -- * Some static values
1014 , sndStatic
1115 -- * The CP type and associated combinators
@@ -24,7 +28,7 @@ module Control.Distributed.Process.Internal.Closure.BuiltIn
2428 , cpExpect
2529 , cpNewChan
2630 -- * Support for some CH operations
27− , cpDelay
31+ , cpDelayed
2832 , cpEnableTraceRemote
2933 ) where
3034
@@ -48,6 +52,7 @@ import Control.Distributed.Static
4852import Control.Distributed.Process.Serializable
4953 ( SerializableDict(..)
5054 , Serializable
55+ , TypeableDict(..)
5156 )
5257import Control.Distributed.Process.Internal.Types
5358 ( Process
@@ -80,6 +85,8 @@ remoteTable =
8085 . registerStatic "$sdictUnit" (toDynamic (SerializableDict :: SerializableDict ()))
8186 . registerStatic "$sdictProcessId" (toDynamic (SerializableDict :: SerializableDict ProcessId))
8287 . 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)))
8390 . registerStatic "$returnProcess" (toDynamic (return :: ANY -> Process ANY))
8491 . registerStatic "$seqProcess" (toDynamic ((>>) :: Process ANY1 -> Process ANY2 -> Process ANY2))
8592 . registerStatic "$bindProcess" (toDynamic ((>>=) :: Process ANY1 -> (ANY1 -> Process ANY2) -> Process ANY2))
@@ -100,6 +107,12 @@ remoteTable =
100107 sdictSendPort_ :: forall a. SerializableDict a -> SerializableDict (SendPort a)
101108 sdictSendPort_ SerializableDict = SerializableDict
102109
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+
103116 sendDict :: forall a. SerializableDict a -> ProcessId -> a -> Process ()
104117 sendDict SerializableDict = send
105118
@@ -142,6 +155,14 @@ sdictSendPort :: Typeable a
142155 => Static (SerializableDict a) -> Static (SerializableDict (SendPort a))
143156sdictSendPort = staticApply (staticLabel "$sdictSendPort_")
144157
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+
145166--------------------------------------------------------------------------------
146167-- Static values --
147168--------------------------------------------------------------------------------
@@ -274,19 +295,20 @@ cpEnableTraceRemote =
274295-- | @delay them p@ is a process that waits for a signal (a message of type @()@)
275296-- from 'them' (origin is not verified) before proceeding as @p@. In order to
276297-- avoid waiting forever, @delay them p@ monitors 'them'. If it receives a
277−-- monitor message instead it simply terminates.
298+-- monitor message instead, it proceeds as @p@ too.
278299delay :: ProcessId -> Process () -> Process ()
279300delay them p = do
280301 ref <- monitor them
281302 let sameRef (ProcessMonitorNotification ref' _ _) = ref == ref'
282303 receiveWait [
283− match $ \() -> unmonitor ref >> p
304+ match $ \() -> unmonitor ref
284305 , matchIf sameRef $ \_ -> return ()
285306 ]
307+ p
286308
287309-- | 'CP' version of 'delay'
288−cpDelay :: ProcessId -> Closure (Process ()) -> Closure (Process ())
289−cpDelay = closureApply . cpDelay'
310+cpDelayed :: ProcessId -> Closure (Process ()) -> Closure (Process ())
311+cpDelayed = closureApply . cpDelay'
290312 where
291313 cpDelay' :: ProcessId -> Closure (Process () -> Process ())
292314 cpDelay' pid = closure decoder (encode pid)
@@ -296,6 +318,3 @@ cpDelay = closureApply . cpDelay'
296318
297319 delayStatic :: Static (ProcessId -> Process () -> Process ())
298320 delayStatic = staticLabel "$delay"
299−
300−
301−
src/Control/Distributed/Process/Internal/Closure/Explicit.hsnew file+147
@@ -0,0 +1,147 @@
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+24−8
@@ -1,5 +1,5 @@
11-- | Template Haskell support
2−{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE TemplateHaskell, CPP #-}
33module Control.Distributed.Process.Internal.Closure.TH
44 ( -- * User-level API
55 remotable
@@ -29,7 +29,14 @@ import Language.Haskell.TH
2929 , Type(AppT, ForallT, VarT, ArrowT)
3030 , Info(VarI)
3131 , TyVarBndr(PlainTV, KindedTV)
32− , Pred(ClassP)
32+ , Pred
33+#if MIN_VERSION_template_haskell(2,10,0)
34+ , conT
35+ , appT
36+#else
37+ , classP
38+#endif
39+ , varT
3340 -- Lifted constructors
3441 -- .. Literals
3542 , stringL
@@ -244,16 +251,21 @@ generateStatic :: Name -> [TyVarBndr] -> Type -> Q [Dec]
244251generateStatic n xs typ = do
245252 staticTyp <- [t| Static |]
246253 sequence
247− [ sigD (staticName n) $
254+ [ sigD (staticName n) $ do
255+ txs <- sequence $ map typeable xs
248256 return (ForallT xs
249− (map typeable xs)
250− (staticTyp `AppT` typ)
251− )
257+ txs
258+ (staticTyp `AppT` typ))
252259 , sfnD (staticName n) [| staticLabel $(showFQN n) |]
253260 ]
254261 where
255− typeable :: TyVarBndr -> Pred
256− typeable tv = ClassP (mkName "Typeable") [VarT (tyVarBndrName tv)]
262+ typeable :: TyVarBndr -> Q Pred
263+ typeable tv =
264+#if MIN_VERSION_template_haskell(2,10,0)
265+ conT (mkName "Typeable") `appT` varT (tyVarBndrName tv)
266+#else
267+ classP (mkName "Typeable") [varT (tyVarBndrName tv)]
268+#endif
257269
258270-- | Generate a serialization dictionary with name 'n' for type 'typ'
259271generateDict :: Name -> Type -> Q [Dec]
@@ -291,7 +303,11 @@ getType :: Name -> Q (Name, Type)
291303getType name = do
292304 info <- reify name
293305 case info of
306+#if MIN_VERSION_template_haskell(2,11,0)
307+ VarI origName typ _ -> return (origName, typ)
308+#else
294309 VarI origName typ _ _ -> return (origName, typ)
310+#endif
295311 _ -> fail $ show name ++ " not found"
296312
297313-- | Variation on 'funD' which takes a single expression to define the function
src/Control/Distributed/Process/Internal/Messaging.hs+63−25
@@ -5,6 +5,7 @@ module Control.Distributed.Process.Internal.Messaging
55 , disconnect
66 , closeImplicitReconnections
77 , impliesDeathOf
8+ , sendCtrlMsg
89 ) where
910
1011import Data.Accessor ((^.), (^=))
@@ -12,9 +13,14 @@ import Data.Binary (Binary, encode)
1213import qualified Data.Map as Map (partitionWithKey, elems)
1314import qualified Data.ByteString.Lazy as BSL (toChunks)
1415import qualified Data.ByteString as BSS (ByteString)
15−import Control.Distributed.Process.Internal.StrictMVar (withMVar, modifyMVar_)
16+import Control.Distributed.Process.Serializable ()
17+
18+import Control.Concurrent (forkIO)
1619import Control.Concurrent.Chan (writeChan)
20+import Control.Exception (mask_)
1721import Control.Monad (unless)
22+import Control.Monad.IO.Class (liftIO)
23+import Control.Monad.Reader (ask)
1824import qualified Network.Transport as NT
1925 ( Connection
2026 , send
@@ -24,7 +30,10 @@ import qualified Network.Transport as NT
2430 , close
2531 )
2632import Control.Distributed.Process.Internal.Types
27− ( LocalNode(localState, localEndPoint, localCtrlChan)
33+ ( LocalNode(localEndPoint, localCtrlChan)
34+ , withValidLocalState
35+ , modifyValidLocalState
36+ , modifyValidLocalState_
2837 , Identifier
2938 , localConnections
3039 , localConnectionBetween
@@ -36,12 +45,16 @@ import Control.Distributed.Process.Internal.Types
3645 , ProcessSignal(Died)
3746 , DiedReason(DiedDisconnect)
3847 , ImplicitReconnect(WithImplicitReconnect)
39− , NodeId
40− , ProcessId(processNodeId)
48+ , NodeId(..)
49+ , ProcessId(..)
50+ , LocalNode(..)
51+ , LocalProcess(..)
52+ , Process(..)
4153 , SendPortId(sendPortProcessId)
4254 , Identifier(NodeIdentifier, ProcessIdentifier, SendPortIdentifier)
4355 )
4456import Control.Distributed.Process.Serializable (Serializable)
57+import Data.Foldable (forM_)
4558
4659--------------------------------------------------------------------------------
4760-- Message sending --
@@ -65,7 +78,7 @@ sendPayload node from to implicitReconnect payload = do
6578 unless didSend $ do
6679 writeChan (localCtrlChan node) NCMsg
6780 { ctrlMsgSender = to
68− , ctrlMsgSignal = Died to DiedDisconnect
81+ , ctrlMsgSignal = Died (NodeIdentifier $ nodeOf to) DiedDisconnect
6982 }
7083
7184sendBinary :: Binary a
@@ -94,7 +107,7 @@ setupConnBetween :: LocalNode
94107 -> ImplicitReconnect
95108 -> IO (Maybe NT.Connection)
96109setupConnBetween node from to implicitReconnect = do
97− mConn <- NT.connect endPoint
110+ mConn <- NT.connect (localEndPoint node)
98111 (nodeAddress . nodeOf $ to)
99112 NT.ReliableOrdered
100113 NT.defaultConnectHints
@@ -105,14 +118,11 @@ setupConnBetween node from to implicitReconnect = do
105118 Left _ ->
106119 return Nothing
107120 Right () -> do
108− modifyMVar_ nodeState $ return .
109− (localConnectionBetween from to ^= Just (conn, implicitReconnect))
121+ modifyValidLocalState_ node $
122+ return . (localConnectionBetween from to ^= Just (conn, implicitReconnect))
110123 return $ Just conn
111124 Left _ ->
112125 return Nothing
113− where
114− endPoint = localEndPoint node
115− nodeState = localState node
116126
117127connBetween :: LocalNode
118128 -> Identifier
@@ -120,33 +130,37 @@ connBetween :: LocalNode
120130 -> ImplicitReconnect
121131 -> IO (Maybe NT.Connection)
122132connBetween node from to implicitReconnect = do
123− mConn <- withMVar nodeState $ return . (^. localConnectionBetween from to)
133+ mConn <- withValidLocalState node $
134+ return . (^. localConnectionBetween from to)
124135 case mConn of
125136 Just (conn, _) ->
126137 return $ Just conn
127138 Nothing ->
128139 setupConnBetween node from to implicitReconnect
129− where
130− nodeState = localState node
131140
132141disconnect :: LocalNode -> Identifier -> Identifier -> IO ()
133−disconnect node from to =
134− modifyMVar_ (localState node) $ \st ->
135− case st ^. localConnectionBetween from to of
142+disconnect node from to = mask_ $ do
143+ mio <- modifyValidLocalState node $ \vst ->
144+ case vst ^. localConnectionBetween from to of
136145 Nothing ->
137− return st
146+ return (vst, return ())
138147 Just (conn, _) -> do
139− NT.close conn
140− return (localConnectionBetween from to ^= Nothing $ st)
148+ return ( localConnectionBetween from to ^= Nothing $ vst
149+ , NT.close conn
150+ )
151+ forM_ mio forkIO
141152
142153closeImplicitReconnections :: LocalNode -> Identifier -> IO ()
143−closeImplicitReconnections node to =
144− modifyMVar_ (localState node) $ \st -> do
154+closeImplicitReconnections node to = mask_ $ do
155+ mconns <- modifyValidLocalState node $ \vst -> do
145156 let shouldClose (_, to') (_, WithImplicitReconnect) = to `impliesDeathOf` to'
146157 shouldClose _ _ = False
147− let (affected, unaffected) = Map.partitionWithKey shouldClose (st ^. localConnections)
148− mapM_ (NT.close . fst) (Map.elems affected)
149− return (localConnections ^= unaffected $ st)
158+ let (affected, unaffected) =
159+ Map.partitionWithKey shouldClose (vst ^. localConnections)
160+ return ( localConnections ^= unaffected $ vst
161+ , map fst $ Map.elems affected
162+ )
163+ forM_ mconns $ forkIO . mapM_ NT.close
150164
151165-- | @a `impliesDeathOf` b@ is true if the death of @a@ (for instance, a node)
152166-- implies the death of @b@ (for instance, a process on that node)
@@ -167,3 +181,27 @@ SendPortIdentifier cid `impliesDeathOf` SendPortIdentifier cid' =
167181 cid' == cid
168182_ `impliesDeathOf` _ =
169183 False
184+
185+
186+-- Send a control message. Evaluates the message to HNF before sending it.
187+--
188+-- The message shouldn't produce more errors when further evaluated. If
189+-- evaluation threw errors the node controller or the receiver would crash when
190+-- inspecting it.
191+sendCtrlMsg :: Maybe NodeId -- ^ Nothing for the local node
192+ -> ProcessSignal -- ^ Message to send
193+ -> Process ()
194+sendCtrlMsg mNid signal = do
195+ proc <- ask
196+ let msg = NCMsg { ctrlMsgSender = ProcessIdentifier (processId proc)
197+ , ctrlMsgSignal = signal
198+ }
199+ case mNid of
200+ Nothing -> do
201+ liftIO $ writeChan (localCtrlChan (processNode proc)) $! msg
202+ Just nid ->
203+ liftIO $ sendBinary (processNode proc)
204+ (NodeIdentifier (processNodeId $ processId proc))
205+ (NodeIdentifier nid)
206+ WithImplicitReconnect
207+ msg
src/Control/Distributed/Process/Internal/Primitives.hs+411−171
@@ -1,3 +1,9 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE RankNTypes #-}
3+{-# LANGUAGE DeriveDataTypeable #-}
4+{-# LANGUAGE DeriveFunctor #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE ExistentialQuantification #-}
17{-# LANGUAGE BangPatterns #-}
28
39-- | Cloud Haskell primitives
@@ -7,6 +13,7 @@
713module Control.Distributed.Process.Internal.Primitives
814 ( -- * Basic messaging
915 send
16+ , usend
1017 , expect
1118 -- * Channels
1219 , newChan
@@ -14,6 +21,12 @@ module Control.Distributed.Process.Internal.Primitives
1421 , receiveChan
1522 , mergePortsBiased
1623 , mergePortsRR
24+ -- * Unsafe messaging variants
25+ , unsafeSend
26+ , unsafeUSend
27+ , unsafeSendChan
28+ , unsafeNSend
29+ , unsafeNSendRemote
1730 -- * Advanced messaging
1831 , Match
1932 , receiveWait
@@ -24,13 +37,19 @@ module Control.Distributed.Process.Internal.Primitives
2437 , matchAny
2538 , matchAnyIf
2639 , matchChan
40+ , matchSTM
2741 , matchMessage
2842 , matchMessageIf
43+ , isEncoded
2944 , wrapMessage
30− , wrapMessageLocal
45+ , unsafeWrapMessage
3146 , unwrapMessage
3247 , handleMessage
48+ , handleMessageIf
49+ , handleMessage_
50+ , handleMessageIf_
3351 , forward
52+ , uforward
3453 , delegate
3554 , relay
3655 , proxy
@@ -49,13 +68,19 @@ module Control.Distributed.Process.Internal.Primitives
4968 , getSelfNode
5069 , ProcessInfo(..)
5170 , getProcessInfo
71+ , NodeStats(..)
72+ , getNodeStats
73+ , getLocalNodeStats
5274 -- * Monitoring and linking
5375 , link
5476 , unlink
5577 , monitor
5678 , unmonitor
79+ , unmonitorAsync
5780 , withMonitor
81+ , withMonitor_
5882 -- * Logging
83+ , SayMessage(..)
5984 , say
6085 -- * Registry
6186 , register
@@ -77,6 +102,7 @@ module Control.Distributed.Process.Internal.Primitives
77102 , catches
78103 , try
79104 , mask
105+ , mask_
80106 , onException
81107 , bracket
82108 , bracket_
@@ -94,29 +120,40 @@ module Control.Distributed.Process.Internal.Primitives
94120 -- * Reconnecting
95121 , reconnect
96122 , reconnectPort
123+ -- * Internal Exports
124+ , sendCtrlMsg
97125 ) where
98126
99127#if ! MIN_VERSION_base(4,6,0)
100128import Prelude hiding (catch)
101129#endif
102130
103−import Data.Binary (decode)
104−import Data.Time.Clock (getCurrentTime)
131+import Data.Binary (Binary(..), Put, Get, decode)
132+import Data.Time.Clock (getCurrentTime, UTCTime(..))
133+import Data.Time.Calendar (Day(..))
105134import Data.Time.Format (formatTime)
135+#if MIN_VERSION_time(1,5,0)
136+import Data.Time.Format (defaultTimeLocale)
137+#else
106138import System.Locale (defaultTimeLocale)
139+#endif
107140import System.Timeout (timeout)
108−import Control.Monad (when)
141+import Control.Monad (when, void)
109142import Control.Monad.Reader (ask)
110−import Control.Monad.IO.Class (MonadIO, liftIO)
111−import Control.Applicative ((<$>))
112−import Control.Exception (Exception(..), throw, throwIO, SomeException)
113−import qualified Control.Exception as Ex (catch, mask, try)
143+import Control.Monad.IO.Class (liftIO)
144+import Control.Monad.Catch
145+ ( Exception
146+ , SomeException
147+ , throwM
148+ , fromException
149+ )
150+import qualified Control.Monad.Catch as Catch
151+import Control.Applicative
114152import Control.Distributed.Process.Internal.StrictMVar
115153 ( StrictMVar
116154 , modifyMVar
117155 , modifyMVar_
118156 )
119−import Control.Concurrent.Chan (writeChan)
120157import Control.Concurrent.STM
121158 ( STM
122159 , TVar
@@ -134,20 +171,12 @@ import Control.Distributed.Process.Internal.CQueue
134171import Control.Distributed.Process.Serializable (Serializable, fingerprint)
135172import Data.Accessor ((^.), (^:), (^=))
136173import Control.Distributed.Static
137− ( RemoteTable
138− , registerStatic
139− , Static
140− , staticLabel
141− , staticApply
174+ ( Static
142175 , Closure
143− , closure
144− , closureApplyStatic
145− , closureApply
146− , staticCompose
147− , staticClosure
148176 )
149177import Data.Rank1Typeable (Typeable)
150178import qualified Control.Distributed.Static as Static (unstatic, unclosure)
179+import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
151180import Control.Distributed.Process.Internal.Types
152181 ( NodeId(..)
153182 , ProcessId(..)
@@ -157,8 +186,9 @@ import Control.Distributed.Process.Internal.Types
157186 , Message(..)
158187 , MonitorRef(..)
159188 , SpawnRef(..)
160− , NCMsg(..)
161189 , ProcessSignal(..)
190+ , NodeMonitorNotification(..)
191+ , ProcessMonitorNotification(..)
162192 , monitorCounter
163193 , spawnCounter
164194 , SendPort(..)
@@ -169,6 +199,7 @@ import Control.Distributed.Process.Internal.Types
169199 , SendPortId(..)
170200 , Identifier(..)
171201 , ProcessExitException(..)
202+ , DiedReason(..)
172203 , DidUnmonitor(..)
173204 , DidUnlinkProcess(..)
174205 , DidUnlinkNode(..)
@@ -178,10 +209,11 @@ import Control.Distributed.Process.Internal.Types
178209 , ProcessRegistrationException(..)
179210 , ProcessInfo(..)
180211 , ProcessInfoNone(..)
212+ , NodeStats(..)
213+ , isEncoded
181214 , createMessage
182215 , createUnencodedMessage
183− , runLocalProcess
184− , ImplicitReconnect(WithImplicitReconnect, NoImplicitReconnect)
216+ , ImplicitReconnect( NoImplicitReconnect)
185217 , LocalProcessState
186218 , LocalSendPortId
187219 , messageToPayload
@@ -191,16 +223,20 @@ import Control.Distributed.Process.Internal.Messaging
191223 , sendBinary
192224 , sendPayload
193225 , disconnect
226+ , sendCtrlMsg
194227 )
195−import Control.Distributed.Process.Internal.Trace.Types
228+import Control.Distributed.Process.Management.Internal.Types
229+ ( MxEvent(..)
230+ )
231+import Control.Distributed.Process.Management.Internal.Trace.Types
196232 ( traceEvent
197− , TraceEvent(..)
198233 )
199234import Control.Distributed.Process.Internal.WeakTQueue
200235 ( newTQueueIO
201236 , readTQueue
202237 , mkWeakTQueue
203238 )
239+import Prelude
204240
205241import Unsafe.Coerce
206242
@@ -218,17 +254,50 @@ send them msg = do
218254 node = processNode proc
219255 nodeId = localNodeId node
220256 destNode = (processNodeId them) in do
221− case destNode == nodeId of
222− True -> sendLocal them msg
223− False -> liftIO $ sendMessage (processNode proc)
224− (ProcessIdentifier (processId proc))
225− (ProcessIdentifier them)
226− NoImplicitReconnect
227− msg
228− -- We do not fire the trace event until after the sending is complete;
229− -- In the remote case, 'sendMessage' can block in the networking stack.
230− liftIO $ traceEvent (localTracer node)
231− (TraceEvSent them us (createUnencodedMessage msg))
257+ liftIO $ traceEvent (localEventBus node)
258+ (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+
267+-- | /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
269+-- node) therefore ensure that the payload is fully evaluated before it is
270+-- delivered.
271+unsafeSend :: Serializable a => ProcessId -> a -> Process ()
272+unsafeSend = Unsafe.send
273+
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
232301
233302-- | Wait for a message of a specific type
234303expect :: forall a. Serializable a => Process a
@@ -238,7 +307,13 @@ expect = receiveWait [match return]
238307-- Channels --
239308--------------------------------------------------------------------------------
240309
241−-- | Create a new typed channel
310+-- | Create a new typed channel, bound to the calling Process
311+--
312+-- Note that the channel is bound to the lifecycle of the process that evaluates
313+-- this function, such that when it dies/exits, the channel will no longer
314+-- function, but will remain accessible. Thus reading from the ReceivePort will
315+-- fail silently thereafter, blocking indefinitely (unless a timeout is used).
316+--
242317newChan :: Serializable a => Process (SendPort a, ReceivePort a)
243318newChan = do
244319 proc <- ask
@@ -266,17 +341,27 @@ newChan = do
266341sendChan :: Serializable a => SendPort a -> a -> Process ()
267342sendChan (SendPort cid) msg = do
268343 proc <- ask
269− let node = localNodeId (processNode proc)
270− destNode = processNodeId (sendPortProcessId cid) in do
271− case destNode == node of
344+ let node = processNode proc
345+ pid = processId proc
346+ us = localNodeId node
347+ them = processNodeId (sendPortProcessId cid) in do
348+ liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid $ wrapMessage msg)
349+ case them == us of
272350 True -> sendChanLocal cid msg
273351 False -> do
274− liftIO $ sendBinary (processNode proc)
275− (ProcessIdentifier (processId proc))
352+ liftIO $ sendBinary node
353+ (ProcessIdentifier pid)
276354 (SendPortIdentifier cid)
277355 NoImplicitReconnect
278356 msg
279357
358+-- | Send a message on a typed channel. This function makes /no/ attempt to
359+-- serialize and (in the case when the @ReceivePort@ resides on the same local
360+-- node) therefore ensure that the payload is fully evaluated before it is
361+-- delivered.
362+unsafeSendChan :: Serializable a => SendPort a -> a -> Process ()
363+unsafeSendChan = Unsafe.sendChan
364+
280365-- | Wait for a message on a typed channel
281366receiveChan :: Serializable a => ReceivePort a -> Process a
282367receiveChan = liftIO . atomically . receiveSTM
@@ -320,13 +405,17 @@ mergePortsRR = \ps -> do
320405
321406-- | Opaque type used in 'receiveWait' and 'receiveTimeout'
322407newtype Match b = Match { unMatch :: MatchOn Message (Process b) }
408+ deriving (Functor)
323409
324410-- | Test the matches in order against each message in the queue
325411receiveWait :: [Match b] -> Process b
326412receiveWait ms = do
327413 queue <- processQueue <$> ask
328− Just proc <- liftIO $ dequeue queue Blocking (map unMatch ms)
329− proc
414+ mProc <- liftIO $ dequeue queue Blocking (map unMatch ms)
415+ case mProc of
416+ Just proc' -> proc'
417+ Nothing -> die $ "System Invariant Violation: CQueue.hs returned `Nothing` "
418+ ++ "in the absence of a timeout value."
330419
331420-- | Like 'receiveWait' but with a timeout.
332421--
@@ -342,9 +431,26 @@ receiveTimeout t ms = do
342431 Nothing -> return Nothing
343432 Just proc -> Just <$> proc
344433
434+-- | Match on a typed channel
345435matchChan :: ReceivePort a -> (a -> Process b) -> Match b
346436matchChan p fn = Match $ MatchChan (fmap fn (receiveSTM p))
347437
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+
348454-- | Match against any message of the right type
349455match :: forall a b. Serializable a => (a -> Process b) -> Match b
350456match = matchIf (const True)
@@ -388,41 +494,58 @@ forward msg them = do
388494 us = processId proc
389495 nid = localNodeId node
390496 destNode = (processNodeId them) in do
391− case destNode == nid of
392− True -> sendCtrlMsg Nothing (LocalSend them msg)
393− False -> liftIO $ sendPayload (processNode proc)
394− (ProcessIdentifier (processId proc))
395− (ProcessIdentifier them)
396− NoImplicitReconnect
397− (messageToPayload msg)
398− -- We do not fire the trace event until after the sending is complete;
399− -- In the remote case, 'sendMessage' can block in the networking stack.
400− liftIO $ traceEvent (localTracer node)
401− (TraceEvSent them us (createUnencodedMessage msg))
497+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg)
498+ if destNode == nid
499+ then sendCtrlMsg Nothing (LocalSend them msg)
500+ else liftIO $ sendPayload (processNode proc)
501+ (ProcessIdentifier (processId proc))
502+ (ProcessIdentifier them)
503+ NoImplicitReconnect
504+ (messageToPayload msg)
402505
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
403522
404523-- | Wrap a 'Serializable' value in a 'Message'. Note that 'Message's are
405−-- 'Serializable' - like the datum they contain - but remember that deserializing
406−-- a 'Message' will yield a 'Message', not the type within it! To obtain the
524+-- '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
407526-- wrapped datum, use 'unwrapMessage' or 'handleMessage' with a specific type.
408527--
409528-- @
410529-- do
411−-- self <- getSelfPid
412−-- send self (wrapMessage "blah")
413−-- Nothing <- expectTimeout 1000000 :: Process (Maybe String)
414−-- (Just m) <- expectTimeout 1000000 :: Process (Maybe Message)
415−-- (Just "blah") <- unwrapMessage m :: Process (Maybe String)
530+-- self <- getSelfPid
531+-- send self (wrapMessage "blah")
532+-- Nothing <- expectTimeout 1000000 :: Process (Maybe String)
533+-- (Just m) <- expectTimeout 1000000 :: Process (Maybe Message)
534+-- (Just "blah") <- unwrapMessage m :: Process (Maybe String)
416535-- @
417536--
418537wrapMessage :: Serializable a => a -> Message
419−wrapMessage = createMessage
538+wrapMessage = createUnencodedMessage -- see [note Serializable UnencodedMessage]
420539
421−-- | Like 'wrapMessage', but produces a 'Message' that is only usable in the
422−-- local node. This is primarily useful when consuming the tracing and debugging
423−-- APIs in "Control.Distributed.Process.Debug".
424−wrapMessageLocal :: Serializable a => a -> Message
425−wrapMessageLocal = createUnencodedMessage
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]
546+-- if we attempt to serialise an UnencodedMessage, it will be converted to an
547+-- EncodedMessage first, so we're ok here. See 'messageToPayload' in
548+-- Primitives.hs for the gory details
426549
427550-- | Attempt to unwrap a raw 'Message'.
428551-- If the type of the decoded message payload matches the expected type, the
@@ -435,14 +558,14 @@ wrapMessageLocal = createUnencodedMessage
435558-- Whereas this expression, will yield @Just "foo"@
436559-- > unwrapMessage (wrapMessage "foo") :: Process (Maybe String)
437560--
438−unwrapMessage :: forall a. Serializable a => Message -> Process (Maybe a)
561+unwrapMessage :: forall m a. (Monad m, Serializable a) => Message -> m (Maybe a)
439562unwrapMessage msg =
440563 case messageFingerprint msg == fingerprint (undefined :: a) of
441− False -> return Nothing
564+ False -> return Nothing :: m (Maybe a)
442565 True -> case msg of
443− (UnencodedMessage _ m) ->
444− let m' = unsafeCoerce m :: a
445− in return (Just m')
566+ (UnencodedMessage _ ms) ->
567+ let ms' = unsafeCoerce ms :: a
568+ in return (Just ms')
446569 (EncodedMessage _ _) ->
447570 return (Just (decoded))
448571 where
@@ -458,21 +581,53 @@ unwrapMessage msg =
458581--
459582-- Intended for use in `catchesExit` and `matchAny` primitives.
460583--
461−handleMessage :: forall a b. (Serializable a)
462− => Message -> (a -> Process b) -> Process (Maybe b)
463−handleMessage msg proc = do
584+handleMessage :: forall m a b. (Monad m, Serializable a)
585+ => Message -> (a -> m b) -> m (Maybe b)
586+handleMessage msg proc = handleMessageIf msg (const True) proc
587+
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+--
593+handleMessageIf :: forall m a b . (Monad m, Serializable a)
594+ => Message
595+ -> (a -> Bool)
596+ -> (a -> m b)
597+ -> m (Maybe b)
598+handleMessageIf msg c proc = do
464599 case messageFingerprint msg == fingerprint (undefined :: a) of
465− False -> return Nothing
600+ False -> return Nothing :: m (Maybe b)
466601 True -> case msg of
467− (UnencodedMessage _ m) ->
468− let m' = unsafeCoerce m :: a -- note [decoding]
469− in do { r <- proc m'; return (Just r) }
602+ (UnencodedMessage _ ms) ->
603+ let ms' = unsafeCoerce ms :: a in
604+ case (c ms') of
605+ True -> do { r <- proc ms'; return (Just r) }
606+ False -> return Nothing :: m (Maybe b)
470607 (EncodedMessage _ _) ->
471− do { r <- proc (decoded :: a); return (Just r) }
608+ case (c decoded) of
609+ True -> do { r <- proc (decoded :: a); return (Just r) }
610+ False -> return Nothing :: m (Maybe b)
472611 where
473612 decoded :: a -- note [decoding]
474613 !decoded = decode (messageEncoding msg)
475614
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+
476631-- | Match against an arbitrary message. 'matchAny' removes the first available
477632-- message from the process mailbox. To handle arbitrary /raw/ messages once
478633-- removed from the mailbox, see 'handleMessage' and 'unwrapMessage'.
@@ -528,7 +683,7 @@ delegate pid p = do
528683 ]
529684 delegate pid p
530685
531−-- | A straight relay that simply forwards all messages to the supplied pid.
686+-- | A straight relay that forwards all messages to the supplied pid.
532687relay :: ProcessId -> Process ()
533688relay !pid = receiveWait [ matchAny (\m -> forward m pid) ] >> relay pid
534689
@@ -560,14 +715,17 @@ instance Exception ProcessTerminationException
560715
561716-- | Terminate immediately (throws a ProcessTerminationException)
562717terminate :: Process a
563−terminate = liftIO $ throwIO ProcessTerminationException
718+terminate = throwM ProcessTerminationException
564719
565720-- [Issue #110]
566721-- | Die immediately - throws a 'ProcessExitException' with the given @reason@.
567722die :: Serializable a => a -> Process b
568723die reason = do
724+-- NOTE: We do /not/ want to use UnencodedMessage here, as the exception
725+-- could be decoded by a handler passed to 'catchExit', re-thrown or even
726+-- passed to another process via the tracing mechanism.
569727 pid <- getSelfPid
570− liftIO $ throwIO (ProcessExitException pid (createMessage reason))
728+ throwM (ProcessExitException pid (createMessage reason))
571729
572730-- | Forceful request to kill a process. Where 'exit' provides an exception
573731-- that can be caught and handled, 'kill' throws an unexposed exception type
@@ -600,12 +758,12 @@ catchExit :: forall a b . (Show a, Serializable a)
600758 => Process b
601759 -> (ProcessId -> a -> Process b)
602760 -> Process b
603−catchExit act exitHandler = catch act handleExit
761+catchExit act exitHandler = Catch.catch act handleExit
604762 where
605763 handleExit ex@(ProcessExitException from msg) =
606764 if messageFingerprint msg == fingerprint (undefined :: a)
607765 then exitHandler from decoded
608− else liftIO $ throwIO ex
766+ else throwM ex
609767 where
610768 decoded :: a
611769 -- Make sure the value is fully decoded so that we don't hang to
@@ -615,21 +773,21 @@ catchExit act exitHandler = catch act handleExit
615773-- | Lift 'Control.Exception.catches' (almost).
616774--
617775-- As 'ProcessExitException' stores the exit @reason@ as a typed, encoded
618−-- message, a handler must accept an input of the expected type. In order to
776+-- message, a handler must accept inputs of the expected type. In order to
619777-- handle a list of potentially different handlers (and therefore input types),
620−-- a handler passed to 'catchesExit' must accept 'AbstractMessage' and return
778+-- a handler passed to 'catchesExit' must accept 'Message' and return
621779-- @Maybe@ (i.e., @Just p@ if it handled the exit reason, otherwise @Nothing@).
622780--
623−-- See 'maybeHandleMessage' and 'AsbtractMessage' for more details.
781+-- See 'maybeHandleMessage' and 'Message' for more details.
624782catchesExit :: Process b
625783 -> [(ProcessId -> Message -> (Process (Maybe b)))]
626784 -> Process b
627−catchesExit act handlers = catch act ((flip handleExit) handlers)
785+catchesExit act handlers = Catch.catch act ((flip handleExit) handlers)
628786 where
629787 handleExit :: ProcessExitException
630788 -> [(ProcessId -> Message -> Process (Maybe b))]
631789 -> Process b
632− handleExit ex [] = liftIO $ throwIO ex
790+ handleExit ex [] = throwM ex
633791 handleExit ex@(ProcessExitException from msg) (h:hs) = do
634792 r <- h from msg
635793 case r of
@@ -644,6 +802,31 @@ getSelfPid = processId <$> ask
644802getSelfNode :: Process NodeId
645803getSelfNode = localNodeId . processNode <$> ask
646804
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+
647830-- | Get information about the specified process
648831getProcessInfo :: ProcessId -> Process (Maybe ProcessInfo)
649832getProcessInfo pid =
@@ -713,12 +896,19 @@ monitor = monitor' . ProcessIdentifier
713896-- @withMonitor@ returns, there might still be unreceived monitor
714897-- messages in the queue.
715898--
716−withMonitor :: ProcessId -> Process a -> Process a
717−withMonitor pid code = bracket (monitor pid) unmonitor (\_ -> code)
718− -- unmonitor blocks waiting for the response, so there's a possibility
719− -- that an exception might interrupt withMonitor before the unmonitor
720− -- has completed. I think that's better than making the unmonitor
721− -- uninterruptible.
899+withMonitor :: ProcessId -> (MonitorRef -> Process a) -> Process a
900+withMonitor pid = bracket (monitor pid) unmonitor
901+
902+-- | Establishes temporary monitoring of another process.
903+--
904+-- @withMonitor_ pid code@ sets up monitoring of @pid@ for the duration
905+-- of @code@. Note: although monitoring is no longer active when
906+-- @withMonitor_@ returns, there might still be unreceived monitor
907+-- messages in the queue.
908+--
909+-- Since 0.6.1
910+withMonitor_ :: ProcessId -> Process a -> Process a
911+withMonitor_ p = withMonitor p . const
722912
723913-- | Remove a link
724914--
@@ -756,12 +946,21 @@ unlinkPort sport = do
756946-- | Remove a monitor
757947--
758948-- This has the same synchronous/asynchronous nature as 'unlink'.
949+--
950+-- ProcessMonitorNotification messages for the given MonitorRef are removed from
951+-- the mailbox.
759952unmonitor :: MonitorRef -> Process ()
760953unmonitor ref = do
761954 unmonitorAsync ref
762955 receiveWait [ matchIf (\(DidUnmonitor ref') -> ref' == ref)
763956 (\_ -> return ())
764957 ]
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+ ]
765964
766965--------------------------------------------------------------------------------
767966-- Exception handling --
@@ -769,50 +968,43 @@ unmonitor ref = do
769968
770969-- | Lift 'Control.Exception.catch'
771970catch :: Exception e => Process a -> (e -> Process a) -> Process a
772−catch p h = do
773− lproc <- ask
774− liftIO $ Ex.catch (runLocalProcess lproc p) (runLocalProcess lproc . h)
971+catch = Catch.catch
972+{-# DEPRECATED catch "Use Control.Monad.Catch.catch instead" #-}
775973
776974-- | Lift 'Control.Exception.try'
777975try :: Exception e => Process a -> Process (Either e a)
778−try p = do
779− lproc <- ask
780− liftIO $ Ex.try (runLocalProcess lproc p)
976+try = Catch.try
977+{-# DEPRECATED try "Use Control.Monad.Catch.try instead" #-}
781978
782979-- | Lift 'Control.Exception.mask'
783980mask :: ((forall a. Process a -> Process a) -> Process b) -> Process b
784−mask p = do
785− lproc <- ask
786− liftIO $ Ex.mask $ \restore ->
787− runLocalProcess lproc (p (liftRestore restore))
788− where
789− liftRestore :: (forall a. IO a -> IO a)
790− -> (forall a. Process a -> Process a)
791− liftRestore restoreIO = \p2 -> do
792− ourLocalProc <- ask
793− liftIO $ restoreIO $ runLocalProcess ourLocalProc p2
981+mask = Catch.mask
982+{-# DEPRECATED mask "Use Control.Monad.Catch.mask_ instead" #-}
983+
984+-- | Lift 'Control.Exception.mask_'
985+mask_ :: Process a -> Process a
986+mask_ = Catch.mask_
987+{-# DEPRECATED mask_ "Use Control.Monad.Catch.mask_ instead" #-}
794988
795989-- | Lift 'Control.Exception.onException'
796990onException :: Process a -> Process b -> Process a
797−onException p what = p `catch` \e -> do _ <- what
798− liftIO $ throwIO (e :: SomeException)
991+onException = Catch.onException
992+{-# DEPRECATED onException "Use Control.Monad.Catch.onException instead" #-}
799993
800994-- | Lift 'Control.Exception.bracket'
801995bracket :: Process a -> (a -> Process b) -> (a -> Process c) -> Process c
802−bracket before after thing =
803− mask $ \restore -> do
804− a <- before
805− r <- restore (thing a) `onException` after a
806− _ <- after a
807− return r
996+bracket = Catch.bracket
997+{-# DEPRECATED bracket "Use Control.Monad.Catch.bracket instead" #-}
808998
809999-- | Lift 'Control.Exception.bracket_'
8101000bracket_ :: Process a -> Process b -> Process c -> Process c
811−bracket_ before after thing = bracket before (const after) (const thing)
1001+bracket_ = Catch.bracket_
1002+{-# DEPRECATED bracket_ "Use Control.Monad.Catch.bracket_ instead" #-}
8121003
8131004-- | Lift 'Control.Exception.finally'
8141005finally :: Process a -> Process b -> Process a
815−finally a sequel = bracket_ (return ()) sequel a
1006+finally = Catch.finally
1007+{-# DEPRECATED finally "Use Control.Monad.Catch.finally instead" #-}
8161008
8171009-- | You need this when using 'catches'
8181010data Handler a = forall e . Exception e => Handler (e -> Process a)
@@ -822,10 +1014,10 @@ instance Functor Handler where
8221014
8231015-- | Lift 'Control.Exception.catches'
8241016catches :: Process a -> [Handler a] -> Process a
825−catches proc handlers = proc `catch` catchesHandler handlers
1017+catches proc handlers = proc `Catch.catch` catchesHandler handlers
8261018
8271019catchesHandler :: [Handler a] -> SomeException -> Process a
828−catchesHandler handlers e = foldr tryHandler (throw e) handlers
1020+catchesHandler handlers e = foldr tryHandler (throwM e) handlers
8291021 where tryHandler (Handler handler) res
8301022 = case fromException e of
8311023 Just e' -> handler e'
@@ -845,7 +1037,10 @@ expectTimeout n = receiveTimeout n [match return]
8451037spawnAsync :: NodeId -> Closure (Process ()) -> Process SpawnRef
8461038spawnAsync nid proc = do
8471039 spawnRef <- getSpawnRef
848− sendCtrlMsg (Just nid) $ Spawn proc spawnRef
1040+ node <- getSelfNode
1041+ if nid == node
1042+ then sendCtrlMsg Nothing $ Spawn proc spawnRef
1043+ else sendCtrlMsg (Just nid) $ Spawn proc spawnRef
8491044 return spawnRef
8501045
8511046-- | Monitor a node (asynchronous)
@@ -891,27 +1086,60 @@ unlinkPortAsync (SendPort cid) =
8911086-- Logging --
8921087--------------------------------------------------------------------------------
8931088
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+
8941124-- | Log a string
8951125--
896−-- @say message@ sends a message (time, pid of the current process, message)
897−-- to the process registered as 'logger'. By default, this process simply
898−-- sends the string to 'stderr'. Individual Cloud Haskell backends might
899−-- replace this with a different logger process, however.
1126+-- @say message@ sends a message of type 'SayMessage' with the current time and
1127+-- 'ProcessId' of the current process to the process registered as @logger@. By
1128+-- default, this process simply sends the string to @stderr@. Individual Cloud
1129+-- Haskell backends might replace this with a different logger process, however.
9001130say :: String -> Process ()
9011131say string = do
9021132 now <- liftIO getCurrentTime
9031133 us <- getSelfPid
904− nsend "logger" (formatTime defaultTimeLocale "%c" now, us, string)
1134+ nsend "logger" (SayMessage now us string)
9051135
9061136--------------------------------------------------------------------------------
9071137-- Registry --
9081138--------------------------------------------------------------------------------
9091139
910−-- | Register a process with the local registry (asynchronous).
911−-- This version will wait until a response is gotten from the
912−-- management process. The name must not already be registered.
913−-- The process need not be on this node.
914−-- A bad registration will result in a 'ProcessRegistrationException'
1140+-- | Register a process with the local registry (synchronous). The name must not
1141+-- already be registered. The process need not be on this node. A bad
1142+-- registration will result in a 'ProcessRegistrationException'
9151143--
9161144-- The process to be registered does not have to be local itself.
9171145register :: String -> ProcessId -> Process ()
@@ -926,9 +1154,10 @@ registerImpl :: Bool -> String -> ProcessId -> Process ()
9261154registerImpl force label pid = do
9271155 mynid <- getSelfNode
9281156 sendCtrlMsg Nothing (Register label mynid (Just pid) force)
929− receiveWait [ matchIf (\(RegisterReply label' _) -> label == label')
930− (\(RegisterReply _ ok) -> handleRegistrationReply label ok)
931− ]
1157+ receiveWait
1158+ [ matchIf (\(RegisterReply label' _ _) -> label == label')
1159+ (\(RegisterReply _ ok owner) -> handleRegistrationReply label ok owner)
1160+ ]
9321161
9331162-- | Register a process with a remote registry (asynchronous).
9341163--
@@ -937,8 +1166,10 @@ registerImpl force label pid = do
9371166--
9381167-- See comments in 'whereisRemoteAsync'
9391168registerRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
940−registerRemoteAsync nid label pid =
941− sendCtrlMsg (Just nid) (Register label nid (Just pid) False)
1169+registerRemoteAsync nid label pid = do
1170+ here <- getSelfNode
1171+ sendCtrlMsg (if nid == here then Nothing else Just nid)
1172+ (Register label nid (Just pid) False)
9421173
9431174reregisterRemoteAsync :: NodeId -> String -> ProcessId -> Process ()
9441175reregisterRemoteAsync nid label pid =
@@ -951,16 +1182,17 @@ unregister :: String -> Process ()
9511182unregister label = do
9521183 mynid <- getSelfNode
9531184 sendCtrlMsg Nothing (Register label mynid Nothing False)
954− receiveWait [ matchIf (\(RegisterReply label' _) -> label == label')
955− (\(RegisterReply _ ok) -> handleRegistrationReply label ok)
956− ]
1185+ receiveWait
1186+ [ matchIf (\(RegisterReply label' _ _) -> label == label')
1187+ (\(RegisterReply _ ok owner) -> handleRegistrationReply label ok owner)
1188+ ]
9571189
9581190-- | Deal with the result from an attempted registration or unregistration
9591191-- by throwing an exception if necessary
960−handleRegistrationReply :: String -> Bool -> Process ()
961−handleRegistrationReply label ok =
1192+handleRegistrationReply :: String -> Bool -> Maybe ProcessId -> Process ()
1193+handleRegistrationReply label ok owner =
9621194 when (not ok) $
963− liftIO $ throwIO $ ProcessRegistrationException label
1195+ throwM $ ProcessRegistrationException label owner
9641196
9651197-- | Remove a process from a remote registry (asynchronous).
9661198--
@@ -989,18 +1221,45 @@ whereis label = do
9891221-- use 'monitorNode' and take appropriate action when you receive a
9901222-- 'NodeMonitorNotification').
9911223whereisRemoteAsync :: NodeId -> String -> Process ()
992−whereisRemoteAsync nid label =
993− sendCtrlMsg (Just nid) (WhereIs label)
1224+whereisRemoteAsync nid label = do
1225+ here <- getSelfNode
1226+ sendCtrlMsg (if nid == here then Nothing else Just nid) (WhereIs label)
9941227
9951228-- | Named send to a process in the local registry (asynchronous)
9961229nsend :: Serializable a => String -> a -> Process ()
997−nsend label msg =
998− sendCtrlMsg Nothing (NamedSend label (createUnencodedMessage msg))
1230+nsend label msg = do
1231+ proc <- ask
1232+ let msg' = createUnencodedMessage msg
1233+ liftIO $ traceEvent (localEventBus (processNode proc))
1234+ (MxSentToName label (processId proc) msg')
1235+ sendCtrlMsg Nothing (NamedSend label msg')
1236+
1237+-- | Named send to a process in the local registry (asynchronous).
1238+-- This function makes /no/ attempt to serialize and (in the case when the
1239+-- destination process resides on the same local node) therefore ensure that
1240+-- the payload is fully evaluated before it is delivered.
1241+unsafeNSend :: Serializable a => String -> a -> Process ()
1242+unsafeNSend = Unsafe.nsend
9991243
10001244-- | Named send to a process in a remote registry (asynchronous)
10011245nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
1002−nsendRemote nid label msg =
1003− sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
1246+nsendRemote nid label msg = do
1247+ proc <- ask
1248+ let us = processId proc
1249+ let node = processNode proc
1250+ if localNodeId node == nid
1251+ then nsend label msg
1252+ else let lbl = label ++ "@" ++ show nid in do
1253+ liftIO $ traceEvent (localEventBus node)
1254+ (MxSentToName lbl us (wrapMessage msg))
1255+ sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
1256+
1257+-- | Named send to a process in a remote registry (asynchronous)
1258+-- This function makes /no/ attempt to serialize and (in the case when the
1259+-- destination process resides on the same local node) therefore ensure that
1260+-- the payload is fully evaluated before it is delivered.
1261+unsafeNSendRemote :: Serializable a => NodeId -> String -> a -> Process ()
1262+unsafeNSendRemote = Unsafe.nsendRemote
10041263
10051264--------------------------------------------------------------------------------
10061265-- Closures --
@@ -1102,22 +1361,3 @@ monitor' ident = do
11021361-- | Link to a process/node/channel
11031362link' :: Identifier -> Process ()
11041363link' = sendCtrlMsg Nothing . Link
1105−
1106−-- Send a control message
1107−sendCtrlMsg :: Maybe NodeId -- ^ Nothing for the local node
1108− -> ProcessSignal -- ^ Message to send
1109− -> Process ()
1110−sendCtrlMsg mNid signal = do
1111− proc <- ask
1112− let msg = NCMsg { ctrlMsgSender = ProcessIdentifier (processId proc)
1113− , ctrlMsgSignal = signal
1114− }
1115− case mNid of
1116− Nothing -> do
1117− liftIO $ writeChan (localCtrlChan (processNode proc)) msg
1118− Just nid ->
1119− liftIO $ sendBinary (processNode proc)
1120− (ProcessIdentifier (processId proc))
1121− (NodeIdentifier nid)
1122− WithImplicitReconnect
1123− msg
src/Control/Distributed/Process/Internal/Spawn.hs+15−18
@@ -1,3 +1,4 @@
1+{-# LANGUAGE RankNTypes #-}
12module Control.Distributed.Process.Internal.Spawn
23 ( spawn
34 , spawnLink
@@ -7,11 +8,6 @@ module Control.Distributed.Process.Internal.Spawn
78 , spawnChannel
89 ) where
910
10−import Data.Typeable (Typeable)
11−import Control.Monad.IO.Class (liftIO)
12−import Control.Applicative ((<$>))
13−import Control.Monad.Reader (ask)
14−import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
1511import Control.Distributed.Static
1612 ( Static
1713 , Closure
@@ -28,7 +24,6 @@ import Control.Distributed.Process.Internal.Types
2824 , DidSpawn(..)
2925 , SendPort(..)
3026 , ReceivePort(..)
31− , LocalProcess(processNode)
3227 , nullProcessId
3328 )
3429import Control.Distributed.Process.Serializable (Serializable, SerializableDict)
@@ -42,11 +37,13 @@ import Control.Distributed.Process.Internal.Closure.BuiltIn
4237 , cpLink
4338 , cpSend
4439 , cpNewChan
45− , cpDelay
40+ , cpDelayed
41+ , returnCP
42+ , sdictUnit
4643 )
4744import Control.Distributed.Process.Internal.Primitives
4845 ( -- Basic messaging
49− send
46+ usend
5047 , expect
5148 , receiveWait
5249 , match
@@ -58,7 +55,6 @@ import Control.Distributed.Process.Internal.Primitives
5855 , unmonitor
5956 , spawnAsync
6057 , reconnect
61− , newChan
6258 )
6359
6460-- | Spawn a process
@@ -71,11 +67,11 @@ spawn :: NodeId -> Closure (Process ()) -> Process ProcessId
7167spawn nid proc = do
7268 us <- getSelfPid
7369 mRef <- monitorNode nid
74− sRef <- spawnAsync nid (cpDelay us proc)
70+ sRef <- spawnAsync nid (cpDelayed us proc)
7571 receiveWait [
7672 matchIf (\(DidSpawn ref _) -> ref == sRef) $ \(DidSpawn _ pid) -> do
7773 unmonitor mRef
78− send pid ()
74+ usend pid ()
7975 return pid
8076 , matchIf (\(NodeMonitorNotification ref _ _) -> ref == mRef) $ \_ ->
8177 return (nullProcessId nid)
@@ -115,12 +111,14 @@ call :: Serializable a
115111 -> Process a
116112call dict nid proc = do
117113 us <- getSelfPid
118− (pid, mRef) <- spawnMonitor nid (proc `bindCP` cpSend dict us)
119− -- We are guaranteed to receive the reply before the monitor notification
120− -- (if a reply is sent at all)
121− -- NOTE: This might not be true if we switch to unreliable delivery.
114+ (pid, mRef) <- spawnMonitor nid (proc `bindCP`
115+ cpSend dict us `seqCP`
116+ -- Delay so the process does not terminate
117+ -- before the response arrives.
118+ cpDelayed us (returnCP sdictUnit ())
119+ )
122120 mResult <- receiveWait
123− [ match (return . Right)
121+ [ match $ \a -> usend pid () >> return (Right a)
124122 , matchIf (\(ProcessMonitorNotification ref _ _) -> ref == mRef)
125123 (\(ProcessMonitorNotification _ _ reason) -> return (Left reason))
126124 ]
@@ -150,7 +148,7 @@ spawnSupervised nid proc = do
150148
151149-- | Spawn a new process, supplying it with a new 'ReceivePort' and return
152150-- the corresponding 'SendPort'.
153−spawnChannel :: forall a. Typeable a => Static (SerializableDict a)
151+spawnChannel :: forall a. Serializable a => Static (SerializableDict a)
154152 -> NodeId
155153 -> Closure (ReceivePort a -> Process ())
156154 -> Process (SendPort a)
@@ -165,4 +163,3 @@ spawnChannel dict nid proc = do
165163 (cpSend (sdictSendPort dict) pid `splitCP` proc)
166164 `bindCP`
167165 (idCP `closureCompose` staticClosure sndStatic)
168−
src/Control/Distributed/Process/Internal/StrictMVar.hs+37−5
@@ -1,33 +1,43 @@
11-- | Like Control.Concurrent.MVar.Strict but reduce to HNF, not NF
2−{-# LANGUAGE MagicHash, UnboxedTuples #-}
2+{-# LANGUAGE CPP, MagicHash, UnboxedTuples #-}
33module Control.Distributed.Process.Internal.StrictMVar
44 ( StrictMVar(StrictMVar)
55 , newEmptyMVar
66 , newMVar
77 , takeMVar
88 , putMVar
9+ , readMVar
910 , withMVar
1011 , modifyMVar_
1112 , modifyMVar
13+ , modifyMVarMasked
1214 , mkWeakMVar
1315 ) where
1416
1517import Control.Applicative ((<$>))
1618import Control.Monad ((>=>))
19+#if MIN_VERSION_base(4,6,0)
1720import Control.Exception (evaluate)
21+#else
22+import Control.Exception (evaluate, mask_, onException)
23+#endif
1824import qualified Control.Concurrent.MVar as MVar
1925 ( MVar
2026 , newEmptyMVar
2127 , newMVar
2228 , takeMVar
2329 , putMVar
30+ , readMVar
2431 , withMVar
2532 , modifyMVar_
2633 , modifyMVar
34+#if MIN_VERSION_base(4,6,0)
35+ , modifyMVarMasked
36+#endif
2737 )
2838import GHC.MVar (MVar(MVar))
29−import GHC.IO (IO(IO))
30−import GHC.Prim (mkWeak#)
39+import GHC.IO (IO(IO), unIO)
40+import GHC.Exts (mkWeak#)
3141import GHC.Weak (Weak(Weak))
3242
3343newtype StrictMVar a = StrictMVar (MVar.MVar a)
@@ -44,6 +54,9 @@ takeMVar (StrictMVar v) = MVar.takeMVar v
4454putMVar :: StrictMVar a -> a -> IO ()
4555putMVar (StrictMVar v) x = evaluate x >> MVar.putMVar v x
4656
57+readMVar :: StrictMVar a -> IO a
58+readMVar (StrictMVar v) = MVar.readMVar v
59+
4760withMVar :: StrictMVar a -> (a -> IO b) -> IO b
4861withMVar (StrictMVar v) = MVar.withMVar v
4962
@@ -56,6 +69,25 @@ modifyMVar (StrictMVar v) f = MVar.modifyMVar v (f >=> evaluateFst)
5669 evaluateFst :: (a, b) -> IO (a, b)
5770 evaluateFst (x, y) = evaluate x >> return (x, y)
5871
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+
5987mkWeakMVar :: StrictMVar a -> IO () -> IO (Weak (StrictMVar a))
60−mkWeakMVar m@(StrictMVar (MVar m#)) f = IO $ \s ->
61− case mkWeak# m# m f s of (# s1, w #) -> (# s1, Weak w #)
88+mkWeakMVar q@(StrictMVar (MVar m#)) f = IO $ \s ->
89+#if MIN_VERSION_base(4,9,0)
90+ case mkWeak# m# q (unIO f) s of (# s', w #) -> (# s', Weak w #)
91+#else
92+ case mkWeak# m# q f s of (# s', w #) -> (# s', Weak w #)
93+#endif
src/Control/Distributed/Process/Internal/Trace/Types.hsdeleted−294
@@ -1,294 +0,0 @@
1−-- | Tracing/Debugging support - Types
2−module Control.Distributed.Process.Internal.Trace.Types
3− ( Tracer(..)
4− , TraceEvent(..)
5− , SetTrace(..)
6− , Addressable(..)
7− , TraceSubject(..)
8− , TraceFlags(..)
9− , defaultTraceFlags
10− , TraceArg(..)
11− , TraceOk(..)
12− , traceLog
13− , traceLogFmt
14− , traceEvent
15− , traceMessage
16− , defaultTraceFlags
17− , enableTrace
18− , enableTraceSync
19− , disableTrace
20− , disableTraceSync
21− , getTraceFlags
22− , setTraceFlags
23− , setTraceFlagsSync
24− , getCurrentTraceClient
25− ) where
26−
27−import Control.Applicative ((<$>), (<*>))
28−import Control.Distributed.Process.Internal.CQueue (enqueue)
29−import Control.Distributed.Process.Internal.Types
30− ( Tracer(..)
31− , NodeId
32− , ProcessId
33− , DiedReason
34− , Message
35− , SendPort
36− , createUnencodedMessage
37− )
38−import Control.Distributed.Process.Serializable
39−import Data.Binary
40−import Data.Foldable (forM_)
41−import Data.List (intersperse)
42−import Data.Set (Set)
43−import qualified Data.Set as Set (fromList)
44−import Data.Typeable
45−import System.Mem.Weak (deRefWeak)
46−import Network.Transport
47− ( ConnectionId
48− )
49−
50−--------------------------------------------------------------------------------
51−-- Types --
52−--------------------------------------------------------------------------------
53−
54−data SetTrace = TraceEnable !ProcessId | TraceDisable
55− deriving (Typeable, Eq, Show)
56−
57−-- | An event that is fired when something /interesting/ happens.
58−-- Trace events are forwarded to a trace listener process, of which
59−-- at most one can be registered per-node.
60−data TraceEvent =
61− TraceEvSpawned ProcessId
62− -- ^ fired whenever a local process is spawned
63− | TraceEvRegistered ProcessId String
64− -- ^ fired whenever a process/name is registered (locally)
65− | TraceEvUnRegistered ProcessId String
66− -- ^ fired whenever a process/name is unregistered (locally)
67− | TraceEvDied ProcessId DiedReason
68− -- ^ fired whenever a process dies
69− | TraceEvNodeDied NodeId DiedReason
70− -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
71− | TraceEvSent ProcessId ProcessId Message
72− -- ^ fired whenever a message is sent from a local process
73− | TraceEvReceived ProcessId Message
74− -- ^ fired whenever a message is received by a local process
75− | TraceEvConnected ConnectionId
76− -- ^ fired when a network-transport connection is first established
77− | TraceEvDisconnected ConnectionId
78− -- ^ fired when a network-transport connection is broken/disconnected
79− | TraceEvUser Message
80− -- ^ a user defined trace event (see 'traceMessage')
81− | TraceEvLog String
82− -- ^ a /logging/ event - used for debugging purposes only
83− | TraceEvTakeover ProcessId
84− -- ^ notifies a trace listener that all subsequent traces will be sent to /pid/
85− | TraceEvDisable
86− -- ^ notifies a trace listener that it has been disabled/removed
87− deriving (Typeable, Show)
88−
89−class Addressable a where
90− resolveToPid :: a -> Maybe ProcessId
91−
92−instance Addressable TraceEvent where
93− resolveToPid (TraceEvSpawned p) = Just p
94− resolveToPid (TraceEvDied p _) = Just p
95− resolveToPid (TraceEvSent _ p _) = Just p
96− resolveToPid (TraceEvReceived p _) = Just p
97− resolveToPid _ = Nothing
98−
99−-- | Defines which processes will be traced by a given 'TraceFlag',
100−-- either by name, or @ProcessId@. Choosing @TraceAll@ is /by far/
101−-- the most efficient approach, as the tracer process therefore
102−-- avoids deciding whether or not a trace event is viable.
103−--
104−data TraceSubject =
105− TraceAll -- enable tracing for all running processes
106− | TraceProcs !(Set ProcessId) -- enable tracing for a set of processes
107− | TraceNames !(Set String) -- enable tracing for a set of named/registered processes
108− deriving (Show)
109−
110−-- | Defines /what/ will be traced. Flags that control tracing of
111−-- @Process@ events, take a 'TraceSubject' controlling which processes
112−-- should generate trace events in the target process.
113−data TraceFlags = TraceFlags {
114− traceSpawned :: !(Maybe TraceSubject) -- filter process spawned tracing
115− , traceDied :: !(Maybe TraceSubject) -- filter process died tracing
116− , traceRegistered :: !(Maybe TraceSubject) -- filter process registration tracing
117− , traceUnregistered :: !(Maybe TraceSubject) -- filter process un-registration
118− , traceSend :: !(Maybe TraceSubject) -- filter process/message tracing by sender
119− , traceRecv :: !(Maybe TraceSubject) -- filter process/message tracing by receiver
120− , traceNodes :: !Bool -- enable node status trace events
121− , traceConnections :: !Bool -- enable connection status trace events
122− } deriving (Typeable, Show)
123−
124−defaultTraceFlags :: TraceFlags
125−defaultTraceFlags =
126− TraceFlags {
127− traceSpawned = Nothing
128− , traceDied = Nothing
129− , traceRegistered = Nothing
130− , traceUnregistered = Nothing
131− , traceSend = Nothing
132− , traceRecv = Nothing
133− , traceNodes = False
134− , traceConnections = False
135− }
136−
137−data TraceArg =
138− TraceStr String
139− | forall a. (Show a) => Trace a
140−
141−-- | A generic 'ok' response from the trace coordinator.
142−data TraceOk = TraceOk
143− deriving (Typeable)
144−
145−--------------------------------------------------------------------------------
146−-- Internal/Common API --
147−--------------------------------------------------------------------------------
148−
149−traceLog :: Tracer -> String -> IO ()
150−traceLog tr s = traceMessage tr (TraceEvLog s)
151−
152−traceLogFmt :: Tracer
153− -> String
154− -> [TraceArg]
155− -> IO ()
156−traceLogFmt t d ls =
157− traceLog t $ concat (intersperse d (map toS ls))
158− where toS :: TraceArg -> String
159− toS (TraceStr s) = s
160− toS (Trace a) = show a
161−
162−traceEvent :: Tracer -> TraceEvent -> IO ()
163−traceEvent tr ev = traceIt tr (createUnencodedMessage ev)
164−
165−traceMessage :: Serializable m => Tracer -> m -> IO ()
166−traceMessage tr msg = traceEvent tr (TraceEvUser (createUnencodedMessage msg))
167−
168−enableTrace :: Tracer -> ProcessId -> IO ()
169−enableTrace t p =
170− traceIt t (createUnencodedMessage ((Nothing :: Maybe (SendPort TraceOk)),
171− (TraceEnable p)))
172−
173−enableTraceSync :: Tracer -> SendPort TraceOk -> ProcessId -> IO ()
174−enableTraceSync t s p =
175− traceIt t (createUnencodedMessage ((Just s), (TraceEnable p)))
176−
177−disableTrace :: Tracer -> IO ()
178−disableTrace t =
179− traceIt t (createUnencodedMessage ((Nothing :: Maybe (SendPort TraceOk)),
180− TraceDisable))
181−
182−disableTraceSync :: Tracer -> SendPort TraceOk -> IO ()
183−disableTraceSync t s =
184− traceIt t (createUnencodedMessage ((Just s), TraceDisable))
185−
186−setTraceFlags :: Tracer -> TraceFlags -> IO ()
187−setTraceFlags t f =
188− traceIt t (createUnencodedMessage ((Nothing :: Maybe (SendPort TraceOk)), f))
189−
190−setTraceFlagsSync :: Tracer -> SendPort TraceOk -> TraceFlags -> IO ()
191−setTraceFlagsSync t s f =
192− traceIt t (createUnencodedMessage ((Just s), f))
193−
194−getTraceFlags :: Tracer -> SendPort TraceFlags -> IO ()
195−getTraceFlags t s = traceIt t (createUnencodedMessage s)
196−
197−getCurrentTraceClient :: Tracer -> SendPort (Maybe ProcessId) -> IO ()
198−getCurrentTraceClient t s = traceIt t (createUnencodedMessage s)
199−
200−class Traceable a where
201− uod :: [a] -> TraceSubject
202−
203−instance Traceable ProcessId where
204− uod = TraceProcs . Set.fromList
205−
206−instance Traceable String where
207− uod = TraceNames . Set.fromList
208−
209−traceOnly :: Traceable a => [a] -> Maybe TraceSubject
210−traceOnly = Just . uod
211−
212−traceOn :: Maybe TraceSubject
213−traceOn = Just TraceAll
214−
215−traceOff :: Maybe TraceSubject
216−traceOff = Nothing
217−
218−traceIt :: Tracer -> Message -> IO ()
219−traceIt InactiveTracer _ = return ()
220−traceIt (ActiveTracer _ wqRef) msg = do
221− mQueue <- deRefWeak wqRef
222− forM_ mQueue $ \queue -> enqueue queue msg
223−
224−--------------------------------------------------------------------------------
225−-- Binary Instances --
226−--------------------------------------------------------------------------------
227−
228−instance Binary SetTrace where
229− put (TraceEnable pid) = putWord8 1 >> put pid
230− put TraceDisable = putWord8 2
231−
232− get = do
233− header <- getWord8
234− case header of
235− 1 -> TraceEnable <$> get
236− 2 -> return TraceDisable
237− _ -> error "SetTrace.get - invalid header"
238−
239−instance Binary TraceEvent where
240− put (TraceEvSpawned pid) = putWord8 1 >> put pid
241− put (TraceEvRegistered pid str) = putWord8 2 >> put pid >> put str
242− put (TraceEvUnRegistered pid str) = putWord8 3 >> put pid >> put str
243− put (TraceEvDied pid res) = putWord8 4 >> put pid >> put res
244− put (TraceEvNodeDied nid res) = putWord8 5 >> put nid >> put res
245− put (TraceEvSent to from msg) = putWord8 6 >> put to >> put from >> put msg
246− put (TraceEvReceived pid msg) = putWord8 7 >> put pid >> put msg
247− put (TraceEvConnected cid) = putWord8 8 >> put cid
248− put (TraceEvDisconnected cid) = putWord8 9 >> put cid
249− put (TraceEvUser msg) = putWord8 10 >> put msg
250− put (TraceEvLog msg) = putWord8 11 >> put msg
251− put (TraceEvTakeover pid) = putWord8 12 >> put pid
252− put TraceEvDisable = putWord8 13
253−
254− get = do
255− header <- getWord8
256− case header of
257− 1 -> TraceEvSpawned <$> get
258− 2 -> TraceEvRegistered <$> get <*> get
259− 3 -> TraceEvUnRegistered <$> get <*> get
260− 4 -> TraceEvDied <$> get <*> get
261− 5 -> TraceEvNodeDied <$> get <*> get
262− 6 -> TraceEvSent <$> get <*> get <*> get
263− 7 -> TraceEvReceived <$> get <*> get
264− 8 -> TraceEvConnected <$> get
265− 9 -> TraceEvDisconnected <$> get
266− 10 -> TraceEvUser <$> get
267− 11 -> TraceEvLog <$> get
268− 12 -> TraceEvTakeover <$> get
269− 13 -> return TraceEvDisable
270− _ -> error "TraceEvent.get - invalid header"
271−
272−instance Binary TraceSubject where
273− put TraceAll = putWord8 1
274− put (TraceProcs pids) = putWord8 2 >> put pids
275− put (TraceNames names) = putWord8 3 >> put names
276−
277− get = do
278− header <- getWord8
279− case header of
280− 1 -> return TraceAll
281− 2 -> TraceProcs <$> get
282− 3 -> TraceNames <$> get
283− _ -> error "TraceSubject.get - invalid header"
284−
285−instance Binary TraceFlags where
286− put (TraceFlags s d g u m r n c) =
287− put s >> put d >> put g >> put u >> put m >> put r >> put n >> put c
288− get =
289− TraceFlags <$> get <*> get <*> get <*> get <*> get <*> get <*> get <*> get
290−
291−instance Binary TraceOk where
292− put _ = return ()
293− get = return TraceOk
294−
src/Control/Distributed/Process/Internal/Types.hs+253−55
@@ -1,3 +1,13 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE ExistentialQuantification #-}
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE DeriveGeneric #-}
6+{-# LANGUAGE CPP #-}
7+{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE TypeFamilies #-}
9+{-# LANGUAGE Rank2Types #-}
10+
111-- | Types used throughout the Cloud Haskell framework
212--
313-- We collect all types used internally in a single module because
@@ -14,8 +24,14 @@ module Control.Distributed.Process.Internal.Types
1424 , nullProcessId
1525 -- * Local nodes and processes
1626 , LocalNode(..)
17− , Tracer(..)
1827 , LocalNodeState(..)
28+ , ValidLocalNodeState(..)
29+ , NodeClosedException(..)
30+ , withValidLocalState
31+ , modifyValidLocalState
32+ , modifyValidLocalState_
33+ , Tracer(..)
34+ , MxEventBus(..)
1935 , LocalProcess(..)
2036 , LocalProcessState(..)
2137 , Process(..)
@@ -29,8 +45,10 @@ module Control.Distributed.Process.Internal.Types
2945 , ReceivePort(..)
3046 -- * Messages
3147 , Message(..)
48+ , isEncoded
3249 , createMessage
3350 , createUnencodedMessage
51+ , unsafeCreateUnencodedMessage
3452 , messageToPayload
3553 , payloadToMessage
3654 -- * Node controller user-visible data types
@@ -54,6 +72,7 @@ module Control.Distributed.Process.Internal.Types
5472 , RegisterReply(..)
5573 , ProcessInfo(..)
5674 , ProcessInfoNone(..)
75+ , NodeStats(..)
5776 -- * Node controller internal data types
5877 , NCMsg(..)
5978 , ProcessSignal(..)
@@ -76,7 +95,8 @@ module Control.Distributed.Process.Internal.Types
7695import System.Mem.Weak (Weak)
7796import Data.Map (Map)
7897import Data.Int (Int32)
79−import Data.Typeable (Typeable)
98+import Data.Data (Data)
99+import Data.Typeable (Typeable, typeOf)
80100import Data.Binary (Binary(put, get), putWord8, getWord8, encode)
81101import qualified Data.ByteString as BSS (ByteString, concat, copy)
82102import qualified Data.ByteString.Lazy as BSL
@@ -89,14 +109,18 @@ import qualified Data.ByteString.Lazy as BSL
89109import qualified Data.ByteString.Lazy.Internal as BSL (ByteString(..))
90110import Data.Accessor (Accessor, accessor)
91111import Control.Category ((>>>))
92−import Control.Exception (Exception)
112+import Control.DeepSeq (NFData(..))
113+import Control.Exception (Exception, throwIO)
93114import Control.Concurrent (ThreadId)
94115import Control.Concurrent.Chan (Chan)
95116import Control.Concurrent.STM (STM)
117+import Control.Concurrent.STM.TChan (TChan)
118+import Control.Monad.Catch (MonadThrow(..), MonadCatch(..), MonadMask(..))
96119import qualified Network.Transport as NT (EndPoint, EndPointAddress, Connection)
97−import Control.Applicative (Applicative, Alternative, (<$>), (<*>))
120+import Control.Applicative
121+import Control.Monad.Fix (MonadFix)
98122import Control.Monad.Reader (MonadReader(..), ReaderT, runReaderT)
99−import Control.Monad.IO.Class (MonadIO)
123+import Control.Monad.IO.Class (MonadIO(..))
100124import Control.Distributed.Process.Serializable
101125 ( Fingerprint
102126 , Serializable
@@ -107,19 +131,30 @@ import Control.Distributed.Process.Serializable
107131 , showFingerprint
108132 )
109133import Control.Distributed.Process.Internal.CQueue (CQueue)
110−import Control.Distributed.Process.Internal.StrictMVar (StrictMVar)
134+import Control.Distributed.Process.Internal.StrictMVar
135+ ( StrictMVar
136+ , withMVar
137+ , modifyMVar
138+ , modifyMVar_
139+ )
111140import Control.Distributed.Process.Internal.WeakTQueue (TQueue)
112141import Control.Distributed.Static (RemoteTable, Closure)
113142import qualified Control.Distributed.Process.Internal.StrictContainerAccessors as DAC (mapMaybe)
114143
144+import Data.Hashable
145+import GHC.Generics
146+import Prelude
147+
115148--------------------------------------------------------------------------------
116149-- Node and process identifiers --
117150--------------------------------------------------------------------------------
118151
119152-- | Node identifier
120153newtype NodeId = NodeId { nodeAddress :: NT.EndPointAddress }
121− deriving (Eq, Ord, Binary, Typeable)
122−
154+ deriving (Eq, Ord, Typeable, Data, Generic)
155+instance Binary NodeId where
156+instance NFData NodeId where rnf (NodeId a) = rnf a `seq` ()
157+instance Hashable NodeId where
123158instance Show NodeId where
124159 show (NodeId addr) = "nid://" ++ show addr
125160
@@ -129,7 +164,9 @@ data LocalProcessId = LocalProcessId
129164 { lpidUnique :: {-# UNPACK #-} !Int32
130165 , lpidCounter :: {-# UNPACK #-} !Int32
131166 }
132− deriving (Eq, Ord, Typeable, Show)
167+ deriving (Eq, Ord, Typeable, Data, Generic, Show)
168+
169+instance Hashable LocalProcessId where
133170
134171-- | Process identifier
135172data ProcessId = ProcessId
@@ -138,7 +175,11 @@ data ProcessId = ProcessId
138175 -- | Node-local identifier for the process
139176 , processLocalId :: {-# UNPACK #-} !LocalProcessId
140177 }
141− deriving (Eq, Ord, Typeable)
178+ deriving (Eq, Ord, Typeable, Data, Generic)
179+
180+instance Binary ProcessId where
181+instance NFData ProcessId where rnf (ProcessId n _) = rnf n `seq` ()
182+instance Hashable ProcessId where
142183
143184instance Show ProcessId where
144185 show (ProcessId (NodeId addr) (LocalProcessId _ lid))
@@ -149,7 +190,13 @@ data Identifier =
149190 NodeIdentifier !NodeId
150191 | ProcessIdentifier !ProcessId
151192 | SendPortIdentifier !SendPortId
152− deriving (Eq, Ord)
193+ deriving (Eq, Ord, Generic)
194+
195+instance 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` ()
153200
154201instance Show Identifier where
155202 show (NodeIdentifier nid) = show nid
@@ -180,22 +227,30 @@ nullProcessId nid =
180227-- Local nodes and processes --
181228--------------------------------------------------------------------------------
182229
183−-- | Required for system tracing in the node controller
184−data Tracer =
185− ActiveTracer !ProcessId !(Weak (CQueue Message)) -- note [tracer longevity]
186− | InactiveTracer
187−
188−-- note [tracer longevity]
189−--
190−-- If the trace controller process crashes, we make no attempt to restart it
191−-- or handle the failure. Tracing is done on a 'best effort' basis, because
192−-- to make stronger guarantees (e.g., handling failures) would introduce
193−-- significant complexity and adversely affect performance. As such, we access
194−-- the process' mailbox directly via a weak reference, and calls to a dead
195−-- process have no effect just as with normal process/send interactions.
196−--
197−-- Also note that the ProcessId stored in an active tracer is that of the first
198−-- (initially registered) system tracer process.
230+-- | Provides access to the trace controller
231+data Tracer = Tracer
232+ {
233+ -- | Process id for the currently active trace handler
234+ tracerPid :: !ProcessId
235+ -- | Weak reference to the tracer controller's mailbox
236+ , weakQ :: !(Weak (CQueue Message))
237+ }
238+
239+-- | Local system management event bus state
240+data MxEventBus =
241+ MxEventBusInitialising
242+ | MxEventBus
243+ {
244+ -- | Process id of the management agent controller process
245+ agent :: !ProcessId
246+ -- | Configuration for the local trace controller
247+ , tracer :: !Tracer
248+ -- | Weak reference to the management agent controller's mailbox
249+ , evbuss :: !(Weak (CQueue Message))
250+ -- | API for adding management agents to a running node
251+ , mxNew :: !(((TChan Message, TChan Message) -> Process ()) -> IO ProcessId)
252+-- , mxReg :: !(StrictMVar (Map MxAgentId ))
253+ }
199254
200255-- | Local nodes
201256data LocalNode = LocalNode
@@ -207,8 +262,8 @@ data LocalNode = LocalNode
207262 , localState :: !(StrictMVar LocalNodeState)
208263 -- | Channel for the node controller
209264 , localCtrlChan :: !(Chan NCMsg)
210− -- | Current active system debug/trace log
211− , localTracer :: !Tracer
265+ -- | Internal management event bus
266+ , localEventBus :: !MxEventBus
212267 -- | Runtime lookup table for supporting closures
213268 -- TODO: this should be part of the CH state, not the local endpoint state
214269 , remoteTable :: !RemoteTable
@@ -218,7 +273,11 @@ data ImplicitReconnect = WithImplicitReconnect | NoImplicitReconnect
218273 deriving (Eq, Show)
219274
220275-- | Local node state
221−data LocalNodeState = LocalNodeState
276+data LocalNodeState =
277+ LocalNodeValid {-# UNPACK #-} !ValidLocalNodeState
278+ | LocalNodeClosed
279+
280+data ValidLocalNodeState = ValidLocalNodeState
222281 { -- | Processes running on this node
223282 _localProcesses :: !(Map LocalProcessId LocalProcess)
224283 -- | Counter to assign PIDs
@@ -231,6 +290,40 @@ data LocalNodeState = LocalNodeState
231290 (NT.Connection, ImplicitReconnect))
232291 }
233292
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+
234327-- | Processes running on our local node
235328data LocalProcess = LocalProcess
236329 { processQueue :: !(CQueue Message)
@@ -257,7 +350,50 @@ data LocalProcessState = LocalProcessState
257350newtype Process a = Process {
258351 unProcess :: ReaderT LocalProcess IO a
259352 }
260− deriving (Functor, Monad, MonadIO, MonadReader LocalProcess, Typeable, Applicative)
353+ deriving ( Applicative
354+ , Functor
355+ , Monad
356+ , MonadFix
357+ , MonadIO
358+ , MonadReader LocalProcess
359+ , Typeable
360+ )
361+
362+instance MonadThrow Process where
363+ throwM = liftIO . throwIO
364+instance MonadCatch Process where
365+ catch p h = do
366+ lproc <- ask
367+ liftIO $ catch (runLocalProcess lproc p) (runLocalProcess lproc . h)
368+instance MonadMask Process where
369+#if MIN_VERSION_exceptions(0,10,0)
370+ generalBracket acquire release inner = do
371+ lproc <- ask
372+ liftIO $
373+ generalBracket (runLocalProcess lproc acquire)
374+ (\a e -> runLocalProcess lproc $ release a e)
375+ (runLocalProcess lproc . inner)
376+#endif
377+ mask p = do
378+ lproc <- ask
379+ liftIO $ mask $ \restore ->
380+ runLocalProcess lproc (p (liftRestore restore))
381+ where
382+ liftRestore :: (forall a. IO a -> IO a)
383+ -> (forall a. Process a -> Process a)
384+ liftRestore restoreIO = \p2 -> do
385+ ourLocalProc <- ask
386+ liftIO $ restoreIO $ runLocalProcess ourLocalProc p2
387+ uninterruptibleMask p = do
388+ lproc <- ask
389+ liftIO $ uninterruptibleMask $ \restore ->
390+ runLocalProcess lproc (p (liftRestore restore))
391+ where
392+ liftRestore :: (forall a. IO a -> IO a)
393+ -> (forall a. Process a -> Process a)
394+ liftRestore restoreIO = \p2 -> do
395+ ourLocalProc <- ask
396+ liftIO $ restoreIO $ runLocalProcess ourLocalProc p2
261397
262398--------------------------------------------------------------------------------
263399-- Typed channels --
@@ -275,12 +411,16 @@ data SendPortId = SendPortId {
275411 -- | Process-local ID of the channel
276412 , sendPortLocalId :: {-# UNPACK #-} !LocalSendPortId
277413 }
278− deriving (Eq, Ord)
414+ deriving (Eq, Ord, Typeable, Generic)
279415
416+instance Hashable SendPortId where
280417instance Show SendPortId where
281418 show (SendPortId (ProcessId (NodeId addr) (LocalProcessId _ plid)) clid)
282419 = "cid://" ++ show addr ++ ":" ++ show plid ++ ":" ++ show clid
283420
421+instance NFData SendPortId where
422+ rnf (SendPortId p _) = rnf p `seq` ()
423+
284424data TypedChannel = forall a. Serializable a => TypedChannel (Weak (TQueue a))
285425
286426-- | The send send of a typed channel (serializable)
@@ -288,7 +428,11 @@ newtype SendPort a = SendPort {
288428 -- | The (unique) ID of this send port
289429 sendPortId :: SendPortId
290430 }
291− deriving (Typeable, Binary, Show, Eq, Ord)
431+ deriving (Typeable, Generic, Show, Eq, Ord)
432+
433+instance (Serializable a) => Binary (SendPort a) where
434+instance (Hashable a) => Hashable (SendPort a) where
435+instance (NFData a) => NFData (SendPort a) where rnf (SendPort x) = x `seq` ()
292436
293437-- | The receive end of a typed channel (not serializable)
294438--
@@ -326,9 +470,30 @@ data Message =
326470 }
327471 deriving (Typeable)
328472
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+
329482instance Show Message where
330483 show (EncodedMessage fp enc) = show enc ++ " :: " ++ showFingerprint fp []
331− show (UnencodedMessage fp _) = "[unencoded message] :: " ++ (showFingerprint fp [])
484+ show (UnencodedMessage _ uenc) = "[unencoded message] :: " ++ (show $ typeOf uenc)
485+
486+-- | /internal use only/.
487+isEncoded :: Message -> Bool
488+isEncoded (EncodedMessage _ _) = True
489+isEncoded _ = False
490+-- [note] isEncoded:
491+-- This is just as internal as it looks and yes, it does feel a bit odd that
492+-- we're exporting it for use, however DPP does a /lot/ of work with low
493+-- level APIs such as unwrapMessage and handleMessage, and in the process
494+-- tries very hard to avoid copying (and re-serialisation) where possible.
495+-- Being able to determine that a message is encoded (or otherwise) makes
496+-- that a lot more manageable.
332497
333498-- | Turn any serialiable term into a message
334499createMessage :: Serializable a => a -> Message
@@ -339,6 +504,11 @@ createUnencodedMessage :: Serializable a => a -> Message
339504createUnencodedMessage a =
340505 let encoded = encode a in BSL.length encoded `seq` UnencodedMessage (fingerprint a) a
341506
507+-- | Turn any serializable term into an unencodede/local message, without
508+-- evalutaing it! This is a dangerous business.
509+unsafeCreateUnencodedMessage :: Serializable a => a -> Message
510+unsafeCreateUnencodedMessage a = UnencodedMessage (fingerprint a) a
511+
342512-- | Serialize a message
343513messageToPayload :: Message -> [BSS.ByteString]
344514messageToPayload (EncodedMessage fp enc) = encodeFingerprint fp : BSL.toChunks enc
@@ -371,7 +541,11 @@ data MonitorRef = MonitorRef
371541 -- | Unique to distinguish multiple monitor requests by the same process
372542 , monitorRefCounter :: !Int32
373543 }
374− deriving (Eq, Ord, Show)
544+ deriving (Eq, Ord, Show, Typeable, Generic)
545+instance Hashable MonitorRef
546+
547+instance NFData MonitorRef where
548+ rnf (MonitorRef i _) = rnf i `seq` ()
375549
376550-- | Message sent by process monitors
377551data ProcessMonitorNotification =
@@ -405,9 +579,11 @@ data PortLinkException =
405579
406580-- | Exception thrown when a process attempts to register
407581-- a process under an already-registered name or to
408−-- unregister a name that hasn't been registered
582+-- unregister a name that hasn't been registered. Returns
583+-- the name and the identifier of the process that owns it,
584+-- if any.
409585data ProcessRegistrationException =
410− ProcessRegistrationException !String
586+ ProcessRegistrationException !String !(Maybe ProcessId)
411587 deriving (Typeable, Show)
412588
413589-- | Internal exception thrown indirectly by 'exit'
@@ -439,6 +615,10 @@ data DiedReason =
439615 | DiedUnknownId
440616 deriving (Show, Eq)
441617
618+instance NFData DiedReason where
619+ rnf (DiedException s) = rnf s `seq` ()
620+ rnf x = x `seq` ()
621+
442622-- | (Asynchronous) reply from unmonitor
443623newtype DidUnmonitor = DidUnmonitor MonitorRef
444624 deriving (Typeable, Binary)
@@ -457,7 +637,7 @@ newtype DidUnlinkPort = DidUnlinkPort SendPortId
457637
458638-- | 'SpawnRef' are used to return pids of spawned processes
459639newtype SpawnRef = SpawnRef Int32
460− deriving (Show, Binary, Typeable, Eq)
640+ deriving (Show, Binary, Typeable, Eq, Ord)
461641
462642-- | (Asynchronius) reply from 'spawn'
463643data DidSpawn = DidSpawn SpawnRef ProcessId
@@ -468,14 +648,23 @@ data WhereIsReply = WhereIsReply String (Maybe ProcessId)
468648 deriving (Show, Typeable)
469649
470650-- | (Asynchronous) reply from 'register' and 'unregister'
471−data RegisterReply = RegisterReply String Bool
651+data RegisterReply = RegisterReply String Bool (Maybe ProcessId)
472652 deriving (Show, Typeable)
473653
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+
474663-- | Provide information about a running process
475664data ProcessInfo = ProcessInfo {
476665 infoNode :: NodeId
477666 , infoRegisteredNames :: [String]
478− , infoMessageQueueLength :: Maybe Int
667+ , infoMessageQueueLength :: Int
479668 , infoMonitors :: [(ProcessId, MonitorRef)]
480669 , infoLinks :: [ProcessId]
481670 } deriving (Show, Eq, Typeable)
@@ -505,12 +694,14 @@ data ProcessSignal =
505694 | WhereIs !String
506695 | Register !String !NodeId !(Maybe ProcessId) !Bool -- Use 'Nothing' to unregister, use True to force reregister
507696 | NamedSend !String !Message
697+ | UnreliableSend !LocalProcessId !Message
508698 | LocalSend !ProcessId !Message
509699 | LocalPortSend !SendPortId !Message
510700 | Kill !ProcessId !String
511701 | Exit !ProcessId !Message
512702 | GetInfo !ProcessId
513703 | SigShutdown
704+ | GetNodeStats !NodeId
514705 deriving Show
515706
516707--------------------------------------------------------------------------------
@@ -525,10 +716,6 @@ instance Binary LocalProcessId where
525716 put lpid = put (lpidUnique lpid) >> put (lpidCounter lpid)
526717 get = LocalProcessId <$> get <*> get
527718
528−instance Binary ProcessId where
529− put pid = put (processNodeId pid) >> put (processLocalId pid)
530− get = ProcessId <$> get <*> get
531−
532719instance Binary ProcessMonitorNotification where
533720 put (ProcessMonitorNotification ref pid reason) = put ref >> put pid >> put reason
534721 get = ProcessMonitorNotification <$> get <*> get <*> get
@@ -561,10 +748,12 @@ instance Binary ProcessSignal where
561748 put (NamedSend label msg) = putWord8 8 >> put label >> put (messageToPayload msg)
562749 put (Kill pid reason) = putWord8 9 >> put pid >> put reason
563750 put (Exit pid reason) = putWord8 10 >> put pid >> put (messageToPayload reason)
564− put (LocalSend to msg) = putWord8 11 >> put to >> put (messageToPayload msg)
751+ put (LocalSend to' msg) = putWord8 11 >> put to' >> put (messageToPayload msg)
565752 put (LocalPortSend sid msg) = putWord8 12 >> put sid >> put (messageToPayload msg)
753+ put (UnreliableSend lpid msg) = putWord8 13 >> put lpid >> put (messageToPayload msg)
566754 put (GetInfo about) = putWord8 30 >> put about
567755 put (SigShutdown) = putWord8 31
756+ put (GetNodeStats nid) = putWord8 32 >> put nid
568757 get = do
569758 header <- getWord8
570759 case header of
@@ -581,8 +770,10 @@ instance Binary ProcessSignal where
581770 10 -> Exit <$> get <*> (payloadToMessage <$> get)
582771 11 -> LocalSend <$> get <*> (payloadToMessage <$> get)
583772 12 -> LocalPortSend <$> get <*> (payloadToMessage <$> get)
773+ 13 -> UnreliableSend <$> get <*> (payloadToMessage <$> get)
584774 30 -> GetInfo <$> get
585775 31 -> return SigShutdown
776+ 32 -> GetNodeStats <$> get
586777 _ -> fail "ProcessSignal.get: invalid"
587778
588779instance Binary DiedReason where
@@ -626,8 +817,8 @@ instance Binary WhereIsReply where
626817 get = WhereIsReply <$> get <*> get
627818
628819instance Binary RegisterReply where
629− put (RegisterReply label ok) = put label >> put ok
630− get = RegisterReply <$> get <*> get
820+ put (RegisterReply label ok owner) = put label >> put ok >> put owner
821+ get = RegisterReply <$> get <*> get <*> get
631822
632823instance Binary ProcessInfo where
633824 get = ProcessInfo <$> get <*> get <*> get <*> get <*> get
@@ -637,6 +828,14 @@ instance Binary ProcessInfo where
637828 >> put (infoMonitors pInfo)
638829 >> put (infoLinks pInfo)
639830
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+
640839instance Binary ProcessInfoNone where
641840 get = ProcessInfoNone <$> get
642841 put (ProcessInfoNone r) = put r
@@ -645,23 +844,23 @@ instance Binary ProcessInfoNone where
645844-- Accessors --
646845--------------------------------------------------------------------------------
647846
648−localProcesses :: Accessor LocalNodeState (Map LocalProcessId LocalProcess)
847+localProcesses :: Accessor ValidLocalNodeState (Map LocalProcessId LocalProcess)
649848localProcesses = accessor _localProcesses (\procs st -> st { _localProcesses = procs })
650849
651−localPidCounter :: Accessor LocalNodeState Int32
850+localPidCounter :: Accessor ValidLocalNodeState Int32
652851localPidCounter = accessor _localPidCounter (\ctr st -> st { _localPidCounter = ctr })
653852
654−localPidUnique :: Accessor LocalNodeState Int32
853+localPidUnique :: Accessor ValidLocalNodeState Int32
655854localPidUnique = accessor _localPidUnique (\unq st -> st { _localPidUnique = unq })
656855
657−localConnections :: Accessor LocalNodeState (Map (Identifier, Identifier) (NT.Connection, ImplicitReconnect))
856+localConnections :: Accessor ValidLocalNodeState (Map (Identifier, Identifier) (NT.Connection, ImplicitReconnect))
658857localConnections = accessor _localConnections (\conns st -> st { _localConnections = conns })
659858
660−localProcessWithId :: LocalProcessId -> Accessor LocalNodeState (Maybe LocalProcess)
859+localProcessWithId :: LocalProcessId -> Accessor ValidLocalNodeState (Maybe LocalProcess)
661860localProcessWithId lpid = localProcesses >>> DAC.mapMaybe lpid
662861
663−localConnectionBetween :: Identifier -> Identifier -> Accessor LocalNodeState (Maybe (NT.Connection, ImplicitReconnect))
664−localConnectionBetween from to = localConnections >>> DAC.mapMaybe (from, to)
862+localConnectionBetween :: Identifier -> Identifier -> Accessor ValidLocalNodeState (Maybe (NT.Connection, ImplicitReconnect))
863+localConnectionBetween from' to' = localConnections >>> DAC.mapMaybe (from', to')
665864
666865monitorCounter :: Accessor LocalProcessState Int32
667866monitorCounter = accessor _monitorCounter (\cnt st -> st { _monitorCounter = cnt })
@@ -686,4 +885,3 @@ typedChannelWithId cid = typedChannels >>> DAC.mapMaybe cid
686885{-# INLINE forever' #-}
687886forever' :: Monad m => m a -> m b
688887forever' a = let a' = a >> a' in a'
689−
src/Control/Distributed/Process/Internal/WeakTQueue.hs+9−3
@@ -1,10 +1,12 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE MagicHash, UnboxedTuples #-}
14-- | Clone of Control.Concurrent.STM.TQueue with support for mkWeakTQueue
25--
36-- Not all functionality from the original module is available: unGetTQueue,
47-- peekTQueue and tryPeekTQueue are missing. In order to implement these we'd
58-- need to be able to touch# the write end of the queue inside unGetTQueue, but
69-- that means we need a version of touch# that works within the STM monad.
7−{-# LANGUAGE MagicHash, UnboxedTuples #-}
810module Control.Distributed.Process.Internal.WeakTQueue (
911 -- * Original functionality
1012 TQueue,
@@ -21,8 +23,8 @@ module Control.Distributed.Process.Internal.WeakTQueue (
2123import Prelude hiding (read)
2224import GHC.Conc
2325import Data.Typeable (Typeable)
24−import GHC.IO (IO(IO))
25−import GHC.Prim (mkWeak#)
26+import GHC.IO (IO(IO), unIO)
27+import GHC.Exts (mkWeak#)
2628import GHC.Weak (Weak(Weak))
2729
2830--------------------------------------------------------------------------------
@@ -98,4 +100,8 @@ isEmptyTQueue (TQueue read write) = do
98100
99101mkWeakTQueue :: TQueue a -> IO () -> IO (Weak (TQueue a))
100102mkWeakTQueue 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
101106 case mkWeak# write# q f s of (# s', w #) -> (# s', Weak w #)
107+#endif
src/Control/Distributed/Process/Management.hsnew file+509
@@ -0,0 +1,509 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE DeriveGeneric #-}
3+{-# LANGUAGE StandaloneDeriving #-}
4+{-# LANGUAGE ExistentialQuantification #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE RecordWildCards #-}
7+{-# LANGUAGE PatternGuards #-}
8+{-# LANGUAGE FlexibleInstances #-}
9+{-# LANGUAGE UndecidableInstances #-}
10+
11+-----------------------------------------------------------------------------
12+-- |
13+-- Module : Control.Distributed.Process.Management
14+-- Copyright : (c) Well-Typed / Tim Watson
15+-- License : BSD3 (see the file LICENSE)
16+--
17+-- Maintainer : Tim Watson <watson.timothy@gmail.com>
18+-- Stability : experimental
19+-- Portability : non-portable (requires concurrency)
20+--
21+-- [Management Extensions API]
22+--
23+-- This module presents an API for creating /Management Agents/:
24+-- special processes that are capable of receiving and responding to
25+-- a node's internal system events. These /system events/ are delivered by
26+-- the management event bus: An internal subsystem maintained for each
27+-- running node, to which all agents are automatically subscribed.
28+--
29+-- /Agents/ are defined in terms of /event sinks/, taking a particular
30+-- @Serializable@ type and evaluating to an action in the 'MxAgent' monad in
31+-- response. Each 'MxSink' evaluates to an 'MxAction' that specifies whether
32+-- the agent should continue processing it's inputs or stop. If the type of a
33+-- message cannot be matched to any of the agent's sinks, it will be discarded.
34+-- A sink can also deliberately skip processing a message, deferring to the
35+-- remaining handlers. This is the /only/ way that more than one event sink
36+-- can handle the same data type, since otherwise the first /type match/ will
37+-- /win/ every time a message arrives. See 'mxSkip' for details.
38+--
39+-- Various events are published to the management event bus automatically,
40+-- the full list of which can be found in the definition of the 'MxEvent' data
41+-- type. Additionally, clients of the /Management API/ can publish arbitrary
42+-- @Serializable@ data to the event bus using 'mxNotify'. All running agents
43+-- receive all events (from the primary event bus to which they're subscribed).
44+--
45+-- Agent processes are automatically registered on the local node, and can
46+-- receive messages via their mailbox just like ordinary processes. Unlike
47+-- ordinary @Process@ code however, it is unnecessary (though possible) for
48+-- agents to use the base @expect@ and @receiveX@ primitives to do this, since
49+-- the management infrastructure will continuously read from both the primary
50+-- event bus /and/ the process' own mailbox. Messages are transparently passed
51+-- to the agent's event sinks from both sources, so an agent need only concern
52+-- itself with how to respond to its inputs.
53+--
54+-- Some agents may wish to prioritise messages from their mailbox over traffic
55+-- on the management event bus, or vice versa. The 'mxReceive' and
56+-- 'mxReceiveChan' API calls do this for the mailbox and event bus,
57+-- respectively. The /prioritisation/ these APIs offer is simply that the chosen
58+-- data stream will be checked first. No blocking will occur if the chosen
59+-- (prioritised) source is devoid of input messages, instead the agent handling
60+-- code will revert to switching between the alternatives in /round-robin/ as
61+-- usual. If messages exist in one or more channels, they will be consumed as
62+-- soon as they're available, priority is effectively a hint about which
63+-- channel to consume from, should messages be available in both.
64+--
65+-- Prioritisation then, is a /hint/ about the preference of data source from
66+-- which the next input should be chosen. No guarantee can be made that the
67+-- chosen source will in fact be selected at runtime.
68+--
69+-- [Management API Semantics]
70+--
71+-- The management API provides /no guarantees whatsoever/, viz:
72+--
73+-- * The ordering of messages delivered to the event bus.
74+--
75+-- * The order in which agents will be executed.
76+--
77+-- * Whether messages will be taken from the mailbox first, or the event bus.
78+--
79+-- Since the event bus uses STM broadcast channels to communicate with agents,
80+-- no message written to the bus successfully can be lost.
81+--
82+-- Agents can also receive messages via their mailboxes - these are subject to
83+-- the same guarantees as all inter-process message sending.
84+--
85+-- Messages dispatched on an STM broadcast channel (i.e., management event bus)
86+-- are guaranteed to be delivered with the same FIFO ordering guarantees that
87+-- exist between two communicating processes, such that communication from the
88+-- node controller's threads (i.e., MxEvent's) will never be re-ordered, but
89+-- messages dispatched to the event bus by other processes (including, but not
90+-- limited to agents) are only guaranteed to be ordered between one sender and
91+-- one receiver.
92+--
93+-- No guarantee exists for the ordering in which messages sent to an agent's
94+-- mailbox will be delivered, vs messages dispatched via the event bus.
95+--
96+-- Because of the above, there are no ordering guarantees for messages sent
97+-- between agents, or for processes to agents, except for those that apply to
98+-- messages sent between regular processes, since agents are
99+-- implemented as such.
100+--
101+-- The event bus is serial and single threaded. Anything that is published by
102+-- the node controller will be seen in FIFO order. There are no ordering
103+-- guarantees pertaining to entries published to the event bus by other
104+-- processes or agents.
105+--
106+-- It should not be possible to see, for example, an @MxReceived@ before the
107+-- corresponding @MxSent@ event, since the places where we issue the @MxSent@
108+-- write directly to the event bus (using STM) in the calling (green) thread,
109+-- before dispatching instructions to the node controller to perform the
110+-- necessary routing to deliver the message to a process (or registered name,
111+-- or typed channel) locally or remotely.
112+--
113+-- [Management Data API]
114+--
115+-- Both management agents and clients of the API have access to a variety of
116+-- data storage capabilities, to facilitate publishing and consuming useful
117+-- system information. Agents maintain their own internal state privately (via a
118+-- state transformer - see 'mxGetLocal' et al), however it is possible for
119+-- agents to share additional data with each other (and the outside world)
120+-- using whatever mechanism the user wishes, e.g., acidstate, or shared memory
121+-- primitives.
122+--
123+-- [Defining Agents]
124+--
125+-- New agents are defined with 'mxAgent' and require a unique 'MxAgentId', an
126+-- initial state - 'MxAgent' runs in a state transformer - and a list of the
127+-- agent's event sinks. Each 'MxSink' is defined in terms of a specific
128+-- @Serializable@ type, via the 'mxSink' function, binding the event handler
129+-- expression to inputs of only that type.
130+--
131+-- Apart from modifying its own local state, an agent can execute arbitrary
132+-- @Process a@ code via lifting (see 'liftMX') and even publish its own messages
133+-- back to the primary event bus (see 'mxBroadcast').
134+--
135+-- Since messages are delivered to agents from both the management event bus and
136+-- the agent processes mailbox, agents (i.e., event sinks) will generally have
137+-- no idea as to their origin. An agent can, however, choose to prioritise the
138+-- choice of input (source) each time one of its event sinks runs. The /standard/
139+-- way for an event sink to indicate that the agent is ready for its next input
140+-- is to evaluate 'mxReady'. When this happens, the management infrastructure
141+-- will obtain data from the event bus and process' mailbox in a round robbin
142+-- fashion, i.e., one after the other, changing each time.
143+--
144+-- [Example Code]
145+--
146+-- What follows is a grossly over-simplified example of a management agent that
147+-- provides a basic name monitoring facility. Whenever a process name is
148+-- registered or unregistered, clients are informed of the fact.
149+--
150+-- > -- simple notification data type
151+-- >
152+-- > data Registration = Reg { added :: Bool
153+-- > , procId :: ProcessId
154+-- > , name :: String
155+-- > }
156+-- >
157+-- > -- start a /name monitoring agent/
158+-- > nameMonitorAgent = do
159+-- > mxAgent (MxAgentId "name-monitor") Set.empty [
160+-- > (mxSink $ \(pid :: ProcessId) -> do
161+-- > mxUpdateState $ Set.insert pid
162+-- > mxReady)
163+-- > , (mxSink $
164+-- > let act =
165+-- > case ev of
166+-- > (MxRegistered p n) -> notify True n p
167+-- > (MxUnRegistered p n) -> notify False n p
168+-- > _ -> return ()
169+-- > act >> mxReady)
170+-- > ]
171+-- > where
172+-- > notify a n p = do
173+-- > Foldable.mapM_ (liftMX . deliver (Reg a n p)) =<< mxGetLocal
174+-- >
175+--
176+-- The client interface (for sending their pid) can take one of two forms:
177+--
178+-- > monitorNames = getSelfPid >>= nsend "name-monitor"
179+-- > monitorNames2 = getSelfPid >>= mxNotify
180+--
181+-- [Performance, Stablity and Scalability]
182+--
183+-- /Management Agents/ offer numerous advantages over regular processes:
184+-- broadcast communication with them can have a lower latency, they offer
185+-- simplified messgage (i.e., input type) handling and they have access to
186+-- internal system information that would be otherwise unobtainable.
187+--
188+-- Do not be tempted to implement everything (e.g., the kitchen sink) using the
189+-- management API though. There are overheads associated with management agents
190+-- which is why they're presented as tools for consuming low level system
191+-- information, instead of as /application level/ development tools.
192+--
193+-- Agents that rely heavily on a busy mailbox can cause the management event
194+-- bus to backlog un-GC'ed data, leading to increased heap space. Producers that
195+-- do not take care to avoid passing unevaluated thunks to the API can crash
196+-- /all/ the agents in the system. Agents are not monitored or managed in any
197+-- way, and those that crash will not be restarted.
198+--
199+-- The management event bus can receive a great deal of traffic. Every time
200+-- a message is sent and/or received, an event is passed to the agent controller
201+-- and broadcast to all agents (plus the trace controller, if tracing is enabled
202+-- for the node). This is already a significant overhead - though profiling and
203+-- benchmarks have demonstrated that it does not adversely affect performance
204+-- if few agents are installed. Agents will typically use more cycles than plain
205+-- processes, since they perform additional work: selecting input data from both
206+-- the event bus /and/ their own mailboxes, plus searching through the set of
207+-- event sinks (for each agent) to determine the right handler for the event.
208+--
209+-- [Architecture Overview]
210+--
211+-- The architecture of the management event bus is internal and subject to
212+-- change without prior notice. The description that follows is provided for
213+-- informational purposes only.
214+--
215+-- When a node initially starts, two special, internal system processes are
216+-- started to support the management infrastructure. The first, known as the
217+-- /trace controller/, is responsible for consuming 'MxEvent's and forwarding
218+-- them to the configured tracer - see "Control.Distributed.Process.Debug" for
219+-- further details. The second is the /management agent controller/, and is the
220+-- primary worker process underpinning the management infrastructure. All
221+-- published management events are routed to this process, which places them
222+-- onto a system wide /event bus/ and additionally passes them directly to the
223+-- /trace controller/.
224+--
225+-- There are several reasons for segregating the tracing and management control
226+-- planes in this fashion. Tracing can be enabled or disabled by clients, whilst
227+-- the management event bus cannot, since in addition to providing
228+-- runtime instrumentation, its intended use-cases include node monitoring, peer
229+-- discovery (via topology providing backends) and other essential system
230+-- services that require knowledge of otherwise hidden system internals. Tracing
231+-- is also subject to /trace flags/ that limit the specific 'MxEvent's delivered
232+-- to trace clients - an overhead/complexity not shared by management agents.
233+-- Finally, tracing and management agents are implemented using completely
234+-- different signalling techniques - more on this later - which would introduce
235+-- considerable complexity if the shared the same /event loop/.
236+--
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+--
250+-----------------------------------------------------------------------------
251+module Control.Distributed.Process.Management
252+ (
253+ MxEvent(..)
254+ -- * Firing Arbitrary /Mx Events/
255+ , mxNotify
256+ -- * Constructing Mx Agents
257+ , MxAction()
258+ , MxAgentId(..)
259+ , MxAgent()
260+ , mxAgent
261+ , mxAgentWithFinalize
262+ , MxSink()
263+ , mxSink
264+ , mxGetId
265+ , mxDeactivate
266+ , mxReady
267+ , mxSkip
268+ , mxReceive
269+ , mxReceiveChan
270+ , mxBroadcast
271+ , mxSetLocal
272+ , mxGetLocal
273+ , mxUpdateLocal
274+ , liftMX
275+ ) where
276+
277+import Control.Applicative
278+import Control.Concurrent.STM (atomically)
279+import Control.Concurrent.STM.TChan
280+ ( readTChan
281+ , writeTChan
282+ , TChan
283+ )
284+import Control.Distributed.Process.Internal.Primitives
285+ ( receiveWait
286+ , matchAny
287+ , matchSTM
288+ , unwrapMessage
289+ , register
290+ , whereis
291+ , die
292+ )
293+import Control.Distributed.Process.Internal.Types
294+ ( Process
295+ , ProcessId
296+ , Message
297+ , LocalProcess(..)
298+ , LocalNode(..)
299+ , MxEventBus(..)
300+ , unsafeCreateUnencodedMessage
301+ )
302+import Control.Distributed.Process.Management.Internal.Bus (publishEvent)
303+import Control.Distributed.Process.Management.Internal.Types
304+ ( MxAgentId(..)
305+ , MxAgent(..)
306+ , MxAction(..)
307+ , ChannelSelector(..)
308+ , MxAgentState(..)
309+ , MxSink
310+ , MxEvent(..)
311+ )
312+import Control.Distributed.Process.Serializable (Serializable)
313+import Control.Monad.IO.Class (liftIO)
314+import Control.Monad.Reader (ask)
315+import Control.Monad.Catch (onException)
316+import qualified Control.Monad.State as ST
317+ ( get
318+ , modify
319+ , lift
320+ , runStateT
321+ )
322+import Prelude
323+
324+-- | 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
326+-- important that you do not pass unevaluated thunks that might crash the
327+-- receiving process via this API, since /all/ registered agents will gain
328+-- access to the data structure once it is broadcast by the agent controller.
329+mxNotify :: (Serializable a) => a -> Process ()
330+mxNotify msg = do
331+ bus <- localEventBus . processNode <$> ask
332+ liftIO $ publishEvent bus $ unsafeCreateUnencodedMessage msg
333+
334+--------------------------------------------------------------------------------
335+-- API for writing user defined management extensions (i.e., agents) --
336+--------------------------------------------------------------------------------
337+
338+-- | Return the 'MxAgentId' for the currently executing agent.
339+--
340+mxGetId :: MxAgent s MxAgentId
341+mxGetId = ST.get >>= return . mxAgentId
342+
343+-- | The 'MxAgent' version of 'mxNotify'.
344+--
345+mxBroadcast :: (Serializable m) => m -> MxAgent s ()
346+mxBroadcast msg = do
347+ state <- ST.get
348+ liftMX $ liftIO $ atomically $ do
349+ writeTChan (mxBus state) (unsafeCreateUnencodedMessage msg)
350+
351+-- | Gracefully terminate an agent.
352+--
353+mxDeactivate :: forall s. String -> MxAgent s MxAction
354+mxDeactivate = return . MxAgentDeactivate
355+
356+-- | Continue executing (i.e., receiving and processing messages).
357+--
358+mxReady :: forall s. MxAgent s MxAction
359+mxReady = return MxAgentReady
360+
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+--
383+liftMX :: Process a -> MxAgent s a
384+liftMX p = MxAgent $ ST.lift p
385+
386+-- | Set the agent's local state.
387+--
388+mxSetLocal :: s -> MxAgent s ()
389+mxSetLocal s = ST.modify $ \st -> st { mxLocalState = s }
390+
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+--
398+mxGetLocal :: MxAgent s s
399+mxGetLocal = ST.get >>= return . mxLocalState
400+
401+-- | Create an 'MxSink' from an expression taking a @Serializable@ type @m@,
402+-- that yields an 'MxAction' in the 'MxAgent' monad.
403+--
404+mxSink :: forall s m . (Serializable m)
405+ => (m -> MxAgent s MxAction)
406+ -> MxSink s
407+mxSink act msg = do
408+ msg' <- liftMX $ (unwrapMessage msg :: Process (Maybe m))
409+ case msg' of
410+ Nothing -> return Nothing
411+ Just m -> do
412+ r <- act m
413+ case r of
414+ MxAgentSkip -> return Nothing
415+ _ -> return $ Just r
416+
417+-- private ADT: a linked list of event sinks
418+data MxPipeline s =
419+ MxPipeline
420+ {
421+ current :: !(MxSink s)
422+ , next :: !(MxPipeline s)
423+ } | MxStop
424+
425+-- | Activates a new agent.
426+--
427+mxAgent :: MxAgentId -> s -> [MxSink s] -> Process ProcessId
428+mxAgent mxId st hs = mxAgentWithFinalize mxId st hs $ return ()
429+
430+-- | Activates a new agent. This variant takes a /finalizer/ expression,
431+-- that is run once the agent shuts down (even in case of failure/exceptions).
432+-- The /finalizer/ expression runs in the mx monad - @MxAgent s ()@ - such
433+-- that the agent's internal state remains accessible to the shutdown/cleanup
434+-- code.
435+--
436+mxAgentWithFinalize :: MxAgentId
437+ -> s
438+ -> [MxSink s]
439+ -> MxAgent s ()
440+ -> Process ProcessId
441+mxAgentWithFinalize mxId initState handlers dtor = do
442+ let name = agentId mxId
443+ existing <- whereis name
444+ case existing of
445+ Just _ -> die "DuplicateAgentId" -- TODO: better error handling policy
446+ Nothing -> do
447+ node <- processNode <$> ask
448+ pid <- liftIO $ mxNew (localEventBus node) $ start
449+ register name pid
450+ return pid
451+ where
452+ start (sendTChan, recvTChan) = do
453+ let nState = MxAgentState mxId sendTChan initState
454+ runAgent dtor handlers InputChan recvTChan nState
455+
456+ runAgent :: MxAgent s ()
457+ -> [MxSink s]
458+ -> ChannelSelector
459+ -> TChan Message
460+ -> MxAgentState s
461+ -> Process ()
462+ runAgent eh hs cs c s =
463+ runAgentWithFinalizer eh hs cs c s
464+ `onException` runAgentFinalizer eh s
465+
466+ runAgentWithFinalizer :: MxAgent s ()
467+ -> [MxSink s]
468+ -> ChannelSelector
469+ -> TChan Message
470+ -> MxAgentState s
471+ -> Process ()
472+ runAgentWithFinalizer eh' hs' cs' c' s' = do
473+ msg <- getNextInput cs' c'
474+ (action, state) <- runPipeline msg s' $ pipeline hs'
475+ case action of
476+ MxAgentReady -> runAgent eh' hs' InputChan c' state
477+ MxAgentPrioritise priority -> runAgent eh' hs' priority c' state
478+ MxAgentDeactivate _ -> runAgentFinalizer eh' state
479+ MxAgentSkip -> error "IllegalState"
480+-- MxAgentBecome h' -> runAgent h' c state
481+
482+ getNextInput sel chan =
483+ let matches =
484+ case sel of
485+ Mailbox -> [ matchAny return
486+ , matchSTM (readTChan chan) return]
487+ InputChan -> [ matchSTM (readTChan chan) return
488+ , matchAny return]
489+ in receiveWait matches
490+
491+ runAgentFinalizer :: MxAgent s () -> MxAgentState s -> Process ()
492+ runAgentFinalizer f s = ST.runStateT (unAgent f) s >>= return . fst
493+
494+ pipeline :: forall s . [MxSink s] -> MxPipeline s
495+ pipeline [] = MxStop
496+ pipeline (sink:sinks) = MxPipeline sink (pipeline sinks)
497+
498+ runPipeline :: forall s .
499+ Message
500+ -> MxAgentState s
501+ -> MxPipeline s
502+ -> Process (MxAction, MxAgentState s)
503+ runPipeline _ state MxStop = return (MxAgentReady, state)
504+ runPipeline msg state MxPipeline{..} = do
505+ let act = current msg
506+ (pass, state') <- ST.runStateT (unAgent act) state
507+ case pass of
508+ Nothing -> runPipeline msg state next
509+ Just result -> return (result, state')
src/Control/Distributed/Process/Management/Internal/Agent.hsnew file+157
@@ -0,0 +1,157 @@
1+{-# LANGUAGE ScopedTypeVariables #-}
2+{-# LANGUAGE RecordWildCards #-}
3+
4+module Control.Distributed.Process.Management.Internal.Agent where
5+
6+import Control.Applicative
7+import Control.Concurrent (forkIO)
8+import Control.Concurrent.MVar (MVar, newEmptyMVar, putMVar, takeMVar)
9+import Control.Concurrent.STM (atomically)
10+import Control.Concurrent.STM.TChan
11+ ( TChan
12+ , newBroadcastTChanIO
13+ , readTChan
14+ , writeTChan
15+ , dupTChan
16+ )
17+import Control.Distributed.Process.Internal.Primitives
18+ ( receiveWait
19+ , matchAny
20+ , die
21+ , catches
22+ , Handler(..)
23+ )
24+import Control.Distributed.Process.Internal.CQueue
25+ ( enqueueSTM
26+ , CQueue
27+ )
28+import Control.Distributed.Process.Management.Internal.Types
29+ ( Fork
30+ )
31+import Control.Distributed.Process.Management.Internal.Trace.Tracer
32+ ( traceController
33+ )
34+import Control.Distributed.Process.Internal.Types
35+ ( Process
36+ , Message
37+ , Tracer(..)
38+ , LocalProcess(..)
39+ , ProcessId
40+ , forever'
41+ )
42+import Control.Exception (AsyncException(ThreadKilled), SomeException)
43+import Control.Monad (void)
44+import Control.Monad.IO.Class (liftIO)
45+import Control.Monad.Reader (ask)
46+import GHC.Weak (Weak, deRefWeak)
47+import Prelude
48+
49+--------------------------------------------------------------------------------
50+-- Agent Controller Implementation --
51+--------------------------------------------------------------------------------
52+
53+-- | A triple containing a configured tracer, weak pointer to the
54+-- agent controller's mailbox (CQueue) and an expression used to
55+-- instantiate new agents on the current node.
56+type AgentConfig =
57+ (Tracer, Weak (CQueue Message),
58+ (((TChan Message, TChan Message) -> Process ()) -> IO ProcessId))
59+
60+-- | Starts a management agent for the current node. The agent process
61+-- must not crash or be killed, so we generally avoid publishing its
62+-- @ProcessId@ where possible.
63+--
64+-- Our process is also responsible for forwarding messages to the trace
65+-- controller, since having two /special processes/ handled via the
66+-- @LocalNode@ would be inelegant. We forward messages directly to the
67+-- trace controller's message queue, just as the @MxEventBus@ that's
68+-- set up on the @LocalNode@ forwards messages directly to us. This
69+-- optimises the code path for tracing and avoids overloading the node
70+-- node controller's internal control plane with additional routing, at the
71+-- cost of a little more complexity and two cases where we break
72+-- encapsulation.
73+--
74+mxAgentController :: Fork
75+ -> MVar AgentConfig
76+ -> Process ()
77+mxAgentController forkProcess mv = do
78+ trc <- liftIO $ startTracing forkProcess
79+ sigbus <- liftIO $ newBroadcastTChanIO
80+ liftIO $ startDeadLetterQueue sigbus
81+ weakQueue <- processWeakQ <$> ask
82+ liftIO $ putMVar mv (trc, weakQueue, mxStartAgent forkProcess sigbus)
83+ go sigbus trc
84+ where
85+ go bus tracer = forever' $ do
86+ void $ receiveWait [
87+ -- This is exactly what it appears to be: a "catch all" handler.
88+ -- Since mxNotify can potentially pass an unevaluated thunk to
89+ -- our mailbox, the dequeue (i.e., matchMessage) can fail and
90+ -- crash this process, which we DO NOT want. Alternatively,
91+ -- we handle IO exceptions here explicitly, since we don't want
92+ -- this process to ever crash, and the assumption we therefore
93+ -- make is thus:
94+ --
95+ -- 1. only ThreadKilled can tell this process to terminate
96+ -- 2. all other exceptions are invalid and should be ignored
97+ --
98+ -- The outcome of course, is that /bad/ calls to mxNotify
99+ -- (e.g., passing unevaluated thunks that will crash when
100+ -- they're eventually forced) are thus silently ignored.
101+ --
102+ matchAny (liftIO . broadcast bus tracer)
103+ ] `catches` [Handler (\ThreadKilled -> die "Killed"),
104+ Handler (\(_ :: SomeException) -> return ())]
105+
106+ broadcast :: TChan Message -> Tracer -> Message -> IO ()
107+ broadcast ch tr msg = do
108+ tmQueue <- tracerQueue tr
109+ atomicBroadcast ch tmQueue msg
110+
111+ tracerQueue :: Tracer -> IO (Maybe (CQueue Message))
112+ tracerQueue (Tracer _ wQ) = deRefWeak wQ
113+
114+ atomicBroadcast :: TChan Message
115+ -> Maybe (CQueue Message)
116+ -> Message -> IO ()
117+ atomicBroadcast ch Nothing msg = liftIO $ atomically $ writeTChan ch msg
118+ atomicBroadcast ch (Just q) msg = do
119+ -- liftIO $ putStrLn $ "broadcasting " ++ (show msg)
120+ liftIO $ atomically $ enqueueSTM q msg >> writeTChan ch msg
121+
122+-- | Forks a new process in which an mxAgent is run.
123+--
124+mxStartAgent :: Fork
125+ -> TChan Message
126+ -> ((TChan Message, TChan Message) -> Process ())
127+ -> IO ProcessId
128+mxStartAgent fork chan handler = do
129+ chan' <- atomically (dupTChan chan)
130+ let proc = handler (chan, chan')
131+ fork proc
132+
133+-- | Start the tracer controller.
134+--
135+startTracing :: Fork -> IO Tracer
136+startTracing forkProcess = do
137+ mv <- newEmptyMVar
138+ pid <- forkProcess $ traceController mv
139+ wQ <- liftIO $ takeMVar mv
140+ return $ Tracer pid wQ
141+
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.hsnew file+21
@@ -0,0 +1,21 @@
1+-- | Interface to the management event bus.
2+module Control.Distributed.Process.Management.Internal.Bus
3+ ( publishEvent
4+ ) where
5+
6+import Control.Distributed.Process.Internal.CQueue
7+ ( enqueue
8+ )
9+import Control.Distributed.Process.Internal.Types
10+ ( MxEventBus(..)
11+ , Message
12+ )
13+import Data.Foldable (forM_)
14+import System.Mem.Weak (deRefWeak)
15+
16+publishEvent :: MxEventBus -> Message -> IO ()
17+publishEvent MxEventBusInitialising _ = return ()
18+publishEvent (MxEventBus _ _ wqRef _) msg = do
19+ mQueue <- deRefWeak wqRef
20+ forM_ mQueue $ \queue -> enqueue queue msg
21+
src/Control/Distributed/Process/Internal/Trace/Primitives.hs → src/Control/Distributed/Process/Management/Internal/Trace/Primitives.hsrenamed+28−55
@@ -1,17 +1,18 @@
1+{-# LANGUAGE FlexibleInstances #-}
2+{-# LANGUAGE TypeSynonymInstances #-}
13-- | Keeps the tracing API calls separate from the Tracer implementation,
24-- which allows us to avoid a nasty import cycle between tracing and
35-- the messaging primitives that rely on it, and also between the node
46-- controller (which requires access to the tracing related elements of
57-- our RemoteTable) and the Debug module, which requires @forkProcess@.
6−module Control.Distributed.Process.Internal.Trace.Primitives
7− ( Tracer
8− , TraceEvent(..)
9− -- * Sending Trace Data
10− , traceLog
8+-- This module is also used by the management agent, which relies on the
9+-- tracing infrastructure's messaging fabric.
10+module Control.Distributed.Process.Management.Internal.Trace.Primitives
11+ ( -- * Sending Trace Data
12+ traceLog
1113 , traceLogFmt
1214 , traceMessage
1315 -- * Configuring A Tracer
14− , isTracingEnabled
1516 , defaultTraceFlags
1617 , enableTrace
1718 , enableTraceAsync
@@ -27,36 +28,21 @@ module Control.Distributed.Process.Internal.Trace.Primitives
2728 , withRegisteredTracer
2829 ) where
2930
30−import Control.Applicative ((<$>))
31−import Control.Distributed.Process.Internal.Closure.BuiltIn
32− ( cpEnableTraceRemote
33− )
31+import Control.Applicative
3432import Control.Distributed.Process.Internal.Primitives
35− ( proxy
36− , finally
37− , die
38− , whereis
39− , send
33+ ( whereis
4034 , newChan
4135 , receiveChan
42− , receiveWait
43− , matchIf
44− , finally
45− , try
46− , monitor
47− , getSelfPid
48− , relay
36+ , die
4937 )
50−import Control.Distributed.Process.Internal.Trace.Types
38+import Control.Distributed.Process.Management.Internal.Trace.Types
5139 ( TraceArg(..)
52− , TraceEvent(..)
53− , SetTrace(..)
5440 , TraceFlags(..)
5541 , TraceOk(..)
5642 , TraceSubject(..)
5743 , defaultTraceFlags
5844 )
59−import qualified Control.Distributed.Process.Internal.Trace.Types as Tracer
45+import qualified Control.Distributed.Process.Management.Internal.Trace.Types as Tracer
6046 ( traceLog
6147 , traceLogFmt
6248 , traceMessage
@@ -69,37 +55,27 @@ import qualified Control.Distributed.Process.Internal.Trace.Types as Tracer
6955 , getTraceFlags
7056 , getCurrentTraceClient
7157 )
72−import Control.Distributed.Process.Internal.Spawn
73− ( spawn
74− )
7558import Control.Distributed.Process.Internal.Types
76− ( Tracer(..)
77− , Process
59+ ( Process
7860 , ProcessId
7961 , LocalProcess(..)
80− , LocalNode(localTracer)
81− , Message
62+ , LocalNode(localEventBus)
8263 , SendPort
83− , NodeId
84− , createUnencodedMessage
64+ , MxEventBus(..)
8565 )
8666import Control.Distributed.Process.Serializable
87−import Control.Distributed.Static
88− ( RemoteTable
89− , registerStatic
90− )
9167import Control.Monad.IO.Class (liftIO)
9268import Control.Monad.Reader (ask)
9369
94−import Data.Rank1Dynamic (toDynamic)
9570import qualified Data.Set as Set (fromList)
71+import Prelude
9672
9773--------------------------------------------------------------------------------
9874-- Main API --
9975--------------------------------------------------------------------------------
10076
101−-- | Maps a list of identifiers that can be mapped to process ids,
102−-- to a 'TraceSubject'.
77+-- | Converts a list of identifiers (that can be
78+-- mapped to process ids), to a 'TraceSubject'.
10379class Traceable a where
10480 uod :: [a] -> TraceSubject
10581
@@ -121,14 +97,6 @@ traceOn = Just TraceAll
12197traceOff :: Maybe TraceSubject
12298traceOff = Nothing
12399
124−-- | Determine whether or not tracing has been enabled.
125−isTracingEnabled :: Process Bool
126−isTracingEnabled = do
127− node <- processNode <$> ask
128− case (localTracer node) of
129− (ActiveTracer _ _) -> return True
130− _ -> return False
131−
132100-- | Enable tracing to the supplied process.
133101enableTraceAsync :: ProcessId -> Process ()
134102enableTraceAsync pid = withLocalTracer $ \t -> liftIO $ Tracer.enableTrace t pid
@@ -183,12 +151,12 @@ traceLogFmt d ls = withLocalTracer $ \t -> liftIO $ Tracer.traceLogFmt t d ls
183151traceMessage :: Serializable m => m -> Process ()
184152traceMessage msg = withLocalTracer $ \t -> liftIO $ Tracer.traceMessage t msg
185153
186−withLocalTracer :: (Tracer -> Process ()) -> Process ()
154+withLocalTracer :: (MxEventBus -> Process ()) -> Process ()
187155withLocalTracer act = do
188156 node <- processNode <$> ask
189− act (localTracer node)
157+ act (localEventBus node)
190158
191−withLocalTracerSync :: (Tracer -> SendPort TraceOk -> IO ()) -> Process ()
159+withLocalTracerSync :: (MxEventBus -> SendPort TraceOk -> IO ()) -> Process ()
192160withLocalTracerSync act = do
193161 (sp, rp) <- newChan
194162 withLocalTracer $ \t -> liftIO $ (act t sp)
@@ -201,6 +169,11 @@ withRegisteredTracer act = do
201169 withLocalTracer $ \t -> liftIO $ Tracer.getCurrentTraceClient t sp
202170 currentTracer <- receiveChan rp
203171 case currentTracer of
204− Nothing -> do { (Just p') <- whereis "tracer.initial"; act p' }
172+ Nothing -> do mTP <- whereis "tracer.initial"
173+ -- NB: this should NOT ever happen, but forcing pattern matches
174+ -- is not considered cool in later versions of MonadFail
175+ case mTP of
176+ Just p' -> act p'
177+ Nothing -> die $ "System Invariant Violation: Tracer Process "
178+ ++ "Name Not Found (whereis tracer.initial)"
205179 (Just p) -> act p
206−
src/Control/Distributed/Process/Internal/Trace/Remote.hs → src/Control/Distributed/Process/Management/Internal/Trace/Remote.hsrenamed+6−25
@@ -1,40 +1,24 @@
1−module Control.Distributed.Process.Internal.Trace.Remote
2− ( -- * Configuring A Tracer
1+module Control.Distributed.Process.Management.Internal.Trace.Remote
2+ ( -- * Configuring A Remote Tracer
33 setTraceFlagsRemote
44 , startTraceRelay
55 -- * Remote Table
66 , remoteTable
77 ) where
88
9−import Control.Applicative ((<$>))
109import Control.Distributed.Process.Internal.Closure.BuiltIn
1110 ( cpEnableTraceRemote
1211 )
1312import Control.Distributed.Process.Internal.Primitives
14− ( proxy
15− , finally
16− , die
17− , whereis
18− , send
19− , newChan
20− , receiveChan
21− , receiveWait
22− , matchIf
23− , finally
24− , try
25− , monitor
26− , getSelfPid
13+ ( getSelfPid
2714 , relay
2815 , nsendRemote
29− , say
3016 )
31−import Control.Distributed.Process.Internal.Trace.Types
17+import Control.Distributed.Process.Management.Internal.Trace.Types
3218 ( TraceFlags(..)
3319 , TraceOk(..)
34− , TraceSubject(..)
35− , defaultTraceFlags
3620 )
37−import Control.Distributed.Process.Internal.Trace.Primitives
21+import Control.Distributed.Process.Management.Internal.Trace.Primitives
3822 ( withRegisteredTracer
3923 , enableTrace
4024 )
@@ -47,13 +31,11 @@ import Control.Distributed.Process.Internal.Types
4731 , SendPort
4832 , NodeId
4933 )
50−import Control.Distributed.Process.Serializable
5134import Control.Distributed.Static
5235 ( RemoteTable
5336 , registerStatic
5437 )
5538import Data.Rank1Dynamic (toDynamic)
56−import qualified Data.Set as Set (fromList)
5739
5840-- | Remote Table.
5941remoteTable :: RemoteTable -> RemoteTable
@@ -63,12 +45,11 @@ enableTraceRemote :: ProcessId -> Process ()
6345enableTraceRemote pid =
6446 getSelfPid >>= enableTrace >> relay pid
6547
66−-- | Starts a /trace relay/ process on the remote node, that forwards all trace
48+-- | Starts a /trace relay/ process on the remote node, which forwards all trace
6749-- events to the registered tracer on /this/ (the calling process') node.
6850startTraceRelay :: NodeId -> Process ProcessId
6951startTraceRelay nodeId = do
7052 withRegisteredTracer $ \pid ->
71− -- TODO: move cpEnableTraceRemote here?
7253 spawn nodeId $ cpEnableTraceRemote pid
7354
7455-- | Set the given flags for a remote node (asynchronous).
src/Control/Distributed/Process/Internal/Trace/Tracer.hs → src/Control/Distributed/Process/Management/Internal/Trace/Tracer.hsrenamed+78−83
@@ -1,6 +1,8 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
13-- | Tracing/Debugging support - Trace Implementation
2−module Control.Distributed.Process.Internal.Trace.Tracer
3− ( -- * API for the Node Controller
4+module Control.Distributed.Process.Management.Internal.Trace.Tracer
5+ ( -- * API for the Management Agent
46 traceController
57 -- * Built in tracers
68 , defaultTracer
@@ -9,7 +11,7 @@ module Control.Distributed.Process.Internal.Trace.Tracer
911 , eventLogTracer
1012 ) where
1113
12−import Control.Applicative ((<$>))
14+import Control.Applicative
1315import Control.Concurrent.Chan (writeChan)
1416import Control.Concurrent.MVar
1517 ( MVar
@@ -19,33 +21,28 @@ import Control.Distributed.Process.Internal.CQueue
1921 ( CQueue
2022 )
2123import Control.Distributed.Process.Internal.Primitives
22− ( catch
23− , finally
24− , die
24+ ( die
2525 , receiveWait
2626 , forward
2727 , sendChan
2828 , match
2929 , matchAny
30− , matchAnyIf
3130 , matchIf
3231 , handleMessage
3332 , matchUnknown
34− , whereis
35− , getSelfPid
36− , register
37− , say, unwrapMessage
3833 )
39−import Control.Distributed.Process.Internal.Trace.Types
40− ( TraceEvent(..)
41− , SetTrace(..)
34+import Control.Distributed.Process.Management.Internal.Types
35+ ( MxEvent(..)
4236 , Addressable(..)
37+ )
38+import Control.Distributed.Process.Management.Internal.Trace.Types
39+ ( SetTrace(..)
4340 , TraceSubject(..)
4441 , TraceFlags(..)
4542 , TraceOk(..)
4643 , defaultTraceFlags
4744 )
48−import Control.Distributed.Process.Internal.Trace.Primitives
45+import Control.Distributed.Process.Management.Internal.Trace.Primitives
4946 ( traceOn )
5047import Control.Distributed.Process.Internal.Types
5148 ( LocalNode(..)
@@ -61,12 +58,13 @@ import Control.Distributed.Process.Internal.Types
6158 , nullProcessId
6259 , createUnencodedMessage
6360 )
64−import Control.Exception
65− ( SomeException
66− )
6761
6862import Control.Monad.IO.Class (liftIO)
6963import Control.Monad.Reader (ask)
64+import Control.Monad.Catch
65+ ( catch
66+ , finally
67+ )
7068
7169import Data.Set (Set)
7270import qualified Data.Set as Set
@@ -77,8 +75,11 @@ import Data.Maybe (fromMaybe)
7775import Data.Time.Clock (getCurrentTime)
7876import Data.Time.Format (formatTime)
7977import Debug.Trace (traceEventIO)
78+import Prelude
8079
80+#if ! MIN_VERSION_base(4,6,0)
8181import Prelude hiding (catch)
82+#endif
8283
8384import System.Environment (getEnv)
8485import System.IO
@@ -90,12 +91,18 @@ import System.IO
9091 , hPutStrLn
9192 , hSetBuffering
9293 )
94+#if MIN_VERSION_time(1,5,0)
95+import Data.Time.Format (defaultTimeLocale)
96+#else
9397import System.Locale (defaultTimeLocale)
98+#endif
9499import System.Mem.Weak
95100 ( Weak
96101 )
97102
98−data TracerState = TracerST {
103+data TracerState =
104+ TracerST
105+ {
99106 client :: !(Maybe ProcessId)
100107 , flags :: !TraceFlags
101108 , regNames :: !(Map ProcessId (Set String))
@@ -125,7 +132,7 @@ defaultEventLogTracer =
125132checkEnv :: String -> Process String
126133checkEnv s = liftIO $ getEnv s
127134
128−-- This trace client is (intentionally) useful - it simply provides
135+-- This trace client is (intentionally) a noop - it simply provides
129136-- an intial client for the trace controller to talk to, until some
130137-- other (hopefully more useful) client is installed over the top of
131138-- it. This is the default trace client.
@@ -136,21 +143,25 @@ nullTracer =
136143systemLoggerTracer :: Process ()
137144systemLoggerTracer = do
138145 node <- processNode <$> ask
139− let tr = sendTraceMsg node
146+ let tr = sendTraceLog node
140147 forever' $ receiveWait [ matchAny (\m -> handleMessage m tr) ]
141148 where
142− sendTraceMsg :: LocalNode -> TraceEvent -> Process ()
143− sendTraceMsg node ev = do
149+ sendTraceLog :: LocalNode -> MxEvent -> Process ()
150+ sendTraceLog node ev = do
144151 now <- liftIO $ getCurrentTime
145− msg <- return $ (formatTime defaultTimeLocale "%c" now, (show ev))
152+ msg <- return $ (formatTime defaultTimeLocale "%c" now, buildTxt ev)
146153 emptyPid <- return $ (nullProcessId (localNodeId node))
147154 traceMsg <- return $ NCMsg {
148155 ctrlMsgSender = ProcessIdentifier (emptyPid)
149− , ctrlMsgSignal = (NamedSend "logger"
156+ , ctrlMsgSignal = (NamedSend "trace.logger"
150157 (createUnencodedMessage msg))
151158 }
152159 liftIO $ writeChan (localCtrlChan node) traceMsg
153160
161+ buildTxt :: MxEvent -> String
162+ buildTxt (MxLog msg) = msg
163+ buildTxt ev = show ev
164+
154165eventLogTracer :: Process ()
155166eventLogTracer =
156167 -- NB: when the GHC event log supports tracing arbitrary (ish) data, we will
@@ -158,13 +169,12 @@ eventLogTracer =
158169 -- is a tracer process installed. This is just a stop gap until then.
159170 forever' $ receiveWait [ matchAny (\m -> handleMessage m writeTrace) ]
160171 where
161− writeTrace :: TraceEvent -> Process ()
172+ writeTrace :: MxEvent -> Process ()
162173 writeTrace ev = liftIO $ traceEventIO (show ev)
163174
164175logfileTracer :: FilePath -> Process ()
165176logfileTracer p = do
166177 -- TODO: error handling if the handle cannot be opened
167− liftIO $ putStrLn $ "writing to " ++ (show p)
168178 h <- liftIO $ openFile p AppendMode
169179 liftIO $ hSetBuffering h LineBuffering
170180 logger h `finally` (liftIO $ hClose h)
@@ -173,14 +183,14 @@ logfileTracer p = do
173183 logger h' = forever' $ do
174184 receiveWait [
175185 matchIf (\ev -> case ev of
176− TraceEvDisable -> True
177− (TraceEvTakeover _) -> True
186+ MxTraceDisable -> True
187+ (MxTraceTakeover _) -> True
178188 _ -> False)
179189 (\_ -> (liftIO $ hClose h') >> die "trace stopped")
180190 , matchAny (\ev -> handleMessage ev (writeTrace h'))
181191 ]
182192
183− writeTrace :: Handle -> TraceEvent -> Process ()
193+ writeTrace :: Handle -> MxEvent -> Process ()
184194 writeTrace h ev = do
185195 liftIO $ do
186196 now <- getCurrentTime
@@ -192,8 +202,8 @@ logfileTracer p = do
192202
193203traceController :: MVar ((Weak (CQueue Message))) -> Process ()
194204traceController mv = do
195− -- This breach of encapsulation is deliberate: we don't want to tie up
196− -- the node's internal control channel if we can possibly help it!
205+ -- See the documentation for mxAgentController for a
206+ -- commentary that explains this breach of encapsulation
197207 weakQueue <- processWeakQ <$> ask
198208 liftIO $ putMVar mv weakQueue
199209 initState <- initialState
@@ -201,23 +211,24 @@ traceController mv = do
201211 where
202212 traceLoop :: TracerState -> Process ()
203213 traceLoop st = do
204− -- Trace events are forwarded to the trace target when tracing is enabled.
214+ let client' = client st
215+ -- Trace events are forwarded to the enabled trace target.
205216 -- At some point in the future, we're going to start writing these custom
206217 -- events to the ghc eventlog, at which point this design might change.
207218 st' <- receiveWait [
208219 match (\(setResp, set :: SetTrace) -> do
209− -- We allow at most one trace client, which is a process id.
220+ -- We consider at most one trace client, which is a process.
210221 -- Tracking multiple clients represents too high an overhead,
211− -- so we leave that kind of thing to our consumers to figure
212− -- figure out.
222+ -- so we leave that kind of thing to our consumers (e.g., the
223+ -- high level Debug client module) to figure out.
213224 case set of
214225 (TraceEnable pid) -> do
215226 -- notify the previous tracer it has been replaced
216− sendTrace st (createUnencodedMessage (TraceEvTakeover pid))
227+ sendTraceMsg client' (createUnencodedMessage (MxTraceTakeover pid))
217228 sendOk setResp
218229 return st { client = (Just pid) }
219230 TraceDisable -> do
220− sendTrace st (createUnencodedMessage TraceEvDisable)
231+ sendTraceMsg client' (createUnencodedMessage MxTraceDisable)
221232 sendOk setResp
222233 return st { client = Nothing })
223234 , match (\(confResp, flags') ->
@@ -226,7 +237,7 @@ traceController mv = do
226237 , match (\chGetCurrent -> sendChan chGetCurrent (client st) >> return st)
227238 -- we dequeue incoming events even if we don't process them
228239 , matchAny (\ev ->
229− handleMessage ev (handleTrace st ev) >>= return . fromMaybe st)
240+ handleMessage ev (handleTrace st ev) >>= return . fromMaybe st)
230241 ]
231242 traceLoop st'
232243
@@ -247,9 +258,8 @@ traceController mv = do
247258 catch (checkEnv "DISTRIBUTED_PROCESS_TRACE_FLAGS" >>= return . parseFlags)
248259 (\(_ :: IOError) -> return defaultTraceFlags)
249260
250− -- quick and dirty fold-while
251261 parseFlags :: String -> TraceFlags
252− parseFlags flags = parseFlags' flags defaultTraceFlags
262+ parseFlags s = parseFlags' s defaultTraceFlags
253263 where parseFlags' :: String -> TraceFlags -> TraceFlags
254264 parseFlags' [] parsedFlags = parsedFlags
255265 parseFlags' (x:xs) parsedFlags
@@ -262,27 +272,11 @@ traceController mv = do
262272 | x == 'l' = parseFlags' xs parsedFlags { traceNodes = True }
263273 | otherwise = parseFlags' xs parsedFlags
264274
265−-- note [runtime tracer control]
266−--
267−-- The trace mechanism is designed to put as little stress on the system, and
268−-- in particular the node controller, as possible. The LocalNode's @tracer@
269−-- field is therefore immutable, since we don't want to be blocking the node
270−-- controller when writing trace information out. The runtime cost of enabling
271−-- tracing is therefore the cost of enqueue for all trace-able operations at
272−-- all times. If tracing is not explicitly enabled, the trace record stored in
273−-- the local node state is matched and ignored in API calls, reducing the cost
274−-- to a single function call.
275−--
276−-- To /disable/ tracing facilities in a runtime system that has tracing enabled
277−-- then, is to instruct the tracer process not to forward any trace event data
278−-- and it is not possible to remove the runtime overhead (of enqueue in the
279−-- caller and dequeue + noop in the tracer process) once the node is started.
280−
281275applyTraceFlags :: TraceFlags -> TracerState -> Process TracerState
282276applyTraceFlags flags' state = return state { flags = flags' }
283277
284−handleTrace :: TracerState -> Message -> TraceEvent -> Process TracerState
285−handleTrace st msg ev@(TraceEvRegistered p n) =
278+handleTrace :: TracerState -> Message -> MxEvent -> Process TracerState
279+handleTrace st msg ev@(MxRegistered p n) =
286280 let regNames' =
287281 Map.insertWith (\_ ns -> Set.insert n ns) p
288282 (Set.singleton n)
@@ -290,7 +284,7 @@ handleTrace st msg ev@(TraceEvRegistered p n) =
290284 in do
291285 traceEv ev msg (traceRegistered (flags st)) st
292286 return st { regNames = regNames' }
293−handleTrace st msg ev@(TraceEvUnRegistered p n) =
287+handleTrace st msg ev@(MxUnRegistered p n) =
294288 let f ns = case ns of
295289 Nothing -> Nothing
296290 Just ns' -> Just (Set.delete n ns')
@@ -298,46 +292,46 @@ handleTrace st msg ev@(TraceEvUnRegistered p n) =
298292 in do
299293 traceEv ev msg (traceUnregistered (flags st)) st
300294 return st { regNames = regNames' }
301−handleTrace st msg ev@(TraceEvSpawned _) = do
295+handleTrace st msg ev@(MxSpawned _) = do
302296 traceEv ev msg (traceSpawned (flags st)) st >> return st
303−handleTrace st msg ev@(TraceEvDied _ _) = do
297+handleTrace st msg ev@(MxProcessDied _ _) = do
304298 traceEv ev msg (traceDied (flags st)) st >> return st
305−handleTrace st msg ev@(TraceEvSent _ _ _) =
299+handleTrace st msg ev@(MxSent _ _ _) =
306300 traceEv ev msg (traceSend (flags st)) st >> return st
307−handleTrace st msg ev@(TraceEvReceived _ _) =
301+handleTrace st msg ev@(MxReceived _ _) =
308302 traceEv ev msg (traceRecv (flags st)) st >> return st
309303handleTrace st msg ev = do
310304 case ev of
311− (TraceEvNodeDied _ _) ->
305+ (MxNodeDied _ _) ->
312306 case (traceNodes (flags st)) of
313− True -> sendTrace st msg
307+ True -> sendTrace st ev msg
314308 False -> return ()
315− (TraceEvUser _) -> do
316− sendTrace st msg
309+ (MxUser _) -> sendTrace st ev msg
310+ (MxLog _) -> sendTrace st ev msg
317311 _ ->
318312 case (traceConnections (flags st)) of
319− True -> sendTrace st msg
313+ True -> sendTrace st ev msg
320314 False -> return ()
321315 return st
322316
323−traceEv :: TraceEvent
317+traceEv :: MxEvent
324318 -> Message
325319 -> Maybe TraceSubject
326320 -> TracerState
327321 -> Process ()
328322traceEv _ _ Nothing _ = return ()
329−traceEv _ msg (Just TraceAll) st = sendTrace st msg
323+traceEv ev msg (Just TraceAll) st = sendTrace st ev msg
330324traceEv ev msg (Just (TraceProcs pids)) st = do
331325 node <- processNode <$> ask
332326 let p = case resolveToPid ev of
333327 Nothing -> (nullProcessId (localNodeId node))
334328 Just pid -> pid
335329 case (Set.member p pids) of
336− True -> sendTrace st msg
330+ True -> sendTrace st ev msg
337331 False -> return ()
338332traceEv ev msg (Just (TraceNames names)) st = do
339− -- TODO: if we have recorded regnames for p, then we
340− -- forward the trace iif there are overlapping trace targets
333+ -- if we have recorded regnames for p, then we forward the trace iif
334+ -- there are overlapping trace targets
341335 node <- processNode <$> ask
342336 let p = case resolveToPid ev of
343337 Nothing -> (nullProcessId (localNodeId node))
@@ -346,14 +340,15 @@ traceEv ev msg (Just (TraceNames names)) st = do
346340 Nothing -> return ()
347341 Just ns -> if (Set.null (Set.intersection ns names))
348342 then return ()
349− else sendTrace st msg
350−
351−sendTrace :: TracerState -> Message -> Process ()
352−sendTrace st msg =
353− let pid = (client st) in do
354− (Just ev) <- unwrapMessage msg :: Process (Maybe TraceEvent)
355− case pid of
356− Just p -> (flip forward) p msg
357− Nothing -> return ()
343+ else sendTrace st ev msg
358344
345+sendTrace :: TracerState -> MxEvent -> Message -> Process ()
346+sendTrace st ev msg = do
347+ let c = client st
348+ if c == (resolveToPid ev) -- we do not send the tracer events about itself...
349+ then return ()
350+ else sendTraceMsg c msg
359351
352+sendTraceMsg :: Maybe ProcessId -> Message -> Process ()
353+sendTraceMsg Nothing _ = return ()
354+sendTraceMsg (Just p) msg = (flip forward) p msg
src/Control/Distributed/Process/Management/Internal/Trace/Types.hsnew file+159
@@ -0,0 +1,159 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE ExistentialQuantification #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE TypeSynonymInstances #-}
5+{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE DeriveGeneric #-}
7+
8+-- | Tracing/Debugging support - Types
9+module Control.Distributed.Process.Management.Internal.Trace.Types
10+ ( SetTrace(..)
11+ , TraceSubject(..)
12+ , TraceFlags(..)
13+ , TraceArg(..)
14+ , TraceOk(..)
15+ , traceLog
16+ , traceLogFmt
17+ , traceEvent
18+ , traceMessage
19+ , defaultTraceFlags
20+ , enableTrace
21+ , enableTraceSync
22+ , disableTrace
23+ , disableTraceSync
24+ , getTraceFlags
25+ , setTraceFlags
26+ , setTraceFlagsSync
27+ , getCurrentTraceClient
28+ ) where
29+
30+import Control.Distributed.Process.Internal.Types
31+ ( MxEventBus(..)
32+ , ProcessId
33+ , SendPort
34+ , unsafeCreateUnencodedMessage
35+ )
36+import Control.Distributed.Process.Management.Internal.Bus
37+ ( publishEvent
38+ )
39+import Control.Distributed.Process.Management.Internal.Types
40+ ( MxEvent(..)
41+ )
42+import Control.Distributed.Process.Serializable
43+import Data.Binary
44+import Data.List (intersperse)
45+import Data.Set (Set)
46+import Data.Typeable
47+import GHC.Generics
48+
49+--------------------------------------------------------------------------------
50+-- Types --
51+--------------------------------------------------------------------------------
52+
53+data SetTrace = TraceEnable !ProcessId | TraceDisable
54+ deriving (Typeable, Generic, Eq, Show)
55+instance Binary SetTrace where
56+
57+-- | Defines which processes will be traced by a given 'TraceFlag',
58+-- either by name, or @ProcessId@. Choosing @TraceAll@ is /by far/
59+-- the most efficient approach, as the tracer process therefore
60+-- avoids deciding whether or not a trace event is viable.
61+--
62+data TraceSubject =
63+ TraceAll -- enable tracing for all running processes
64+ | TraceProcs !(Set ProcessId) -- enable tracing for a set of processes
65+ | TraceNames !(Set String) -- enable tracing for a set of named/registered processes
66+ deriving (Typeable, Generic, Show)
67+instance Binary TraceSubject where
68+
69+-- | Defines /what/ will be traced. Flags that control tracing of
70+-- @Process@ events, take a 'TraceSubject' controlling which processes
71+-- should generate trace events in the target process.
72+data TraceFlags = TraceFlags {
73+ traceSpawned :: !(Maybe TraceSubject) -- filter process spawned tracing
74+ , traceDied :: !(Maybe TraceSubject) -- filter process died tracing
75+ , traceRegistered :: !(Maybe TraceSubject) -- filter process registration tracing
76+ , traceUnregistered :: !(Maybe TraceSubject) -- filter process un-registration
77+ , traceSend :: !(Maybe TraceSubject) -- filter process/message tracing by sender
78+ , traceRecv :: !(Maybe TraceSubject) -- filter process/message tracing by receiver
79+ , traceNodes :: !Bool -- enable node status trace events
80+ , traceConnections :: !Bool -- enable connection status trace events
81+ } deriving (Typeable, Generic, Show)
82+instance Binary TraceFlags where
83+
84+defaultTraceFlags :: TraceFlags
85+defaultTraceFlags =
86+ TraceFlags {
87+ traceSpawned = Nothing
88+ , traceDied = Nothing
89+ , traceRegistered = Nothing
90+ , traceUnregistered = Nothing
91+ , traceSend = Nothing
92+ , traceRecv = Nothing
93+ , traceNodes = False
94+ , traceConnections = False
95+ }
96+
97+data TraceArg =
98+ TraceStr String
99+ | forall a. (Show a) => Trace a
100+
101+-- | A generic 'ok' response from the trace coordinator.
102+data TraceOk = TraceOk
103+ deriving (Typeable, Generic)
104+instance Binary TraceOk where
105+
106+--------------------------------------------------------------------------------
107+-- Internal/Common API --
108+--------------------------------------------------------------------------------
109+
110+traceLog :: MxEventBus -> String -> IO ()
111+traceLog tr s = publishEvent tr (unsafeCreateUnencodedMessage $ MxLog s)
112+
113+traceLogFmt :: MxEventBus
114+ -> String
115+ -> [TraceArg]
116+ -> IO ()
117+traceLogFmt t d ls =
118+ traceLog t $ concat (intersperse d (map toS ls))
119+ where toS :: TraceArg -> String
120+ toS (TraceStr s) = s
121+ toS (Trace a) = show a
122+
123+traceEvent :: MxEventBus -> MxEvent -> IO ()
124+traceEvent tr ev = publishEvent tr (unsafeCreateUnencodedMessage ev)
125+
126+traceMessage :: Serializable m => MxEventBus -> m -> IO ()
127+traceMessage tr msg = traceEvent tr (MxUser (unsafeCreateUnencodedMessage msg))
128+
129+enableTrace :: MxEventBus -> ProcessId -> IO ()
130+enableTrace t p =
131+ publishEvent t (unsafeCreateUnencodedMessage ((Nothing :: Maybe (SendPort TraceOk)),
132+ (TraceEnable p)))
133+
134+enableTraceSync :: MxEventBus -> SendPort TraceOk -> ProcessId -> IO ()
135+enableTraceSync t s p =
136+ publishEvent t (unsafeCreateUnencodedMessage (Just s, TraceEnable p))
137+
138+disableTrace :: MxEventBus -> IO ()
139+disableTrace t =
140+ publishEvent t (unsafeCreateUnencodedMessage ((Nothing :: Maybe (SendPort TraceOk)),
141+ TraceDisable))
142+
143+disableTraceSync :: MxEventBus -> SendPort TraceOk -> IO ()
144+disableTraceSync t s =
145+ publishEvent t (unsafeCreateUnencodedMessage ((Just s), TraceDisable))
146+
147+setTraceFlags :: MxEventBus -> TraceFlags -> IO ()
148+setTraceFlags t f =
149+ publishEvent t (unsafeCreateUnencodedMessage ((Nothing :: Maybe (SendPort TraceOk)), f))
150+
151+setTraceFlagsSync :: MxEventBus -> SendPort TraceOk -> TraceFlags -> IO ()
152+setTraceFlagsSync t s f =
153+ publishEvent t (unsafeCreateUnencodedMessage ((Just s), f))
154+
155+getTraceFlags :: MxEventBus -> SendPort TraceFlags -> IO ()
156+getTraceFlags t s = publishEvent t (unsafeCreateUnencodedMessage s)
157+
158+getCurrentTraceClient :: MxEventBus -> SendPort (Maybe ProcessId) -> IO ()
159+getCurrentTraceClient t s = publishEvent t (unsafeCreateUnencodedMessage s)
src/Control/Distributed/Process/Management/Internal/Types.hsnew file+141
@@ -0,0 +1,141 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE ExistentialQuantification #-}
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE DeriveGeneric #-}
5+module Control.Distributed.Process.Management.Internal.Types
6+ ( MxAgentId(..)
7+ , MxAgentState(..)
8+ , MxAgent(..)
9+ , MxAction(..)
10+ , ChannelSelector(..)
11+ , Fork
12+ , MxSink
13+ , MxEvent(..)
14+ , Addressable(..)
15+ ) where
16+
17+import Control.Applicative (Applicative)
18+import Control.Concurrent.STM
19+ ( TChan
20+ )
21+import Control.Distributed.Process.Internal.Types
22+ ( Process
23+ , ProcessId
24+ , SendPortId
25+ , Message
26+ , DiedReason
27+ , NodeId
28+ )
29+import Control.Monad.IO.Class (MonadIO)
30+import qualified Control.Monad.State as ST
31+ ( MonadState
32+ , StateT
33+ )
34+import Control.Monad.Fix (MonadFix)
35+import Data.Binary
36+import Data.Typeable (Typeable)
37+import GHC.Generics
38+import Network.Transport
39+ ( ConnectionId
40+ , EndPointAddress
41+ )
42+
43+-- | This is the /default/ management event, fired for various internal
44+-- events around the NT connection and Process lifecycle. All published
45+-- events that conform to this type, are eligible for tracing - i.e.,
46+-- they will be delivered to the trace controller.
47+--
48+data MxEvent =
49+ MxSpawned ProcessId
50+ -- ^ fired whenever a local process is spawned
51+ | MxRegistered ProcessId String
52+ -- ^ fired whenever a process/name is registered (locally)
53+ | MxUnRegistered ProcessId String
54+ -- ^ fired whenever a process/name is unregistered (locally)
55+ | MxProcessDied ProcessId DiedReason
56+ -- ^ fired whenever a process dies
57+ | MxNodeDied NodeId DiedReason
58+ -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
59+ | MxSent ProcessId ProcessId Message
60+ -- ^ 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
66+ -- ^ 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
70+ -- ^ fired when a network-transport connection is first established
71+ | MxDisconnected ConnectionId EndPointAddress
72+ -- ^ fired when a network-transport connection is broken/disconnected
73+ | MxUser Message
74+ -- ^ a user defined trace event
75+ | MxLog String
76+ -- ^ a /logging/ event - used for debugging purposes only
77+ | MxTraceTakeover ProcessId
78+ -- ^ notifies a trace listener that all subsequent traces will be sent to /pid/
79+ | MxTraceDisable
80+ -- ^ notifies a trace listener that it has been disabled/removed
81+ deriving (Typeable, Generic, Show)
82+
83+instance Binary MxEvent where
84+
85+-- | The class of things that we might be able to resolve to
86+-- a @ProcessId@ (or not).
87+class Addressable a where
88+ resolveToPid :: a -> Maybe ProcessId
89+
90+instance Addressable MxEvent where
91+ resolveToPid (MxSpawned p) = Just p
92+ resolveToPid (MxProcessDied p _) = Just p
93+ resolveToPid (MxSent _ p _) = Just p
94+ resolveToPid (MxReceived p _) = Just p
95+ resolveToPid _ = Nothing
96+
97+-- | Gross though it is, this synonym represents a function
98+-- used to forking new processes, which has to be passed as a HOF
99+-- when calling mxAgentController, since there's no other way to
100+-- avoid a circular dependency with Node.hs
101+type Fork = (Process () -> IO ProcessId)
102+
103+-- | A newtype wrapper for an agent id (which is a string).
104+newtype MxAgentId = MxAgentId { agentId :: String }
105+ deriving (Typeable, Binary, Eq, Ord)
106+
107+data MxAgentState s = MxAgentState
108+ {
109+ mxAgentId :: !MxAgentId
110+ , mxBus :: !(TChan Message)
111+ , mxLocalState :: !s
112+ }
113+
114+-- | Monad for management agents.
115+--
116+newtype MxAgent s a =
117+ MxAgent
118+ {
119+ unAgent :: ST.StateT (MxAgentState s) Process a
120+ } deriving ( Functor
121+ , Monad
122+ , MonadIO
123+ , MonadFix
124+ , ST.MonadState (MxAgentState s)
125+ , Typeable
126+ , Applicative
127+ )
128+
129+data ChannelSelector = InputChan | Mailbox
130+
131+-- | Represents the actions a management agent can take
132+-- when evaluating an /event sink/.
133+--
134+data MxAction =
135+ MxAgentDeactivate !String
136+ | MxAgentPrioritise !ChannelSelector
137+ | MxAgentReady
138+ | MxAgentSkip
139+
140+-- | Type of a management agent's event sink.
141+type MxSink s = Message -> MxAgent s (Maybe MxAction)
src/Control/Distributed/Process/Node.hs+413−255
@@ -1,3 +1,12 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DeriveDataTypeable #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+{-# LANGUAGE RankNTypes #-}
5+{-# LANGUAGE BangPatterns #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7+{-# LANGUAGE RecordWildCards #-}
8+{-# LANGUAGE MagicHash #-}
9+
110-- | Local nodes
211--
312module Control.Distributed.Process.Node
@@ -12,10 +21,6 @@ module Control.Distributed.Process.Node
1221
1322-- TODO: Calls to 'sendBinary' and co (by the NC) may stall the node controller.
1423
15−#if ! MIN_VERSION_base(4,6,0)
16−import Prelude hiding (catch)
17−#endif
18−
1924import System.IO (fixIO, hPutStrLn, stderr)
2025import System.Mem.Weak (Weak, deRefWeak)
2126import qualified Data.ByteString.Lazy as BSL (fromChunks)
@@ -23,46 +28,67 @@ import Data.Binary (decode)
2328import Data.Map (Map)
2429import qualified Data.Map as Map
2530 ( empty
31+ , delete
2632 , toList
2733 , fromList
28− , filter
34+ , insert
35+ , lookup
36+ , partition
2937 , partitionWithKey
3038 , elems
39+ , size
3140 , filterWithKey
3241 , foldlWithKey
3342 )
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
3449import Data.Set (Set)
3550import qualified Data.Set as Set
3651 ( empty
3752 , insert
3853 , delete
54+ , map
3955 , member
4056 , toList
57+ , union
4158 )
4259import Data.Foldable (forM_)
4360import Data.Maybe (isJust, fromJust, isNothing, catMaybes)
4461import Data.Typeable (Typeable)
4562import Control.Category ((>>>))
46−import Control.Applicative ((<$>))
47−import Control.Monad (void, when)
63+import Control.Applicative
64+import Control.Monad (void, when, join)
4865import Control.Monad.IO.Class (MonadIO, liftIO)
4966import Control.Monad.State.Strict (MonadState, StateT, evalStateT, gets)
5067import qualified Control.Monad.State.Strict as StateT (get, put)
5168import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask)
5269import Control.Exception
5370 ( throwIO
54− , AsyncException(ThreadKilled)
5571 , SomeException
5672 , Exception
5773 , throwTo
74+ , uninterruptibleMask_
75+ , getMaskingState
76+ , MaskingState(..)
77+ )
78+import qualified Control.Exception as Exception
79+ ( Handler(..)
80+ , catch
81+ , catches
82+ , finally
5883 )
59−import qualified Control.Exception as Exception (catch, finally)
60−import Control.Concurrent (forkIO)
84+import Control.Concurrent (forkIO, killThread)
85+import Control.Distributed.Process.Internal.BiMultiMap (BiMultiMap)
86+import qualified Control.Distributed.Process.Internal.BiMultiMap as BiMultiMap
6187import Control.Distributed.Process.Internal.StrictMVar
6288 ( newMVar
6389 , withMVar
90+ , modifyMVarMasked
6491 , modifyMVar
65− , modifyMVar_
6692 , newEmptyMVar
6793 , putMVar
6894 , takeMVar
@@ -77,6 +103,7 @@ import Control.Distributed.Process.Internal.CQueue
77103 , enqueue
78104 , newCQueue
79105 , mkWeakCQueue
106+ , queueSize
80107 )
81108import qualified Network.Transport as NT
82109 ( Transport
@@ -88,8 +115,8 @@ import qualified Network.Transport as NT
88115 , TransportError(..)
89116 , address
90117 , closeEndPoint
91− , ConnectionId
92118 , Connection
119+ , ConnectionId
93120 , close
94121 , EndPointAddress
95122 , Reliability(ReliableOrdered)
@@ -106,8 +133,11 @@ import Control.Distributed.Process.Internal.Types
106133 , LocalProcessId(..)
107134 , ProcessId(..)
108135 , LocalNode(..)
109− , Tracer(..)
136+ , MxEventBus(..)
110137 , LocalNodeState(..)
138+ , ValidLocalNodeState(..)
139+ , withValidLocalState
140+ , modifyValidLocalState
111141 , LocalProcess(..)
112142 , LocalProcessState(..)
113143 , Process(..)
@@ -117,9 +147,11 @@ import Control.Distributed.Process.Internal.Types
117147 , localPidCounter
118148 , localPidUnique
119149 , localProcessWithId
150+ , localProcesses
120151 , localConnections
121152 , forever'
122153 , MonitorRef(..)
154+ , NodeClosedException(..)
123155 , ProcessMonitorNotification(..)
124156 , NodeMonitorNotification(..)
125157 , PortMonitorNotification(..)
@@ -139,53 +171,74 @@ import Control.Distributed.Process.Internal.Types
139171 , nodeOf
140172 , ProcessInfo(..)
141173 , ProcessInfoNone(..)
174+ , NodeStats(..)
142175 , SendPortId(..)
143176 , typedChannelWithId
144177 , RegisterReply(..)
145178 , WhereIsReply(..)
146179 , payloadToMessage
147180 , createUnencodedMessage
181+ , unsafeCreateUnencodedMessage
148182 , runLocalProcess
149183 , firstNonReservedProcessId
150184 , ImplicitReconnect(WithImplicitReconnect)
151185 )
152−import qualified Control.Distributed.Process.Internal.Trace.Remote as Trace
186+import Control.Distributed.Process.Management.Internal.Agent
187+ ( mxAgentController
188+ )
189+import Control.Distributed.Process.Management.Internal.Types
190+ ( MxEvent(..)
191+ )
192+import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Trace
153193 ( remoteTable
154194 )
155−import Control.Distributed.Process.Internal.Trace.Types
195+import Control.Distributed.Process.Management.Internal.Trace.Tracer
196+ ( defaultTracer
197+ )
198+import Control.Distributed.Process.Management.Internal.Trace.Types
156199 ( TraceArg(..)
157− , TraceEvent(..)
158200 , traceEvent
159201 , traceLogFmt
160202 , enableTrace
161203 )
162−import Control.Distributed.Process.Internal.Trace.Tracer
163− ( traceController
164− , defaultTracer
165− )
166204import Control.Distributed.Process.Serializable (Serializable)
167205import Control.Distributed.Process.Internal.Messaging
168206 ( sendBinary
169− , sendMessage
170207 , closeImplicitReconnections
171208 , impliesDeathOf
172209 )
173210import Control.Distributed.Process.Internal.Primitives
174211 ( register
175− , finally
176212 , receiveWait
177213 , match
178214 , sendChan
215+ , unwrapMessage
216+ , monitor
217+ , unmonitorAsync
218+ , getSelfNode
219+ , SayMessage(..)
179220 )
180−import Control.Distributed.Process.Internal.Types (SendPort)
221+import Control.Distributed.Process.Internal.Types (SendPort, Tracer(..))
181222import qualified Control.Distributed.Process.Internal.Closure.BuiltIn as BuiltIn (remoteTable)
182223import Control.Distributed.Process.Internal.WeakTQueue (TQueue, writeTQueue)
183224import qualified Control.Distributed.Process.Internal.StrictContainerAccessors as DAC
184225 ( mapMaybe
185226 , mapDefault
186227 )
187−import System.Environment (getEnv)
228+import Control.Monad.Catch (try)
229+import GHC.IO (IO(..), unsafeUnmask)
230+import GHC.Base ( maskAsyncExceptions# )
231+
188232import 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
189242
190243--------------------------------------------------------------------------------
191244-- Initialization --
@@ -209,7 +262,7 @@ newLocalNode transport rtable = do
209262createBareLocalNode :: NT.EndPoint -> RemoteTable -> IO LocalNode
210263createBareLocalNode endPoint rtable = do
211264 unq <- randomIO
212− state <- newMVar LocalNodeState
265+ state <- newMVar $ LocalNodeValid $ ValidLocalNodeState
213266 { _localProcesses = Map.empty
214267 , _localPidCounter = firstNonReservedProcessId
215268 , _localPidUnique = unq
@@ -220,10 +273,10 @@ createBareLocalNode endPoint rtable = do
220273 , localEndPoint = endPoint
221274 , localState = state
222275 , localCtrlChan = ctrlChan
223− , localTracer = InactiveTracer
276+ , localEventBus = MxEventBusInitialising
224277 , remoteTable = rtable
225278 }
226− tracedNode <- startTracing node
279+ tracedNode <- startMxAgent node
227280
228281 -- Once the NC terminates, the endpoint isn't much use,
229282 void $ forkIO $ Exception.finally (runNodeController tracedNode)
@@ -241,38 +294,27 @@ createBareLocalNode endPoint rtable = do
241294 , ctrlMsgSignal = SigShutdown
242295 }
243296
244−startTracing :: LocalNode -> IO LocalNode
245−startTracing node =
246− -- TODO: use tryGetEnv once we drop support for GHC 7.2.x
247− Exception.catch
248− (getEnv "DISTRIBUTED_PROCESS_TRACE_ENABLED" >> procTracer node)
249− (\(_ :: IOError) -> return node)
250− where procTracer :: LocalNode -> IO LocalNode
251− procTracer n = do
252− -- see note [tracer/forkProcess races]
253− mv <- MVar.newEmptyMVar
254− pid <- forkProcess n (traceController mv)
255− wqRef <- MVar.takeMVar mv
256− return n { localTracer = (ActiveTracer pid wqRef) }
257−
258−startDefaultTracer :: LocalNode -> IO (Maybe ProcessId)
259−startDefaultTracer node =
260− Exception.catch
261− (getEnv "DISTRIBUTED_PROCESS_TRACE_ENABLED" >> go node)
262− (\(_ :: IOError) -> return Nothing)
263− where go :: LocalNode -> IO (Maybe ProcessId)
264− go node' = do
265− registerTraceController node'
266− pid <- forkProcess node' defaultTracer
267− enableTrace (localTracer node') pid
268− return (Just pid)
269−
270− registerTraceController :: LocalNode -> IO ()
271− registerTraceController n =
272− let t = localTracer n in
273− case t of
274− InactiveTracer -> return ()
275− (ActiveTracer pid _) -> runProcess n $ register "trace.controller" pid
297+startMxAgent :: LocalNode -> IO LocalNode
298+startMxAgent node = do
299+ -- see note [tracer/forkProcess races]
300+ let fork = forkProcess node
301+ mv <- MVar.newEmptyMVar
302+ pid <- fork $ mxAgentController fork mv
303+ (tracer', wqRef, mxNew') <- MVar.takeMVar mv
304+ return node { localEventBus = (MxEventBus pid tracer' wqRef mxNew') }
305+
306+startDefaultTracer :: LocalNode -> IO ()
307+startDefaultTracer node' = do
308+ let t = localEventBus node'
309+ case t of
310+ MxEventBus _ (Tracer pid _) _ _ -> do
311+ runProcess node' $ register "trace.controller" pid
312+ pid' <- forkProcess node' defaultTracer
313+ enableTrace (localEventBus node') pid'
314+ runProcess node' $ register "tracer.initial" pid'
315+ _ -> return ()
316+
317+-- TODO: we need a better mechanism for defining and registering services
276318
277319-- | Start and register the service processes on a node
278320startServiceProcesses :: LocalNode -> IO ()
@@ -281,50 +323,71 @@ startServiceProcesses node = do
281323 -- the default tracer first, even though it might @nsend@ to the logger
282324 -- before /that/ process has started - this is a totally harmless race
283325 -- however, so we deliberably ignore it
284− mPid <- startDefaultTracer node
285− case mPid of
286− Nothing -> return ()
287− Just pid -> runProcess node $ register "tracer.initial" pid
288−
326+ startDefaultTracer node
289327 logger <- forkProcess node loop
290− runProcess node $ register "logger" logger
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
291334 where
292− loop = do
293− receiveWait
294− [ match $ \((time, pid, string) ::(String, ProcessId, String)) -> do
295− liftIO . hPutStrLn stderr $ time ++ " " ++ show pid ++ ": " ++ string
296− loop
297− , match $ \((time, string) :: (String, String)) -> do
298− -- this is a 'trace' message from the local node tracer
299− liftIO . hPutStrLn stderr $ time ++ " [trace] " ++ string
300− loop
301− , match $ \(ch :: SendPort ()) -> -- a shutdown request
302− sendChan ch ()
303− ]
304−
305−-- | Force-close a local node
306−--
307−-- TODO: for now we just close the associated endpoint
335+ loop = do
336+ receiveWait
337+ [ match $ \(SayMessage time pid string) -> do
338+ let time' = formatTime defaultTimeLocale "%c" time
339+ liftIO . hPutStrLn stderr $ time' ++ " " ++ show pid ++ ": " ++ string
340+ loop
341+ , match $ \((time, string) :: (String, String)) -> do
342+ -- this is a 'trace' message from the local node tracer
343+ liftIO . hPutStrLn stderr $ time ++ " [trace] " ++ string
344+ loop
345+ , match $ \(ch :: SendPort ()) -> -- a shutdown request
346+ sendChan ch ()
347+ ]
348+
349+-- | Force-close a local node, killing all processes on that node.
308350closeLocalNode :: LocalNode -> IO ()
309−closeLocalNode node =
310− -- TODO: close all our processes, surely!?
351+closeLocalNode node = do
352+ -- Kill processes after refilling the mvar. Otherwise, there is potential for
353+ -- deadlock as a dying process tries to get the mvar while masking exceptions
354+ -- uninterruptibly.
355+ join $ modifyMVar (localState node) $ \st -> case st of
356+ LocalNodeValid vst -> do
357+ return ( LocalNodeClosed
358+ , forM_ (vst ^. localProcesses) $ \lproc ->
359+ -- Semantics of 'throwTo' guarantee that target thread will get
360+ -- delivered an exception. Therefore, target thread will be
361+ -- killed eventually and that's as good as we can do. No need
362+ -- to wait for thread to actually finish dying.
363+ killThread (processThread lproc)
364+ )
365+ LocalNodeClosed -> return (LocalNodeClosed, return ())
366+ -- This call will have the effect of shutting down the NC as well (see
367+ -- 'createBareLocalNode').
311368 NT.closeEndPoint (localEndPoint node)
312369
313370-- | Run a process on a local node and wait for it to finish
314371runProcess :: LocalNode -> Process () -> IO ()
315372runProcess node proc = do
316373 done <- newEmptyMVar
317− void $ forkProcess node (proc `finally` liftIO (putMVar done ()))
318− takeMVar done
374+ -- TODO; When forkProcess inherits the masking state, protect the forked
375+ -- thread against async exceptions that could occur before 'try' is evaluated.
376+ void $ forkProcess node $ try proc >>= liftIO . putMVar done
377+ takeMVar done >>= either (throwIO :: SomeException -> IO a) return
319378
320379-- | Spawn a new process on a local node
321380forkProcess :: LocalNode -> Process () -> IO ProcessId
322−forkProcess node proc = modifyMVar (localState node) startProcess
381+forkProcess node proc = do
382+ ms <- getMaskingState
383+ modifyMVarMasked (localState node) (startProcess ms)
323384 where
324− startProcess :: LocalNodeState -> IO (LocalNodeState, ProcessId)
325− startProcess st = do
326− let lpid = LocalProcessId { lpidCounter = st ^. localPidCounter
327− , lpidUnique = st ^. localPidUnique
385+ startProcess :: MaskingState
386+ -> LocalNodeState
387+ -> IO (LocalNodeState, ProcessId)
388+ startProcess ms (LocalNodeValid vst) = do
389+ let lpid = LocalProcessId { lpidCounter = vst ^. localPidCounter
390+ , lpidUnique = vst ^. localPidUnique
328391 }
329392 let pid = ProcessId { processNodeId = localNodeId node
330393 , processLocalId = lpid
@@ -344,53 +407,78 @@ forkProcess node proc = modifyMVar (localState node) startProcess
344407 , processThread = tid
345408 , processNode = node
346409 }
347− tid' <- forkIO $ do
348− reason <- Exception.catch
349− (runLocalProcess lproc proc >> return DiedNormal)
350− (return . DiedException . (show :: SomeException -> String))
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
417+ reason <- Exception.catches
418+ (unmask $ runLocalProcess lproc proc >> return DiedNormal)
419+ [ (Exception.Handler (\ex@(ProcessExitException from msg) -> do
420+ mMsg <- unwrapMessage msg :: IO (Maybe String)
421+ case mMsg of
422+ Nothing -> return $ DiedException $ show ex
423+ Just m -> return $ DiedException ("exit-from=" ++ (show from) ++ ",reason=" ++ m)))
424+ , (Exception.Handler
425+ (return . DiedException . (show :: SomeException -> String)))]
351426
352427 -- [Unified: Table 4, rules termination and exiting]
353− modifyMVar_ (localState node) (cleanupProcess pid)
428+ mconns <- modifyValidLocalState node (cleanupProcess pid)
429+ -- XXX: Revisit after agreeing on the bigger picture for the semantics
430+ -- of transport operations.
431+ -- https://github.com/haskell-distributed/distributed-process/issues/204
432+ forM_ mconns $ forkIO . mapM_ NT.close
433+
354434 writeChan (localCtrlChan node) NCMsg
355435 { ctrlMsgSender = ProcessIdentifier pid
356436 , ctrlMsgSignal = Died (ProcessIdentifier pid) reason
357437 }
358438 return (tid', lproc)
359439
360−
361440 -- see note [tracer/forkProcess races]
362− trace node (TraceEvSpawned pid)
441+ trace node (MxSpawned pid)
363442
364443 if lpidCounter lpid == maxBound
365444 then do
445+ -- TODO: this doesn't look right at all - how do we know
446+ -- that newUnique represents a process id that is available!?
366447 newUnique <- randomIO
367− return ( (localProcessWithId lpid ^= Just lproc)
448+ return ( LocalNodeValid
449+ $ (localProcessWithId lpid ^= Just lproc)
368450 . (localPidCounter ^= firstNonReservedProcessId)
369451 . (localPidUnique ^= newUnique)
370− $ st
452+ $ vst
371453 , pid
372454 )
373455 else
374− return ( (localProcessWithId lpid ^= Just lproc)
456+ return ( LocalNodeValid
457+ $ (localProcessWithId lpid ^= Just lproc)
375458 . (localPidCounter ^: (+ 1))
376− $ st
459+ $ vst
377460 , pid
378461 )
462+ startProcess _ LocalNodeClosed =
463+ throwIO $ NodeClosedException $ localNodeId node
379464
380− cleanupProcess :: ProcessId -> LocalNodeState -> IO LocalNodeState
381− cleanupProcess pid st = do
465+ cleanupProcess :: ProcessId
466+ -> ValidLocalNodeState
467+ -> IO (ValidLocalNodeState, [NT.Connection])
468+ cleanupProcess pid vst = do
382469 let pid' = ProcessIdentifier pid
383− let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (st ^. localConnections)
384− mapM_ (NT.close . fst) (Map.elems affected)
385− return $ (localProcessWithId (processLocalId pid) ^= Nothing)
386− . (localConnections ^= unaffected)
387− $ st
470+ let (affected, unaffected) = Map.partitionWithKey (\(fr, _to) !_v -> impliesDeathOf pid' fr) (vst ^. localConnections)
471+ return ( (localProcessWithId (processLocalId pid) ^= Nothing)
472+ . (localConnections ^= unaffected)
473+ $ vst
474+ , map fst $ Map.elems affected
475+ )
388476
389477-- note [tracer/forkProcess races]
390478--
391479-- Our startTracing function uses forkProcess to start the trace controller
392480-- process, and of course forkProcess attempts to call traceEvent once the
393−-- process has started. This is harmless, as the localTracer is not updated
481+-- process has started. This is harmless, as the localEventBus is not updated
394482-- until /after/ the initial forkProcess completes, so the first call to
395483-- traceEvent behaves as if tracing were disabled (i.e., it is ignored).
396484--
@@ -404,7 +492,7 @@ type IncomingConnection = (NT.EndPointAddress, IncomingTarget)
404492data IncomingTarget =
405493 Uninit
406494 | ToProc ProcessId (Weak (CQueue Message))
407− | ToChan TypedChannel
495+ | ToChan SendPortId TypedChannel
408496 | ToNode
409497
410498data ConnectionState = ConnectionState {
@@ -431,6 +519,7 @@ incomingFrom addr = aux >>> DAC.mapDefault Set.empty addr
431519
432520handleIncomingMessages :: LocalNode -> IO ()
433521handleIncomingMessages node = go initConnectionState
522+ `Exception.catch` \(NodeClosedException _) -> return ()
434523 where
435524 go :: ConnectionState -> IO ()
436525 go !st = do
@@ -439,13 +528,14 @@ handleIncomingMessages node = go initConnectionState
439528 NT.ConnectionOpened cid rel theirAddr ->
440529 if rel == NT.ReliableOrdered
441530 then
442− trace node (TraceEvConnected cid)
531+ trace node (MxConnected cid theirAddr)
443532 >> go (
444533 (incomingAt cid ^= Just (theirAddr, Uninit))
445534 . (incomingFrom theirAddr ^: Set.insert cid)
446535 $ st
447536 )
448− else invalidRequest cid st
537+ else invalidRequest cid st $
538+ "attempt to connect with unsupported reliability " ++ show rel
449539 NT.Received cid payload ->
450540 case st ^. incomingAt cid of
451541 Just (_, ToProc pid weakQueue) -> do
@@ -455,15 +545,19 @@ handleIncomingMessages node = go initConnectionState
455545 -- it from the NC state? (and same for channels, below)
456546 let msg = payloadToMessage payload
457547 enqueue queue msg -- 'enqueue' is strict
458− trace node (TraceEvReceived pid msg)
548+ trace node (MxReceived pid msg)
459549 go st
460− Just (_, ToChan (TypedChannel chan')) -> do
550+ Just (_, ToChan chId (TypedChannel chan')) -> do
461551 mChan <- deRefWeak chan'
462552 -- If mChan is Nothing, the process has given up the read end of
463553 -- the channel and we simply ignore the incoming message
464− forM_ mChan $ \chan -> atomically $
465− -- We make sure the message is fully decoded when it is enqueued
466− writeTQueue chan $! decode (BSL.fromChunks payload)
554+ forM_ mChan $ \chan -> do
555+ msg' <- atomically $ do
556+ msg <- return $! decode (BSL.fromChunks payload)
557+ -- We make sure the message is fully decoded when it is enqueued
558+ writeTQueue chan msg
559+ return msg
560+ trace node $ MxReceivedPort chId $ unsafeCreateUnencodedMessage msg'
467561 go st
468562 Just (_, ToNode) -> do
469563 let ctrlMsg = decode . BSL.fromChunks $ payload
@@ -473,38 +567,49 @@ handleIncomingMessages node = go initConnectionState
473567 case decode (BSL.fromChunks payload) of
474568 ProcessIdentifier pid -> do
475569 let lpid = processLocalId pid
476− mProc <- withMVar state $ return . (^. localProcessWithId lpid)
570+ mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
477571 case mProc of
478572 Just proc ->
479573 go (incomingAt cid ^= Just (src, ToProc pid (processWeakQ proc)) $ st)
480574 Nothing ->
481− invalidRequest cid st
575+ -- incoming attempt to connect to unknown process - might
576+ -- be dead already
577+ go (incomingAt cid ^= Nothing $ st)
482578 SendPortIdentifier chId -> do
483579 let lcid = sendPortLocalId chId
484580 lpid = processLocalId (sendPortProcessId chId)
485− mProc <- withMVar state $ return . (^. localProcessWithId lpid)
581+ mProc <- withValidLocalState node $ return . (^. localProcessWithId lpid)
486582 case mProc of
487583 Just proc -> do
488584 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
489585 case mChannel of
490586 Just channel ->
491− go (incomingAt cid ^= Just (src, ToChan channel) $ st)
587+ go (incomingAt cid ^= Just (src, ToChan chId channel) $ st)
492588 Nothing ->
493− invalidRequest cid st
589+ invalidRequest cid st $
590+ "incoming attempt to connect to unknown channel of"
591+ ++ " process " ++ show (sendPortProcessId chId)
494592 Nothing ->
495− invalidRequest cid st
593+ -- incoming attempt to connect to channel of unknown
594+ -- process - might be dead already
595+ go (incomingAt cid ^= Nothing $ st)
496596 NodeIdentifier nid ->
497597 if nid == localNodeId node
498598 then go (incomingAt cid ^= Just (src, ToNode) $ st)
499− else invalidRequest cid st
599+ else invalidRequest cid st $
600+ "incoming attempt to connect to a different node -"
601+ ++ " I'm " ++ show (localNodeId node)
602+ ++ " but the remote peer wants to connect to "
603+ ++ show nid
500604 Nothing ->
501605 invalidRequest cid st
606+ "message received from an unknown connection"
502607 NT.ConnectionClosed cid ->
503608 case st ^. incomingAt cid of
504609 Nothing ->
505− invalidRequest cid st
610+ invalidRequest cid st "closed unknown connection"
506611 Just (src, _) -> do
507− trace node (TraceEvDisconnected cid)
612+ trace node (MxDisconnected cid src)
508613 go ( (incomingAt cid ^= Nothing)
509614 . (incomingFrom src ^: Set.delete cid)
510615 $ st
@@ -533,19 +638,20 @@ handleIncomingMessages node = go initConnectionState
533638 -- and we just give up
534639 fail "Cloud Haskell fatal error: received unexpected multicast"
535640
536− invalidRequest :: NT.ConnectionId -> ConnectionState -> IO ()
537− invalidRequest cid st = do
641+ invalidRequest :: NT.ConnectionId -> ConnectionState -> String -> IO ()
642+ invalidRequest cid st msg = do
538643 -- TODO: We should treat this as a fatal error on the part of the remote
539644 -- node. That is, we should report the remote node as having died, and we
540645 -- should close incoming connections (this requires a Transport layer
541646 -- extension).
542− traceEventFmtIO node "" [(TraceStr " [network] invalid request: "),
543− (Trace cid)]
647+ traceEventFmtIO node "" [ TraceStr $ " [network] invalid request"
648+ ++ " (" ++ msg ++ "): "
649+ , (Trace cid)
650+ ]
544651 go ( incomingAt cid ^= Nothing
545652 $ st
546653 )
547654
548− state = localState node
549655 endpoint = localEndPoint node
550656 ctrlChan = localCtrlChan node
551657
@@ -554,8 +660,9 @@ handleIncomingMessages node = go initConnectionState
554660--------------------------------------------------------------------------------
555661
556662runNodeController :: LocalNode -> IO ()
557−runNodeController =
558− runReaderT (evalStateT (unNC nodeController) initNCState)
663+runNodeController node =
664+ runReaderT (evalStateT (unNC nodeController) initNCState) node
665+ `Exception.catch` \(NodeClosedException _) -> return ()
559666
560667--------------------------------------------------------------------------------
561668-- Internal data types --
@@ -563,20 +670,26 @@ runNodeController =
563670
564671data NCState = NCState
565672 { -- Mapping from remote processes to linked local processes
566− _links :: !(Map Identifier (Set ProcessId))
673+ _links :: !(BiMultiMap Identifier ProcessId ())
567674 -- Mapping from remote processes to monitoring local processes
568− , _monitors :: !(Map Identifier (Set (ProcessId, MonitorRef)))
675+ , _monitors :: !(BiMultiMap Identifier ProcessId MonitorRef)
569676 -- Process registry: names and where they live, mapped to the PIDs
570677 , _registeredHere :: !(Map String ProcessId)
571678 , _registeredOnNodes :: !(Map ProcessId [(NodeId,Int)])
572679 }
573680
574681newtype NC a = NC { unNC :: StateT NCState (ReaderT LocalNode IO) a }
575− deriving (Functor, Monad, MonadIO, MonadState NCState, MonadReader LocalNode)
682+ deriving ( Applicative
683+ , Functor
684+ , Monad
685+ , MonadIO
686+ , MonadState NCState
687+ , MonadReader LocalNode
688+ )
576689
577690initNCState :: NCState
578−initNCState = NCState { _links = Map.empty
579− , _monitors = Map.empty
691+initNCState = NCState { _links = BiMultiMap.empty
692+ , _monitors = BiMultiMap.empty
580693 , _registeredHere = Map.empty
581694 , _registeredOnNodes = Map.empty
582695 }
@@ -592,19 +705,46 @@ instance Show ProcessKillException where
592705 show (ProcessKillException pid reason) =
593706 "killed-by=" ++ show pid ++ ",reason=" ++ reason
594707
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+
595735--------------------------------------------------------------------------------
596736-- Tracing/Debugging --
597737--------------------------------------------------------------------------------
598738
599−-- [Issue #104]
739+-- [Issue #104 / DP-13]
600740
601741traceNotifyDied :: LocalNode -> Identifier -> DiedReason -> NC ()
602742traceNotifyDied node ident reason =
603743 -- TODO: sendPortDied notifications
604744 liftIO $ withLocalTracer node $ \t ->
605745 case ident of
606− (NodeIdentifier nid) -> traceEvent t (TraceEvNodeDied nid reason)
607− (ProcessIdentifier pid) -> traceEvent t (TraceEvDied pid reason)
746+ (NodeIdentifier nid) -> traceEvent t (MxNodeDied nid reason)
747+ (ProcessIdentifier pid) -> traceEvent t (MxProcessDied pid reason)
608748 _ -> return ()
609749
610750traceEventFmtIO :: LocalNode
@@ -614,11 +754,11 @@ traceEventFmtIO :: LocalNode
614754traceEventFmtIO node fmt args =
615755 withLocalTracer node $ \t -> traceLogFmt t fmt args
616756
617−trace :: LocalNode -> TraceEvent -> IO ()
757+trace :: LocalNode -> MxEvent -> IO ()
618758trace node ev = withLocalTracer node $ \t -> traceEvent t ev
619759
620−withLocalTracer :: LocalNode -> (Tracer -> IO ()) -> IO ()
621−withLocalTracer node act = act (localTracer node)
760+withLocalTracer :: LocalNode -> (MxEventBus -> IO ()) -> IO ()
761+withLocalTracer node act = act (localEventBus node)
622762
623763--------------------------------------------------------------------------------
624764-- Core functionality --
@@ -634,11 +774,7 @@ nodeController = do
634774 -- [Unified: Table 7, rule nc_forward]
635775 case destNid (ctrlMsgSignal msg) of
636776 Just nid' | nid' /= localNodeId node ->
637− liftIO $ sendBinary node
638− (ctrlMsgSender msg)
639− (NodeIdentifier nid')
640− WithImplicitReconnect
641− msg
777+ ncSendToNode nid' msg
642778 _ ->
643779 return ()
644780
@@ -661,6 +797,8 @@ nodeController = do
661797 ncEffectWhereIs from label
662798 NCMsg _ (NamedSend label msg') ->
663799 ncEffectNamedSend label msg'
800+ NCMsg _ (UnreliableSend lpid msg') ->
801+ ncEffectLocalSend node (ProcessId (localNodeId node) lpid) msg'
664802 NCMsg _ (LocalSend to msg') ->
665803 ncEffectLocalSend node to msg'
666804 NCMsg _ (LocalPortSend to msg') ->
@@ -674,8 +812,9 @@ nodeController = do
674812 NCMsg _ SigShutdown ->
675813 liftIO $ do
676814 NT.closeEndPoint (localEndPoint node)
677− `Exception.finally` throwIO ThreadKilled
678− -- ThreadKilled seems to make more sense than fail/error here
815+ `Exception.finally` throwIO (NodeClosedException $ localNodeId node)
816+ NCMsg (ProcessIdentifier from) (GetNodeStats nid) ->
817+ ncEffectGetNodeStats from nid
679818 unexpected ->
680819 error $ "nodeController: unexpected message " ++ show unexpected
681820
@@ -693,22 +832,18 @@ ncEffectMonitor from them mRef = do
693832 case (shouldLink, isLocal node (ProcessIdentifier from)) of
694833 (True, _) -> -- [Unified: first rule]
695834 case mRef of
696− Just ref -> modify' $ monitorsFor them ^: Set.insert (from, ref)
697− Nothing -> modify' $ linksFor them ^: Set.insert from
835+ Just ref -> modify' $ monitors ^: BiMultiMap.insert them from ref
836+ Nothing -> modify' $ links ^: BiMultiMap.insert them from ()
698837 (False, True) -> -- [Unified: second rule]
699838 notifyDied from them DiedUnknownId mRef
700839 (False, False) -> -- [Unified: third rule]
701840 -- TODO: this is the right sender according to the Unified semantics,
702841 -- but perhaps having 'them' as the sender would make more sense
703842 -- (see also: notifyDied)
704− liftIO $ sendBinary node
705− (NodeIdentifier $ localNodeId node)
706− (NodeIdentifier $ processNodeId from)
707− WithImplicitReconnect
708− NCMsg
709− { ctrlMsgSender = NodeIdentifier (localNodeId node)
710− , ctrlMsgSignal = Died them DiedUnknownId
711− }
843+ ncSendToNode (processNodeId from) $ NCMsg
844+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
845+ , ctrlMsgSignal = Died them DiedUnknownId
846+ }
712847
713848-- [Unified: Table 11]
714849ncEffectUnlink :: ProcessId -> Identifier -> NC ()
@@ -722,7 +857,7 @@ ncEffectUnlink from them = do
722857 postAsMessage from $ DidUnlinkNode nid
723858 SendPortIdentifier cid ->
724859 postAsMessage from $ DidUnlinkPort cid
725− modify' $ linksFor them ^: Set.delete from
860+ modify' $ links ^: BiMultiMap.delete them from ()
726861
727862-- [Unified: Table 11]
728863ncEffectUnmonitor :: ProcessId -> MonitorRef -> NC ()
@@ -730,7 +865,7 @@ ncEffectUnmonitor from ref = do
730865 node <- ask
731866 when (isLocal node (ProcessIdentifier from)) $
732867 postAsMessage from $ DidUnmonitor ref
733− modify' $ monitorsFor (monitorRefIdent ref) ^: Set.delete (from, ref)
868+ modify' $ monitors ^: BiMultiMap.delete (monitorRefIdent ref) from ref
734869
735870-- [Unified: Table 12]
736871ncEffectDied :: Identifier -> DiedReason -> NC ()
@@ -745,7 +880,7 @@ ncEffectDied ident reason = do
745880 let localOnly = case ident of NodeIdentifier _ -> True ; _ -> False
746881
747882 forM_ (Map.toList affectedLinks) $ \(them, uss) ->
748− forM_ uss $ \us ->
883+ forM_ uss $ \(us, _) ->
749884 when (localOnly <= isLocal node (ProcessIdentifier us)) $
750885 notifyDied us them reason Nothing
751886
@@ -754,9 +889,35 @@ ncEffectDied ident reason = do
754889 when (localOnly <= isLocal node (ProcessIdentifier us)) $
755890 notifyDied us them reason (Just ref)
756891
757− modify' $ (links ^= unaffectedLinks) . (monitors ^= unaffectedMons)
758−
759− modify' $ registeredHere ^: Map.filter (\pid -> not $ ident `impliesDeathOf` ProcessIdentifier pid)
892+ -- Notify remote nodes that the process died so it can be removed from monitor
893+ -- lists.
894+ mapM_ (forwardDeath node) $
895+ [ nid | ProcessIdentifier pid <- [ident]
896+ , i <- Set.toList $ Set.union
897+ (Set.map fst $ BiMultiMap.lookupBy2nd pid unaffectedLinks)
898+ (Set.map fst $ BiMultiMap.lookupBy2nd pid unaffectedMons)
899+ , let nid = nodeOf i
900+ , nid /= localNodeId node
901+ ]
902+
903+ -- Delete monitors in the local node.
904+ let deleteDeads :: (Ord a, Ord v)
905+ => BiMultiMap a ProcessId v -> BiMultiMap a ProcessId v
906+ deleteDeads = case ident of
907+ -- deleteAllBy2nd is faster than partitionWithKeyBy2nd
908+ ProcessIdentifier pid -> BiMultiMap.deleteAllBy2nd pid
909+ _ -> snd . BiMultiMap.partitionWithKeyBy2nd
910+ (\pid _ -> ident `impliesDeathOf` ProcessIdentifier pid)
911+ unaffectedLinks' = deleteDeads unaffectedLinks
912+ unaffectedMons' = deleteDeads unaffectedMons
913+
914+ modify' $ (links ^= unaffectedLinks') . (monitors ^= unaffectedMons')
915+
916+ -- we now consider all labels for this identifier unregistered
917+ let toDrop pid = not $ ident `impliesDeathOf` ProcessIdentifier pid
918+ (keepNames, dropNames) <- Map.partition toDrop <$> gets (^. registeredHere)
919+ mapM_ (\(p, l) -> liftIO $ trace node (MxUnRegistered l p)) (Map.toList dropNames)
920+ modify' $ registeredHere ^= keepNames
760921
761922 remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
762923 mapM (\(pid,nidlist) ->
@@ -764,20 +925,15 @@ ncEffectDied ident reason = do
764925 True ->
765926 do forM_ nidlist $ \(nid,_) ->
766927 when (not $ isLocal node (NodeIdentifier nid))
767− (forwardNameDeath node nid)
928+ (forwardDeath node nid)
768929 return Nothing
769930 False -> return $ Just (pid,nidlist) )
770931 modify' $ registeredOnNodes ^= (Map.fromList (catMaybes remaining))
771932 where
772− forwardNameDeath node nid =
773− liftIO $ sendBinary node
774− (NodeIdentifier $ localNodeId node)
775− (NodeIdentifier $ nid)
776− WithImplicitReconnect
777− NCMsg
778− { ctrlMsgSender = NodeIdentifier (localNodeId node)
779− , ctrlMsgSignal = Died ident reason
780− }
933+ forwardDeath node nid = ncSendToNode nid
934+ NCMsg { ctrlMsgSender = NodeIdentifier (localNodeId node)
935+ , ctrlMsgSignal = Died ident reason
936+ }
781937
782938-- [Unified: Table 13]
783939ncEffectSpawn :: ProcessId -> Closure (Process ()) -> SpawnRef -> NC ()
@@ -785,17 +941,13 @@ ncEffectSpawn pid cProc ref = do
785941 mProc <- unClosure cProc
786942 -- If the closure does not exist, we spawn a process that throws an exception
787943 -- This allows the remote node to find out what's happening
788− -- TODO:
944+ -- TODO:
789945 let proc = case mProc of
790946 Left err -> fail $ "Error: Could not resolve closure: " ++ err
791947 Right p -> p
792948 node <- ask
793949 pid' <- liftIO $ forkProcess node proc
794− liftIO $ sendMessage node
795− (NodeIdentifier (localNodeId node))
796− (ProcessIdentifier pid)
797− WithImplicitReconnect
798− (DidSpawn ref pid')
950+ ncSendToProcess pid $ unsafeCreateUnencodedMessage $ DidSpawn ref pid'
799951
800952-- Unified semantics does not explicitly describe how to implement 'register',
801953-- but mentions it's "very similar to nsend" (Table 14)
@@ -813,17 +965,19 @@ ncEffectRegister from label atnode mPid reregistration = do
813965 return $ (isNothing currentVal /= reregistration) &&
814966 (not (isLocal node (ProcessIdentifier thepid) ) || isvalidlocal )
815967 if isLocal node (NodeIdentifier atnode)
816− then do when (isOk) $
968+ then do when isOk $
817969 do modify' $ registeredHereFor label ^= mPid
818970 updateRemote node currentVal mPid
819971 case mPid of
820− (Just p) -> liftIO $ trace node (TraceEvRegistered p label)
821− Nothing -> liftIO $ trace node (TraceEvUnRegistered (fromJust currentVal) label)
822− liftIO $ sendMessage node
823− (NodeIdentifier (localNodeId node))
824− (ProcessIdentifier from)
825− WithImplicitReconnect
826− (RegisterReply label isOk)
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)
977+ Nothing -> liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
978+ newVal <- gets (^. registeredHereFor label)
979+ ncSendToProcess from $ unsafeCreateUnencodedMessage $
980+ RegisterReply label isOk newVal
827981 else let operation =
828982 case reregistration of
829983 True -> flip decList
@@ -853,40 +1007,36 @@ ncEffectRegister from label atnode mPid reregistration = do
8531007 decList (x:xs) tag = x:decList xs tag
8541008 forward node to reg =
8551009 when (not $ isLocal node (NodeIdentifier to)) $
856− liftIO $ sendBinary node
857− (ProcessIdentifier from)
858− (NodeIdentifier to)
859− WithImplicitReconnect
860− NCMsg
861− { ctrlMsgSender = ProcessIdentifier from
862− , ctrlMsgSignal = reg
863− }
1010+ ncSendToNode to $ NCMsg { ctrlMsgSender = ProcessIdentifier from
1011+ , ctrlMsgSignal = reg
1012+ }
8641013
8651014
8661015-- Unified semantics does not explicitly describe 'whereis'
8671016ncEffectWhereIs :: ProcessId -> String -> NC ()
8681017ncEffectWhereIs from label = do
869− node <- ask
8701018 mPid <- gets (^. registeredHereFor label)
871− liftIO $ sendMessage node
872− (NodeIdentifier (localNodeId node))
873− (ProcessIdentifier from)
874− WithImplicitReconnect
875− (WhereIsReply label mPid)
1019+ ncSendToProcess from $ unsafeCreateUnencodedMessage $ WhereIsReply label mPid
8761020
8771021-- [Unified: Table 14]
8781022ncEffectNamedSend :: String -> Message -> NC ()
8791023ncEffectNamedSend label msg = do
8801024 mPid <- gets (^. registeredHereFor label)
8811025 -- If mPid is Nothing, we just ignore the named send (as per Table 14)
882− forM_ mPid $ \pid -> postMessage pid msg
1026+ forM_ mPid $ \to ->
1027+ -- If this is a trace message we don't trace it to avoid entering a loop
1028+ -- where trace messages produce more trace messages.
1029+ ncSendToProcessAndTrace (label /= "trace.logger") to msg
8831030
8841031-- [Issue #DP-20]
8851032ncEffectLocalSend :: LocalNode -> ProcessId -> Message -> NC ()
886−ncEffectLocalSend node to msg =
1033+ncEffectLocalSend = ncEffectLocalSendAndTrace True
1034+
1035+ncEffectLocalSendAndTrace :: Bool -> LocalNode -> ProcessId -> Message -> NC ()
1036+ncEffectLocalSendAndTrace shouldTrace node to msg =
8871037 liftIO $ withLocalProc node to $ \p -> do
8881038 enqueue (processQueue p) msg
889− trace node (TraceEvReceived to msg)
1039+ when shouldTrace $ trace node (MxReceived to msg)
8901040
8911041-- [Issue #DP-20]
8921042ncEffectLocalPortSend :: SendPortId -> Message -> NC ()
@@ -904,11 +1054,12 @@ ncEffectLocalPortSend from msg = do
9041054 -- If ch is Nothing, the process has given up the read end of
9051055 -- the channel and we simply ignore the incoming message - this
9061056 ch <- deRefWeak chan'
907− forM_ ch $ \chan -> deliverChan msg chan
908− where deliverChan :: forall a . Message -> TQueue a -> IO ()
909− deliverChan (UnencodedMessage _ raw) chan' =
1057+ forM_ ch $ \chan -> deliverChan node from msg chan
1058+ where deliverChan :: forall a . LocalNode -> SendPortId -> Message -> TQueue a -> IO ()
1059+ deliverChan n p (UnencodedMessage _ raw) chan' = do
9101060 atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
911− deliverChan (EncodedMessage _ _) _ =
1061+ trace n (MxReceivedPort p $ unsafeCreateUnencodedMessage raw)
1062+ deliverChan _ _ (EncodedMessage _ _) _ =
9121063 -- this will not happen unless someone screws with Primitives.hs
9131064 error "invalid local channel delivery"
9141065
@@ -933,46 +1084,56 @@ ncEffectGetInfo from pid =
9331084 them = (ProcessIdentifier pid)
9341085 in do
9351086 node <- ask
936− mProc <- liftIO $
937− withMVar (localState node) $ return . (^. localProcessWithId lpid)
1087+ mProc <- liftIO $ withValidLocalState node
1088+ $ return . (^. localProcessWithId lpid)
9381089 case mProc of
9391090 Nothing -> dispatch (isLocal node (ProcessIdentifier from))
940− from node (ProcessInfoNone DiedUnknownId)
941− Just _ -> do
942− itsLinks <- gets (^. linksFor them)
943− itsMons <- gets (^. monitorsFor them)
1091+ from (ProcessInfoNone DiedUnknownId)
1092+ Just proc -> do
1093+ itsLinks <- Set.map fst . BiMultiMap.lookupBy1st them <$>
1094+ gets (^. links)
1095+ itsMons <- BiMultiMap.lookupBy1st them <$> gets (^. monitors)
9441096 registered <- gets (^. registeredHere)
1097+ size <- liftIO $ queueSize $ processQueue $ proc
9451098
9461099 let reg = registeredNames registered
9471100 dispatch (isLocal node (ProcessIdentifier from))
9481101 from
949− node
9501102 ProcessInfo {
9511103 infoNode = (processNodeId pid)
9521104 , infoRegisteredNames = reg
953− -- we cannot populate this field
954− , infoMessageQueueLength = Nothing
955− , infoMonitors = Set.toList itsMons
956− , infoLinks = Set.toList itsLinks
1105+ , infoMessageQueueLength = size
1106+ , infoMonitors = Set.toList itsMons
1107+ , infoLinks = Set.toList itsLinks
9571108 }
958− where dispatch :: (Serializable a, Show a)
1109+ where dispatch :: (Serializable a)
9591110 => Bool
9601111 -> ProcessId
961− -> LocalNode
9621112 -> a
9631113 -> NC ()
964− dispatch True dest _ pInfo = postAsMessage dest $ pInfo
965− dispatch False dest node pInfo = do
966− liftIO $ sendMessage node
967− (NodeIdentifier (localNodeId node))
968− (ProcessIdentifier dest)
969− WithImplicitReconnect
970− pInfo
1114+ dispatch True dest pInfo = postAsMessage dest $ pInfo
1115+ dispatch False dest pInfo =
1116+ ncSendToProcess dest $ unsafeCreateUnencodedMessage pInfo
9711117
9721118 registeredNames = Map.foldlWithKey (\ks k v -> if v == pid
9731119 then (k:ks)
9741120 else ks) []
9751121
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+
9761137--------------------------------------------------------------------------------
9771138-- Auxiliary --
9781139--------------------------------------------------------------------------------
@@ -999,14 +1160,10 @@ notifyDied dest src reason mRef = do
9991160 throwException dest $ PortLinkException pid reason
10001161 (False, _, _) ->
10011162 -- The change in sender comes from [Unified: Table 10]
1002− liftIO $ sendBinary node
1003− (NodeIdentifier $ localNodeId node)
1004− (NodeIdentifier $ processNodeId dest)
1005− WithImplicitReconnect
1006− NCMsg
1007− { ctrlMsgSender = NodeIdentifier (localNodeId node)
1008− , ctrlMsgSignal = Died src reason
1009− }
1163+ ncSendToNode (processNodeId dest) $ NCMsg
1164+ { ctrlMsgSender = NodeIdentifier (localNodeId node)
1165+ , ctrlMsgSignal = Died src reason
1166+ }
10101167
10111168-- | [Unified: Table 8]
10121169destNid :: ProcessSignal -> Maybe NodeId
@@ -1018,6 +1175,7 @@ destNid (Spawn _ _) = Nothing
10181175destNid (Register _ _ _ _) = Nothing
10191176destNid (WhereIs _) = Nothing
10201177destNid (NamedSend _ _) = Nothing
1178+destNid (UnreliableSend _ _) = Nothing
10211179-- We don't need to forward 'Died' signals; if monitoring/linking is setup,
10221180-- then when a local process dies the monitoring/linking machinery will take
10231181-- care of notifying remote nodes
@@ -1025,6 +1183,7 @@ destNid (Died _ _) = Nothing
10251183destNid (Kill pid _) = Just $ processNodeId pid
10261184destNid (Exit pid _) = Just $ processNodeId pid
10271185destNid (GetInfo pid) = Just $ processNodeId pid
1186+destNid (GetNodeStats nid) = Just nid
10281187destNid (LocalSend pid _) = Just $ processNodeId pid
10291188destNid (LocalPortSend cid _) = Just $ processNodeId (sendPortProcessId cid)
10301189destNid (SigShutdown) = Nothing
@@ -1043,7 +1202,7 @@ unClosure closure = do
10431202isValidLocalIdentifier :: Identifier -> NC Bool
10441203isValidLocalIdentifier ident = do
10451204 node <- ask
1046− liftIO . withMVar (localState node) $ \nSt ->
1205+ liftIO . withValidLocalState node $ \nSt ->
10471206 case ident of
10481207 NodeIdentifier nid ->
10491208 return $ nid == localNodeId node
@@ -1074,6 +1233,9 @@ postMessage pid msg = do
10741233throwException :: Exception e => ProcessId -> e -> NC ()
10751234throwException pid e = do
10761235 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.
10771239 liftIO $ withLocalProc node pid $ \p -> throwTo (processThread p) e
10781240
10791241withLocalProc :: LocalNode -> ProcessId -> (LocalProcess -> IO ()) -> IO ()
@@ -1081,17 +1243,17 @@ withLocalProc node pid p =
10811243 -- By [Unified: table 6, rule missing_process] messages to dead processes
10821244 -- can silently be dropped
10831245 let lpid = processLocalId pid in do
1084− mProc <- withMVar (localState node) $ return . (^. localProcessWithId lpid)
1085− forM_ mProc p
1246+ join $ withValidLocalState node $ \vst ->
1247+ return $ forM_ (vst ^. localProcessWithId lpid) p
10861248
10871249--------------------------------------------------------------------------------
10881250-- Accessors --
10891251--------------------------------------------------------------------------------
10901252
1091−links :: Accessor NCState (Map Identifier (Set ProcessId))
1253+links :: Accessor NCState (BiMultiMap Identifier ProcessId ())
10921254links = accessor _links (\ls st -> st { _links = ls })
10931255
1094−monitors :: Accessor NCState (Map Identifier (Set (ProcessId, MonitorRef)))
1256+monitors :: Accessor NCState (BiMultiMap Identifier ProcessId MonitorRef)
10951257monitors = accessor _monitors (\ms st -> st { _monitors = ms })
10961258
10971259registeredHere :: Accessor NCState (Map String ProcessId)
@@ -1100,12 +1262,6 @@ registeredHere = accessor _registeredHere (\ry st -> st { _registeredHere = ry }
11001262registeredOnNodes :: Accessor NCState (Map ProcessId [(NodeId, Int)])
11011263registeredOnNodes = accessor _registeredOnNodes (\ry st -> st { _registeredOnNodes = ry })
11021264
1103−linksFor :: Identifier -> Accessor NCState (Set ProcessId)
1104−linksFor ident = links >>> DAC.mapDefault Set.empty ident
1105−
1106−monitorsFor :: Identifier -> Accessor NCState (Set (ProcessId, MonitorRef))
1107−monitorsFor ident = monitors >>> DAC.mapDefault Set.empty ident
1108−
11091265registeredHereFor :: String -> Accessor NCState (Maybe ProcessId)
11101266registeredHereFor ident = registeredHere >>> DAC.mapMaybe ident
11111267
@@ -1132,10 +1288,12 @@ registeredOnNodesFor ident = registeredOnNodes >>> DAC.mapMaybe ident
11321288-- * the notifications for typed channels to that process.
11331289--
11341290-- See https://github.com/haskell/containers/issues/14 for the bang on _v.
1135−splitNotif :: Identifier
1136− -> Map Identifier a
1137− -> (Map Identifier a, Map Identifier a)
1138−splitNotif ident = Map.partitionWithKey (\k !_v -> ident `impliesDeathOf` k)
1291+splitNotif :: (Ord a, Ord v)
1292+ => Identifier
1293+ -> BiMultiMap Identifier a v
1294+ -> (Map Identifier (Set (a,v)), BiMultiMap Identifier a v)
1295+splitNotif ident =
1296+ BiMultiMap.partitionWithKeyBy1st (\k !_v -> ident `impliesDeathOf` k)
11391297
11401298--------------------------------------------------------------------------------
11411299-- Auxiliary --
src/Control/Distributed/Process/Serializable.hs+18−8
@@ -1,3 +1,8 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE UndecidableInstances #-}
3+{-# LANGUAGE FlexibleInstances #-}
4+{-# LANGUAGE ScopedTypeVariables #-}
5+{-# LANGUAGE GADTs #-}
16module Control.Distributed.Process.Serializable
27 ( Serializable
38 , encodeFingerprint
@@ -7,28 +12,33 @@ module Control.Distributed.Process.Serializable
712 , Fingerprint
813 , showFingerprint
914 , SerializableDict(SerializableDict)
15+ , TypeableDict(TypeableDict)
1016 ) where
1117
1218import Data.Binary (Binary)
13−import Data.Typeable (Typeable(..))
14−import Data.Typeable.Internal (TypeRep(TypeRep))
19+
20+import Data.Typeable (Typeable, typeRepFingerprint, typeOf)
21+
1522import Numeric (showHex)
1623import Control.Exception (throw)
1724import GHC.Fingerprint.Type (Fingerprint(..))
1825import Data.ByteString (ByteString)
1926import qualified Data.ByteString as BS
20−import qualified Data.ByteString.Internal as BSI ( unsafeCreate
21− , inlinePerformIO
22− , toForeignPtr
23− )
27+import qualified Data.ByteString.Internal as BSI ( unsafeCreate, toForeignPtr )
2428import Foreign.Storable (pokeByteOff, peekByteOff, sizeOf)
2529import Foreign.ForeignPtr (withForeignPtr)
30+import System.IO.Unsafe (unsafePerformIO)
2631
2732-- | Reification of 'Serializable' (see "Control.Distributed.Process.Closure")
2833data SerializableDict a where
2934 SerializableDict :: Serializable a => SerializableDict a
3035 deriving (Typeable)
3136
37+-- | Reification of 'Typeable'.
38+data TypeableDict a where
39+ TypeableDict :: Typeable a => TypeableDict a
40+ deriving (Typeable)
41+
3242-- | Objects that can be sent across the network
3343class (Binary a, Typeable a) => Serializable a
3444instance (Binary a, Typeable a) => Serializable a
@@ -45,7 +55,7 @@ decodeFingerprint :: ByteString -> Fingerprint
4555decodeFingerprint bs
4656 | BS.length bs /= sizeOfFingerprint =
4757 throw $ userError "decodeFingerprint: Invalid length"
48− | otherwise = BSI.inlinePerformIO $ do
58+ | otherwise = unsafePerformIO $ do
4959 let (fp, offset, _) = BSI.toForeignPtr bs
5060 withForeignPtr fp $ \p -> peekByteOff p offset
5161
@@ -55,7 +65,7 @@ sizeOfFingerprint = sizeOf (undefined :: Fingerprint)
5565
5666-- | The fingerprint of the typeRep of the argument
5767fingerprint :: Typeable a => a -> Fingerprint
58−fingerprint a = let TypeRep fp _ _ = typeOf a in fp
68+fingerprint = typeRepFingerprint . typeOf
5969
6070-- | Show fingerprint (for debugging purposes)
6171showFingerprint :: Fingerprint -> ShowS
src/Control/Distributed/Process/UnsafePrimitives.hsnew file+200
@@ -0,0 +1,200 @@
1+-----------------------------------------------------------------------------
2+-- |
3+-- Module : Control.Distributed.Process.UnsafePrimitives
4+-- Copyright : (c) Well-Typed / Tim Watson
5+-- License : BSD3 (see the file LICENSE)
6+--
7+-- Maintainer : Tim Watson <watson.timothy@gmail.com>
8+-- Stability : experimental
9+-- Portability : non-portable (requires concurrency)
10+--
11+-- [Unsafe Variants of Cloud Haskell's Messaging Primitives]
12+--
13+-- Cloud Haskell's semantics do not mention evaluation/strictness properties
14+-- at all; Only the promise (or lack) of signal/message delivery between
15+-- processes is considered. For practical purposes, Cloud Haskell optimises
16+-- communication between (intra-node) local processes by skipping the
17+-- network-transport layer. In order to ensure the same strictness semantics
18+-- however, messages /still/ undergo binary serialisation before (internal)
19+-- transmission takes place. Thus we ensure that in both (the local and remote)
20+-- cases, message payloads are fully evaluated. Whilst this provides the user
21+-- with /unsurprising/ behaviour, the resulting performance overhead is quite
22+-- severe. Communicating data between Haskell threads /without/ forcing binary
23+-- serialisation reduces (intra-node, inter-process) communication overheads
24+-- by several orders of magnitude.
25+--
26+-- This module provides variants of Cloud Haskell's messaging primitives
27+-- ('send', 'sendChan', 'nsend' and 'wrapMessage') which do /not/ force binary
28+-- serialisation in the local case, thereby offering superior intra-node
29+-- messaging performance. The /catch/ is that any evaluation problems lurking
30+-- within the passed data structure (e.g., fields set to @undefined@ and so on)
31+-- will show up in the receiver rather than in the caller (as they would with
32+-- the /normal/ strategy).
33+--
34+-- Use of the functions in this module can potentially change the runtime
35+-- behaviour of your application. In addition, messages passed between Cloud
36+-- Haskell processes are written to a tracing infrastructure on the local node,
37+-- to provide improved introspection and debugging facilities for complex actor
38+-- based systems. This module makes no attempt to force evaluation in these
39+-- cases either, thus evaluation problems in passed data structures could not
40+-- only crash your processes, but could also bring down critical internal
41+-- services on which the node relies to function correctly.
42+--
43+-- If you wish to repudiate such issues, you are advised to consider the use
44+-- of NFSerialisable in the distributed-process-extras package, which type
45+-- class brings NFData into scope along with Serializable, such that we can
46+-- force evaluation. Intended for use with modules such as this one, this
47+-- approach guarantees correct evaluatedness in terms of @NFData@. Please note
48+-- however, that we /cannot/ guarantee that an @NFData@ instance will behave the
49+-- same way as a @Binary@ one with regards evaluation, so it is still possible
50+-- to introduce unexpected behaviour by using /unsafe/ primitives in this way.
51+--
52+-- You have been warned!
53+--
54+-- 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
56+-- take advantage of qualified imports, however "Control.Distributed.Process"
57+-- also re-exports these functions under different names, using the @unsafe@
58+-- prefix.
59+--
60+module Control.Distributed.Process.UnsafePrimitives
61+ ( -- * Unsafe Basic Messaging
62+ send
63+ , sendChan
64+ , nsend
65+ , nsendRemote
66+ , usend
67+ , wrapMessage
68+ ) where
69+
70+import Control.Distributed.Process.Internal.Messaging
71+ ( sendMessage
72+ , sendBinary
73+ , sendCtrlMsg
74+ )
75+import Control.Distributed.Process.Management.Internal.Types
76+ ( MxEvent(..)
77+ )
78+import Control.Distributed.Process.Management.Internal.Trace.Types
79+ ( traceEvent
80+ )
81+import Control.Distributed.Process.Internal.Types
82+ ( ProcessId(..)
83+ , NodeId(..)
84+ , LocalNode(..)
85+ , LocalProcess(..)
86+ , Process(..)
87+ , SendPort(..)
88+ , ProcessSignal(..)
89+ , Identifier(..)
90+ , ImplicitReconnect(..)
91+ , SendPortId(..)
92+ , Message
93+ , createMessage
94+ , sendPortProcessId
95+ , unsafeCreateUnencodedMessage
96+ )
97+import Control.Distributed.Process.Serializable (Serializable)
98+
99+import Control.Monad.IO.Class (liftIO)
100+import Control.Monad.Reader (ask)
101+
102+-- | Named send to a process in the local registry (asynchronous)
103+nsend :: Serializable a => String -> a -> Process ()
104+nsend label msg = do
105+ proc <- ask
106+ let us = processId proc
107+ let msg' = wrapMessage msg
108+ -- see [note: tracing]
109+ liftIO $ traceEvent (localEventBus (processNode proc))
110+ (MxSentToName label us msg')
111+ sendCtrlMsg Nothing (NamedSend label msg')
112+
113+-- | Named send to a process in a remote registry (asynchronous)
114+nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
115+nsendRemote nid label msg = do
116+ proc <- ask
117+ let us = processId proc
118+ let node = processNode proc
119+ if localNodeId node == nid
120+ then nsend label msg
121+ else
122+ let lbl = label ++ "@" ++ show nid in do
123+ -- see [note: tracing] NB: this is a remote call to another NC...
124+ liftIO $ traceEvent (localEventBus node)
125+ (MxSentToName lbl us (wrapMessage msg))
126+ sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
127+
128+-- | Send a message
129+send :: Serializable a => ProcessId -> a -> Process ()
130+send them msg = do
131+ proc <- ask
132+ let node = localNodeId (processNode proc)
133+ destNode = (processNodeId them)
134+ us = (processId proc)
135+ msg' = wrapMessage msg in do
136+ -- see [note: tracing]
137+ liftIO $ traceEvent (localEventBus (processNode proc))
138+ (MxSent them us msg')
139+ if destNode == node
140+ then sendCtrlMsg Nothing $ LocalSend them msg'
141+ else liftIO $ sendMessage (processNode proc)
142+ (ProcessIdentifier (processId proc))
143+ (ProcessIdentifier them)
144+ NoImplicitReconnect
145+ msg
146+
147+-- | Send a message unreliably.
148+--
149+-- Unlike 'send', this function is insensitive to 'reconnect'. It will
150+-- try to send the message regardless of the history of connection failures
151+-- between the nodes.
152+--
153+-- Message passing with 'usend' is ordered for a given sender and receiver
154+-- if the messages arrive at all.
155+--
156+usend :: Serializable a => ProcessId -> a -> Process ()
157+usend them msg = do
158+ proc <- ask
159+ let there = processNodeId them
160+ let (us, node) = (processId proc, processNode proc)
161+ let msg' = wrapMessage msg
162+ -- see [note: tracing]
163+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg')
164+ if localNodeId (processNode proc) == there
165+ then sendCtrlMsg Nothing $ LocalSend them msg'
166+ else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
167+ (createMessage msg)
168+
169+-- [note: tracing]
170+-- Note that tracing writes to the local node's control channel, and this
171+-- module explicitly specifies to its clients that it does unsafe message
172+-- encoding. The same is true for the messages it puts onto the Management
173+-- event bus, however we do *not* want unevaluated thunks hitting the event
174+-- bus control thread. Hence the word /Unsafe/ in this module's name!
175+--
176+
177+-- | Send a message on a typed channel
178+sendChan :: Serializable a => SendPort a -> a -> Process ()
179+sendChan (SendPort cid) msg = do
180+ proc <- ask
181+ let node = processNode proc
182+ pid = processId proc
183+ us = localNodeId node
184+ them = processNodeId (sendPortProcessId cid)
185+ msg' = wrapMessage msg in do
186+ liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid msg')
187+ if them == us
188+ then unsafeSendChanLocal cid msg' -- NB: we wrap to P.Message !!!
189+ else liftIO $ sendBinary node
190+ (ProcessIdentifier pid)
191+ (SendPortIdentifier cid)
192+ NoImplicitReconnect
193+ msg
194+ where
195+ unsafeSendChanLocal :: SendPortId -> Message -> Process ()
196+ unsafeSendChanLocal p m = sendCtrlMsg Nothing $ LocalPortSend p m
197+
198+-- | Create an unencoded @Message@ for any @Serializable@ type.
199+wrapMessage :: Serializable a => a -> Message
200+wrapMessage = unsafeCreateUnencodedMessage
stack-ghc-7.10.3.yamlnew file+21
@@ -0,0 +1,21 @@
1+resolver: nightly-2016-03-08
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
10+
11+extra-deps:
12+- rank1dynamic-0.4.0
13+- distributed-static-0.3.8
14+- network-transport-0.5.2
15+- network-transport-inmemory-0.5.2
16+- rematch-0.2.0.0
17+- exceptions-0.8.2.1 # test dependency
18+
19+flags:
20+ distributed-process-tests:
21+ tcp: true
stack-ghc-8.0.2.yamlnew file+23
@@ -0,0 +1,23 @@
1+resolver: lts-9.21
2+# added -location for network-transport-tcp-0.6.0
3+# since c7fd79 broke the client facing API for createTransport :/
4+
5+packages:
6+- '.'
7+- distributed-process-tests/
8+- location:
9+ git: https://github.com/haskell-distributed/network-transport-tcp.git
10+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
11+ extra-dep: true
12+
13+extra-deps:
14+- rank1dynamic-0.4.0
15+- distributed-static-0.3.8
16+- network-transport-0.5.2
17+- network-transport-inmemory-0.5.2
18+- rematch-0.2.0.0
19+# - exceptions-0.8.2.1 # test dependency
20+
21+flags:
22+ distributed-process-tests:
23+ tcp: true
stack-ghc-8.2.2.yamlnew file+21
@@ -0,0 +1,21 @@
1+resolver: lts-11.22
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
10+
11+extra-deps:
12+- rank1dynamic-0.4.0
13+- distributed-static-0.3.8
14+- network-transport-0.5.2
15+- network-transport-inmemory-0.5.2
16+- rematch-0.2.0.0
17+# - exceptions-0.8.2.1 # test dependency
18+
19+flags:
20+ distributed-process-tests:
21+ tcp: true
stack-ghc-8.4.4.yamlnew file+20
@@ -0,0 +1,20 @@
1+resolver: lts-12.18
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
10+
11+extra-deps:
12+- rank1dynamic-0.4.0
13+- distributed-static-0.3.8
14+- network-transport-0.5.2
15+- network-transport-inmemory-0.5.2
16+- rematch-0.2.0.0
17+
18+flags:
19+ distributed-process-tests:
20+ tcp: true
stack-nightly.yamlnew file+26
@@ -0,0 +1,26 @@
1+resolver: nightly
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/distributed-static.git
8+ commit: c51e6aadd3a44c044e96a8e986c11d3a94b45b11
9+ extra-dep: true
10+- location:
11+ git: https://github.com/haskell-distributed/network-transport-tcp.git
12+ commit: d58250e2388b86a1865ac4139373cbdc106e72e1
13+ extra-dep: true
14+- location:
15+ git: https://github.com/haskell-distributed/network-transport-inmemory.git
16+ commit: 0ce97924f15a8c1570b2355151834305c9bd2a28
17+ extra-dep: true
18+
19+extra-deps:
20+- rank1dynamic-0.4.0
21+- network-transport-0.5.2
22+- rematch-0.2.0.0
23+
24+flags:
25+ distributed-process-tests:
26+ tcp: true
stack.yamlnew file+22
@@ -0,0 +1,22 @@
1+resolver: lts-12.18 # Use GHC 8.4.4
2+
3+# TODO: we can enable nightly-2018-11-11 once PR #319 is merged
4+
5+packages:
6+- '.'
7+- distributed-process-tests/
8+- location:
9+ git: https://github.com/haskell-distributed/network-transport-tcp.git
10+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
11+ extra-dep: true
12+
13+extra-deps:
14+- rank1dynamic-0.4.0
15+- distributed-static-0.3.8
16+- network-transport-0.5.2
17+- network-transport-inmemory-0.5.2
18+- rematch-0.2.0.0
19+
20+flags:
21+ distributed-process-tests:
22+ tcp: true
tests/TestCH.hsdeleted−1236
@@ -1,1236 +0,0 @@
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)
40−import Test.Framework (Test, defaultMain, testGroup)
41−import Test.Framework.Providers.HUnit (testCase)
42−import Control.Rematch hiding (expect, match)
43−import qualified Control.Rematch as Rematch (expect)
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−-- | Like fork, but throw exceptions in the child thread to the parent
56−forkTry :: IO () -> IO ThreadId
57−forkTry p = do
58− tid <- myThreadId
59− forkIO $ Ex.catch p (\e -> throwTo tid (e :: SomeException))
60−
61−-- | The ping server from the paper
62−ping :: Process ()
63−ping = do
64− Pong partner <- expect
65− self <- getSelfPid
66− send partner (Ping self)
67− ping
68−
69−-- | Quick and dirty synchronous version of whereisRemoteAsync
70−whereisRemote :: NodeId -> String -> Process (Maybe ProcessId)
71−whereisRemote nid string = do
72− whereisRemoteAsync nid string
73− WhereIsReply _ mPid <- expect
74− return mPid
75−
76−data Add = Add ProcessId Double Double deriving (Typeable)
77−data Divide = Divide ProcessId Double Double deriving (Typeable)
78−data DivByZero = DivByZero deriving (Typeable)
79−
80−instance Binary Add where
81− put (Add pid x y) = put pid >> put x >> put y
82− get = Add <$> get <*> get <*> get
83−
84−instance Binary Divide where
85− put (Divide pid x y) = put pid >> put x >> put y
86− get = Divide <$> get <*> get <*> get
87−
88−instance Binary DivByZero where
89− put DivByZero = return ()
90− get = return DivByZero
91−
92−-- The math server from the paper
93−math :: Process ()
94−math = do
95− receiveWait
96− [ match (\(Add pid x y) -> send pid (x + y))
97− , matchIf (\(Divide _ _ y) -> y /= 0)
98− (\(Divide pid x y) -> send pid (x / y))
99− , match (\(Divide pid _ _) -> send pid DivByZero)
100− ]
101− math
102−
103−-- | Monitor or link to a remote node
104−monitorOrLink :: Bool -- ^ 'True' for monitor, 'False' for link
105− -> ProcessId -- Process to monitor/link to
106− -> Maybe (MVar ()) -- MVar to signal on once the monitor has been set up
107− -> Process (Maybe MonitorRef)
108−monitorOrLink mOrL pid mSignal = do
109− result <- if mOrL then Just <$> monitor pid
110− else link pid >> return Nothing
111− -- Monitor is asynchronous, which usually does not matter but if we want a
112− -- *specific* signal then it does. Therefore we wait an arbitrary delay and
113− -- hope that this means the monitor has been set up
114− forM_ mSignal $ \signal -> liftIO . forkIO $ threadDelay 100000 >> putMVar signal ()
115− return result
116−
117−monitorTestProcess :: ProcessId -- Process to monitor/link to
118− -> Bool -- 'True' for monitor, 'False' for link
119− -> Bool -- Should we unmonitor?
120− -> DiedReason -- Expected cause of death
121− -> Maybe (MVar ()) -- Signal for 'monitor set up'
122− -> MVar () -- Signal for successful termination
123− -> Process ()
124−monitorTestProcess theirAddr mOrL un reason monitorSetup done =
125− catch (do mRef <- monitorOrLink mOrL theirAddr monitorSetup
126− case (un, mRef) of
127− (True, Nothing) -> do
128− unlink theirAddr
129− liftIO $ putMVar done ()
130− (True, Just ref) -> do
131− unmonitor ref
132− liftIO $ putMVar done ()
133− (False, ref) -> do
134− ProcessMonitorNotification ref' pid reason' <- expect
135− True <- return $ Just ref' == ref && pid == theirAddr && mOrL && reason == reason'
136− liftIO $ putMVar done ()
137− )
138− (\(ProcessLinkException pid reason') -> do
139− True <- return $ pid == theirAddr && not mOrL && not un && reason == reason'
140− liftIO $ putMVar done ()
141− )
142−
143−--------------------------------------------------------------------------------
144−-- The tests proper --
145−--------------------------------------------------------------------------------
146−
147−-- | Basic ping test
148−testPing :: NT.Transport -> Assertion
149−testPing transport = do
150− serverAddr <- newEmptyMVar
151− clientDone <- newEmptyMVar
152−
153− -- Server
154− forkIO $ do
155− localNode <- newLocalNode transport initRemoteTable
156− addr <- forkProcess localNode ping
157− putMVar serverAddr addr
158−
159− -- Client
160− forkIO $ do
161− localNode <- newLocalNode transport initRemoteTable
162− pingServer <- readMVar serverAddr
163−
164− let numPings = 10000
165−
166− runProcess localNode $ do
167− pid <- getSelfPid
168− replicateM_ numPings $ do
169− send pingServer (Pong pid)
170− Ping _ <- expect
171− return ()
172−
173− putMVar clientDone ()
174−
175− takeMVar clientDone
176−
177−-- | Monitor a process on an unreachable node
178−testMonitorUnreachable :: NT.Transport -> Bool -> Bool -> Assertion
179−testMonitorUnreachable transport mOrL un = do
180− deadProcess <- newEmptyMVar
181− done <- newEmptyMVar
182−
183− forkIO $ do
184− localNode <- newLocalNode transport initRemoteTable
185− addr <- forkProcess localNode . liftIO $ threadDelay 1000000
186− closeLocalNode localNode
187− putMVar deadProcess addr
188−
189− forkIO $ do
190− localNode <- newLocalNode transport initRemoteTable
191− theirAddr <- readMVar deadProcess
192− runProcess localNode $
193− monitorTestProcess theirAddr mOrL un DiedDisconnect Nothing done
194−
195− takeMVar done
196−
197−-- | Monitor a process which terminates normally
198−testMonitorNormalTermination :: NT.Transport -> Bool -> Bool -> Assertion
199−testMonitorNormalTermination transport mOrL un = do
200− monitorSetup <- newEmptyMVar
201− monitoredProcess <- newEmptyMVar
202− done <- newEmptyMVar
203−
204− forkIO $ do
205− localNode <- newLocalNode transport initRemoteTable
206− addr <- forkProcess localNode $
207− liftIO $ readMVar monitorSetup
208− putMVar monitoredProcess addr
209−
210− forkIO $ do
211− localNode <- newLocalNode transport initRemoteTable
212− theirAddr <- readMVar monitoredProcess
213− runProcess localNode $
214− monitorTestProcess theirAddr mOrL un DiedNormal (Just monitorSetup) done
215−
216− takeMVar done
217−
218−-- | Monitor a process which terminates abnormally
219−testMonitorAbnormalTermination :: NT.Transport -> Bool -> Bool -> Assertion
220−testMonitorAbnormalTermination transport mOrL un = do
221− monitorSetup <- newEmptyMVar
222− monitoredProcess <- newEmptyMVar
223− done <- newEmptyMVar
224−
225− let err = userError "Abnormal termination"
226−
227− forkIO $ do
228− localNode <- newLocalNode transport initRemoteTable
229− addr <- forkProcess localNode . liftIO $ do
230− readMVar monitorSetup
231− throwIO err
232− putMVar monitoredProcess addr
233−
234− forkIO $ do
235− localNode <- newLocalNode transport initRemoteTable
236− theirAddr <- readMVar monitoredProcess
237− runProcess localNode $
238− monitorTestProcess theirAddr mOrL un (DiedException (show err)) (Just monitorSetup) done
239−
240− takeMVar done
241−
242−-- | Monitor a local process that is already dead
243−testMonitorLocalDeadProcess :: NT.Transport -> Bool -> Bool -> Assertion
244−testMonitorLocalDeadProcess transport mOrL un = do
245− processDead <- newEmptyMVar
246− processAddr <- newEmptyMVar
247− localNode <- newLocalNode transport initRemoteTable
248− done <- newEmptyMVar
249−
250− forkIO $ do
251− addr <- forkProcess localNode . liftIO $ putMVar processDead ()
252− putMVar processAddr addr
253−
254− forkIO $ do
255− theirAddr <- readMVar processAddr
256− readMVar processDead
257− runProcess localNode $ do
258− monitorTestProcess theirAddr mOrL un DiedUnknownId Nothing done
259−
260− takeMVar done
261−
262−-- | Monitor a remote process that is already dead
263−testMonitorRemoteDeadProcess :: NT.Transport -> Bool -> Bool -> Assertion
264−testMonitorRemoteDeadProcess transport mOrL un = do
265− processDead <- newEmptyMVar
266− processAddr <- newEmptyMVar
267− done <- newEmptyMVar
268−
269− forkIO $ do
270− localNode <- newLocalNode transport initRemoteTable
271− addr <- forkProcess localNode . liftIO $ putMVar processDead ()
272− putMVar processAddr addr
273−
274− forkIO $ do
275− localNode <- newLocalNode transport initRemoteTable
276− theirAddr <- readMVar processAddr
277− readMVar processDead
278− runProcess localNode $ do
279− monitorTestProcess theirAddr mOrL un DiedUnknownId Nothing done
280−
281− takeMVar done
282−
283−-- | Monitor a process that becomes disconnected
284−testMonitorDisconnect :: NT.Transport -> Bool -> Bool -> Assertion
285−testMonitorDisconnect transport mOrL un = do
286− processAddr <- newEmptyMVar
287− monitorSetup <- newEmptyMVar
288− done <- newEmptyMVar
289−
290− forkIO $ do
291− localNode <- newLocalNode transport initRemoteTable
292− addr <- forkProcess localNode . liftIO $ threadDelay 1000000
293− putMVar processAddr addr
294− readMVar monitorSetup
295− NT.closeEndPoint (localEndPoint localNode)
296−
297− forkIO $ do
298− localNode <- newLocalNode transport initRemoteTable
299− theirAddr <- readMVar processAddr
300− runProcess localNode $ do
301− monitorTestProcess theirAddr mOrL un DiedDisconnect (Just monitorSetup) done
302−
303− takeMVar done
304−
305−-- | Test the math server (i.e., receiveWait)
306−testMath :: NT.Transport -> Assertion
307−testMath transport = do
308− serverAddr <- newEmptyMVar
309− clientDone <- newEmptyMVar
310−
311− -- Server
312− forkIO $ do
313− localNode <- newLocalNode transport initRemoteTable
314− addr <- forkProcess localNode math
315− putMVar serverAddr addr
316−
317− -- Client
318− forkIO $ do
319− localNode <- newLocalNode transport initRemoteTable
320− mathServer <- readMVar serverAddr
321−
322− runProcess localNode $ do
323− pid <- getSelfPid
324− send mathServer (Add pid 1 2)
325− 3 <- expect :: Process Double
326− send mathServer (Divide pid 8 2)
327− 4 <- expect :: Process Double
328− send mathServer (Divide pid 8 0)
329− DivByZero <- expect
330− liftIO $ putMVar clientDone ()
331−
332− takeMVar clientDone
333−
334−-- | Send first message (i.e. connect) to an already terminated process
335−-- (without monitoring); then send another message to a second process on
336−-- the same remote node (we're checking that the remote node did not die)
337−testSendToTerminated :: NT.Transport -> Assertion
338−testSendToTerminated transport = do
339− serverAddr1 <- newEmptyMVar
340− serverAddr2 <- newEmptyMVar
341− clientDone <- newEmptyMVar
342−
343− forkIO $ do
344− terminated <- newEmptyMVar
345− localNode <- newLocalNode transport initRemoteTable
346− addr1 <- forkProcess localNode $ liftIO $ putMVar terminated ()
347− addr2 <- forkProcess localNode $ ping
348− readMVar terminated
349− putMVar serverAddr1 addr1
350− putMVar serverAddr2 addr2
351−
352− forkIO $ do
353− localNode <- newLocalNode transport initRemoteTable
354− server1 <- readMVar serverAddr1
355− server2 <- readMVar serverAddr2
356− runProcess localNode $ do
357− pid <- getSelfPid
358− send server1 "Hi"
359− send server2 (Pong pid)
360− Ping pid' <- expect
361− True <- return $ pid' == server2
362− liftIO $ putMVar clientDone ()
363−
364− takeMVar clientDone
365−
366−-- | Test (non-zero) timeout
367−testTimeout :: NT.Transport -> Assertion
368−testTimeout transport = do
369− localNode <- newLocalNode transport initRemoteTable
370− done <- newEmptyMVar
371−
372− runProcess localNode $ do
373− Nothing <- receiveTimeout 1000000 [match (\(Add _ _ _) -> return ())]
374− liftIO $ putMVar done ()
375−
376− takeMVar done
377−
378−-- | Test zero timeout
379−testTimeout0 :: NT.Transport -> Assertion
380−testTimeout0 transport = do
381− serverAddr <- newEmptyMVar
382− clientDone <- newEmptyMVar
383− messagesSent <- newEmptyMVar
384−
385− forkIO $ do
386− localNode <- newLocalNode transport initRemoteTable
387− addr <- forkProcess localNode $ do
388− liftIO $ readMVar messagesSent >> threadDelay 1000000
389− -- Variation on the venerable ping server which uses a zero timeout
390− -- Since we wait for all messages to be sent before doing this receive,
391− -- we should nevertheless find the right message immediately
392− Just partner <- receiveTimeout 0 [match (\(Pong partner) -> return partner)]
393− self <- getSelfPid
394− send partner (Ping self)
395− putMVar serverAddr addr
396−
397− forkIO $ do
398− localNode <- newLocalNode transport initRemoteTable
399− server <- readMVar serverAddr
400− runProcess localNode $ do
401− pid <- getSelfPid
402− -- Send a bunch of messages. A large number of messages that the server
403− -- is not interested in, and then a single message that it wants
404− replicateM_ 10000 $ send server "Irrelevant message"
405− send server (Pong pid)
406− liftIO $ putMVar messagesSent ()
407− Ping _ <- expect
408− liftIO $ putMVar clientDone ()
409−
410− takeMVar clientDone
411−
412−-- | Test typed channels
413−testTypedChannels :: NT.Transport -> Assertion
414−testTypedChannels transport = do
415− serverChannel <- newEmptyMVar :: IO (MVar (SendPort (SendPort Bool, Int)))
416− clientDone <- newEmptyMVar
417−
418− forkIO $ do
419− localNode <- newLocalNode transport initRemoteTable
420− forkProcess localNode $ do
421− (serverSendPort, rport) <- newChan
422− liftIO $ putMVar serverChannel serverSendPort
423− (clientSendPort, i) <- receiveChan rport
424− sendChan clientSendPort (even i)
425− return ()
426−
427− forkIO $ do
428− localNode <- newLocalNode transport initRemoteTable
429− serverSendPort <- readMVar serverChannel
430− runProcess localNode $ do
431− (clientSendPort, rport) <- newChan
432− sendChan serverSendPort (clientSendPort, 5)
433− False <- receiveChan rport
434− liftIO $ putMVar clientDone ()
435−
436− takeMVar clientDone
437−
438−-- | Test merging receive ports
439−testMergeChannels :: NT.Transport -> Assertion
440−testMergeChannels transport = do
441− localNode <- newLocalNode transport initRemoteTable
442− testFlat localNode True "aaabbbccc"
443− testFlat localNode False "abcabcabc"
444− testNested localNode True True "aaabbbcccdddeeefffggghhhiii"
445− testNested localNode True False "adgadgadgbehbehbehcficficfi"
446− testNested localNode False True "abcabcabcdefdefdefghighighi"
447− testNested localNode False False "adgbehcfiadgbehcfiadgbehcfi"
448− testBlocked localNode True
449− testBlocked localNode False
450− where
451− -- Single layer of merging
452− testFlat :: LocalNode -> Bool -> String -> IO ()
453− testFlat localNode biased expected = do
454− done <- newEmptyMVar
455− forkProcess localNode $ do
456− rs <- mapM charChannel "abc"
457− m <- mergePorts biased rs
458− xs <- replicateM 9 $ receiveChan m
459− True <- return $ xs == expected
460− liftIO $ putMVar done ()
461− takeMVar done
462−
463− -- Two layers of merging
464− testNested :: LocalNode -> Bool -> Bool -> String -> IO ()
465− testNested localNode biasedInner biasedOuter expected = do
466− done <- newEmptyMVar
467− forkProcess localNode $ do
468− rss <- mapM (mapM charChannel) ["abc", "def", "ghi"]
469− ms <- mapM (mergePorts biasedInner) rss
470− m <- mergePorts biasedOuter ms
471− xs <- replicateM (9 * 3) $ receiveChan m
472− True <- return $ xs == expected
473− liftIO $ putMVar done ()
474− takeMVar done
475−
476− -- Test that if no messages are (immediately) available, the scheduler makes no difference
477− testBlocked :: LocalNode -> Bool -> IO ()
478− testBlocked localNode biased = do
479− vs <- replicateM 3 newEmptyMVar
480− done <- newEmptyMVar
481−
482− forkProcess localNode $ do
483− [sa, sb, sc] <- liftIO $ mapM readMVar vs
484− mapM_ ((>> liftIO (threadDelay 10000)) . uncurry sendChan)
485− [ -- a, b, c
486− (sa, 'a')
487− , (sb, 'b')
488− , (sc, 'c')
489− -- a, c, b
490− , (sa, 'a')
491− , (sc, 'c')
492− , (sb, 'b')
493− -- b, a, c
494− , (sb, 'b')
495− , (sa, 'a')
496− , (sc, 'c')
497− -- b, c, a
498− , (sb, 'b')
499− , (sc, 'c')
500− , (sa, 'a')
501− -- c, a, b
502− , (sc, 'c')
503− , (sa, 'a')
504− , (sb, 'b')
505− -- c, b, a
506− , (sc, 'c')
507− , (sb, 'b')
508− , (sa, 'a')
509− ]
510−
511− forkProcess localNode $ do
512− (ss, rs) <- unzip <$> replicateM 3 newChan
513− liftIO $ mapM_ (uncurry putMVar) $ zip vs ss
514− m <- mergePorts biased rs
515− xs <- replicateM (6 * 3) $ receiveChan m
516− True <- return $ xs == "abcacbbacbcacabcba"
517− liftIO $ putMVar done ()
518−
519− takeMVar done
520−
521− mergePorts :: Serializable a => Bool -> [ReceivePort a] -> Process (ReceivePort a)
522− mergePorts True = mergePortsBiased
523− mergePorts False = mergePortsRR
524−
525− charChannel :: Char -> Process (ReceivePort Char)
526− charChannel c = do
527− (sport, rport) <- newChan
528− replicateM_ 3 $ sendChan sport c
529− liftIO $ threadDelay 10000 -- Make sure messages have been sent
530− return rport
531−
532−testTerminate :: NT.Transport -> Assertion
533−testTerminate transport = do
534− localNode <- newLocalNode transport initRemoteTable
535− done <- newEmptyMVar
536−
537− pid <- forkProcess localNode $ do
538− liftIO $ threadDelay 100000
539− terminate
540−
541− runProcess localNode $ do
542− ref <- monitor pid
543− ProcessMonitorNotification ref' pid' (DiedException ex) <- expect
544− True <- return $ ref == ref' && pid == pid' && ex == show ProcessTerminationException
545− liftIO $ putMVar done ()
546−
547− takeMVar done
548−
549−testMonitorNode :: NT.Transport -> Assertion
550−testMonitorNode transport = do
551− [node1, node2] <- replicateM 2 $ newLocalNode transport initRemoteTable
552− done <- newEmptyMVar
553−
554− closeLocalNode node1
555−
556− runProcess node2 $ do
557− ref <- monitorNode (localNodeId node1)
558− NodeMonitorNotification ref' nid DiedDisconnect <- expect
559− True <- return $ ref == ref' && nid == localNodeId node1
560− liftIO $ putMVar done ()
561−
562− takeMVar done
563−
564−testMonitorChannel :: NT.Transport -> Assertion
565−testMonitorChannel transport = do
566− [node1, node2] <- replicateM 2 $ newLocalNode transport initRemoteTable
567− gotNotification <- newEmptyMVar
568−
569− pid <- forkProcess node1 $ do
570− sport <- expect :: Process (SendPort ())
571− ref <- monitorPort sport
572− PortMonitorNotification ref' port' reason <- expect
573− -- reason might be DiedUnknownId if the receive port is GCed before the
574− -- monitor is established (TODO: not sure that this is reasonable)
575− return $ ref' == ref && port' == sendPortId sport && (reason == DiedNormal || reason == DiedUnknownId)
576− liftIO $ putMVar gotNotification ()
577−
578− runProcess node2 $ do
579− (sport, _) <- newChan :: Process (SendPort (), ReceivePort ())
580− send pid sport
581− liftIO $ threadDelay 100000
582−
583− takeMVar gotNotification
584−
585−testRegistry :: NT.Transport -> Assertion
586−testRegistry transport = do
587− node <- newLocalNode transport initRemoteTable
588− done <- newEmptyMVar
589−
590− pingServer <- forkProcess node ping
591−
592− runProcess node $ do
593− register "ping" pingServer
594− Just pid <- whereis "ping"
595− True <- return $ pingServer == pid
596− us <- getSelfPid
597− nsend "ping" (Pong us)
598− Ping pid' <- expect
599− True <- return $ pingServer == pid'
600− liftIO $ putMVar done ()
601−
602− takeMVar done
603−
604−testRemoteRegistry :: NT.Transport -> Assertion
605−testRemoteRegistry transport = do
606− node1 <- newLocalNode transport initRemoteTable
607− node2 <- newLocalNode transport initRemoteTable
608− done <- newEmptyMVar
609−
610− pingServer <- forkProcess node1 ping
611−
612− runProcess node2 $ do
613− let nid1 = localNodeId node1
614− registerRemoteAsync nid1 "ping" pingServer
615− receiveWait [
616− matchIf (\(RegisterReply label' _) -> "ping" == label')
617− (\(RegisterReply _ _) -> return ()) ]
618−
619− Just pid <- whereisRemote nid1 "ping"
620− True <- return $ pingServer == pid
621− us <- getSelfPid
622− nsendRemote nid1 "ping" (Pong us)
623− Ping pid' <- expect
624− True <- return $ pingServer == pid'
625− liftIO $ putMVar done ()
626−
627− takeMVar done
628−
629−testSpawnLocal :: NT.Transport -> Assertion
630−testSpawnLocal transport = do
631− node <- newLocalNode transport initRemoteTable
632− done <- newEmptyMVar
633−
634− runProcess node $ do
635− us <- getSelfPid
636−
637− pid <- spawnLocal $ do
638− sport <- expect
639− sendChan sport (1234 :: Int)
640−
641− sport <- spawnChannelLocal $ \rport -> do
642− (1234 :: Int) <- receiveChan rport
643− send us ()
644−
645− send pid sport
646− () <- expect
647− liftIO $ putMVar done ()
648−
649− takeMVar done
650−
651−testReconnect :: NT.Transport -> TransportInternals -> Assertion
652−testReconnect transport transportInternals = do
653− [node1, node2] <- replicateM 2 $ newLocalNode transport initRemoteTable
654− let nid1 = localNodeId node1
655− nid2 = localNodeId node2
656− processA <- newEmptyMVar
657− [sendTestOk, registerTestOk] <- replicateM 2 newEmptyMVar
658−
659− forkProcess node1 $ do
660− us <- getSelfPid
661− liftIO $ putMVar processA us
662− msg1 <- expect
663− msg2 <- expect
664− True <- return $ msg1 == "message 1" && msg2 == "message 3"
665− liftIO $ putMVar sendTestOk ()
666−
667− forkProcess node2 $ do
668− {-
669− - Make sure there is no implicit reconnect on normal message sending
670− -}
671−
672− them <- liftIO $ readMVar processA
673− send them "message 1" >> liftIO (threadDelay 100000)
674−
675− -- Simulate network failure
676− liftIO $ do
677− sock <- socketBetween transportInternals (nodeAddress nid1) (nodeAddress nid2)
678− sClose sock
679− threadDelay 10000
680−
681− -- Should not arrive
682− send them "message 2"
683−
684− -- Should arrive
685− reconnect them
686− send them "message 3"
687−
688− liftIO $ takeMVar sendTestOk
689−
690− {-
691− - Test that there *is* implicit reconnect on node controller messages
692− -}
693−
694− us <- getSelfPid
695− registerRemoteAsync nid1 "a" us -- registerRemote is asynchronous
696− receiveWait [
697− matchIf (\(RegisterReply label' _) -> "a" == label')
698− (\(RegisterReply _ _) -> return ()) ]
699−
700− Just _ <- whereisRemote nid1 "a"
701−
702−
703− -- Simulate network failure
704− liftIO $ do
705− sock <- socketBetween transportInternals (nodeAddress nid1) (nodeAddress nid2)
706− sClose sock
707− threadDelay 10000
708−
709− -- This will happen due to implicit reconnect
710− registerRemoteAsync nid1 "b" us
711− receiveWait [
712− matchIf (\(RegisterReply label' _) -> "b" == label')
713− (\(RegisterReply _ _) -> return ()) ]
714−
715− -- Should happen
716− registerRemoteAsync nid1 "c" us
717− receiveWait [
718− matchIf (\(RegisterReply label' _) -> "c" == label')
719− (\(RegisterReply _ _) -> return ()) ]
720−
721− -- Check
722− Nothing <- whereisRemote nid1 "a" -- this will fail because the name is removed when the node is disconnected
723− Just _ <- whereisRemote nid1 "b" -- this will suceed because the value is set after thereconnect
724− Just _ <- whereisRemote nid1 "c"
725−
726− liftIO $ putMVar registerTestOk ()
727−
728− takeMVar registerTestOk
729−
730−-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
731−-- in between
732−testMatchAny :: NT.Transport -> Assertion
733−testMatchAny transport = do
734− proxyAddr <- newEmptyMVar
735− clientDone <- newEmptyMVar
736−
737− -- Math server
738− forkIO $ do
739− localNode <- newLocalNode transport initRemoteTable
740− mathServer <- forkProcess localNode math
741− proxyServer <- forkProcess localNode $ forever $ do
742− msg <- receiveWait [ matchAny return ]
743− forward msg mathServer
744− putMVar proxyAddr proxyServer
745−
746− -- Client
747− forkIO $ do
748− localNode <- newLocalNode transport initRemoteTable
749− mathServer <- readMVar proxyAddr
750−
751− runProcess localNode $ do
752− pid <- getSelfPid
753− send mathServer (Add pid 1 2)
754− 3 <- expect :: Process Double
755− send mathServer (Divide pid 8 2)
756− 4 <- expect :: Process Double
757− send mathServer (Divide pid 8 0)
758− DivByZero <- expect
759− liftIO $ putMVar clientDone ()
760−
761− takeMVar clientDone
762−
763−-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
764−-- in between, however we block 'Divide' requests ....
765−testMatchAnyHandle :: NT.Transport -> Assertion
766−testMatchAnyHandle transport = do
767− proxyAddr <- newEmptyMVar
768− clientDone <- newEmptyMVar
769−
770− -- Math server
771− forkIO $ do
772− localNode <- newLocalNode transport initRemoteTable
773− mathServer <- forkProcess localNode math
774− proxyServer <- forkProcess localNode $ forever $ do
775− receiveWait [
776− matchAny (maybeForward mathServer)
777− ]
778− putMVar proxyAddr proxyServer
779−
780− -- Client
781− forkIO $ do
782− localNode <- newLocalNode transport initRemoteTable
783− mathServer <- readMVar proxyAddr
784−
785− runProcess localNode $ do
786− pid <- getSelfPid
787− send mathServer (Add pid 1 2)
788− 3 <- expect :: Process Double
789− send mathServer (Divide pid 8 2)
790− Nothing <- (expectTimeout 100000) :: Process (Maybe Double)
791− liftIO $ putMVar clientDone ()
792−
793− takeMVar clientDone
794− where maybeForward :: ProcessId -> Message -> Process (Maybe ())
795− maybeForward s msg =
796− handleMessage msg (\m@(Add _ _ _) -> send s m)
797−
798−testMatchAnyNoHandle :: NT.Transport -> Assertion
799−testMatchAnyNoHandle transport = do
800− addr <- newEmptyMVar
801− clientDone <- newEmptyMVar
802− serverDone <- newEmptyMVar
803−
804− -- Math server
805− forkIO $ do
806− localNode <- newLocalNode transport initRemoteTable
807− server <- forkProcess localNode $ forever $ do
808− receiveWait [
809− matchAnyIf
810− -- the condition has type `Add -> Bool`
811− (\(Add _ _ _) -> True)
812− -- the match `AbstractMessage -> Process ()` will succeed!
813− (\m -> do
814− -- `String -> Process ()` does *not* match the input types however
815− r <- (handleMessage m (\(_ :: String) -> die "NONSENSE" ))
816− case r of
817− Nothing -> return ()
818− Just _ -> die "NONSENSE")
819− ]
820− -- we *must* have removed the message from our mailbox though!!!
821− Nothing <- receiveTimeout 100000 [ match (\(Add _ _ _) -> return ()) ]
822− liftIO $ putMVar serverDone ()
823− putMVar addr server
824−
825− -- Client
826− forkIO $ do
827− localNode <- newLocalNode transport initRemoteTable
828− server <- readMVar addr
829−
830− runProcess localNode $ do
831− pid <- getSelfPid
832− send server (Add pid 1 2)
833− -- we only care about the client having sent a message, so we're done
834− liftIO $ putMVar clientDone ()
835−
836− takeMVar clientDone
837− takeMVar serverDone
838−
839−-- | Test 'matchAnyIf'. We provide an /echo/ server, but it ignores requests
840−-- unless the text body @/= "bar"@ - this case should time out rather than
841−-- removing the message from the process mailbox.
842−testMatchAnyIf :: NT.Transport -> Assertion
843−testMatchAnyIf transport = do
844− echoAddr <- newEmptyMVar
845− clientDone <- newEmptyMVar
846−
847− -- echo server
848− forkIO $ do
849− localNode <- newLocalNode transport initRemoteTable
850− echoServer <- forkProcess localNode $ forever $ do
851− receiveWait [
852− matchAnyIf (\(_ :: ProcessId, (s :: String)) -> s /= "bar")
853− tryHandleMessage
854− ]
855− putMVar echoAddr echoServer
856−
857− -- Client
858− forkIO $ do
859− localNode <- newLocalNode transport initRemoteTable
860− server <- readMVar echoAddr
861−
862− runProcess localNode $ do
863− pid <- getSelfPid
864− send server (pid, "foo")
865− "foo" <- expect
866− send server (pid, "baz")
867− "baz" <- expect
868− send server (pid, "bar")
869− Nothing <- (expectTimeout 100000) :: Process (Maybe Double)
870− liftIO $ putMVar clientDone ()
871−
872− takeMVar clientDone
873− where tryHandleMessage :: Message -> Process (Maybe ())
874− tryHandleMessage msg =
875− handleMessage msg (\(pid :: ProcessId, (m :: String))
876− -> do { send pid m; return () })
877−
878−testMatchMessageWithUnwrap :: NT.Transport -> Assertion
879−testMatchMessageWithUnwrap transport = do
880− echoAddr <- newEmptyMVar
881− clientDone <- newEmptyMVar
882−
883− -- echo server
884− forkIO $ do
885− localNode <- newLocalNode transport initRemoteTable
886− echoServer <- forkProcess localNode $ forever $ do
887− msg <- receiveWait [
888− matchMessage (\(m :: Message) -> do
889− return m)
890− ]
891− unwrapped <- unwrapMessage msg :: Process (Maybe (ProcessId, Message))
892− case unwrapped of
893− (Just (p, msg')) -> forward msg' p
894− Nothing -> die "unable to unwrap the message"
895− putMVar echoAddr echoServer
896−
897− -- Client
898− forkIO $ do
899− localNode <- newLocalNode transport initRemoteTable
900− server <- readMVar echoAddr
901−
902− runProcess localNode $ do
903− pid <- getSelfPid
904− send server (pid, wrapMessage ("foo" :: String))
905− "foo" <- expect
906− send server (pid, wrapMessage ("baz" :: String))
907− "baz" <- expect
908− liftIO $ putMVar clientDone ()
909−
910− takeMVar clientDone
911−
912−-- Test 'receiveChanTimeout'
913−testReceiveChanTimeout :: NT.Transport -> Assertion
914−testReceiveChanTimeout transport = do
915− done <- newEmptyMVar
916− sendPort <- newEmptyMVar
917−
918− forkTry $ do
919− localNode <- newLocalNode transport initRemoteTable
920− runProcess localNode $ do
921− -- Create a typed channel
922− (sp, rp) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
923− liftIO $ putMVar sendPort sp
924−
925− -- Wait for a message with a delay. No message arrives, we should get Nothing after 1 second
926− Nothing <- receiveChanTimeout 1000000 rp
927−
928− -- Wait for a message with a delay again. Now a message arrives after 0.5 seconds
929− Just True <- receiveChanTimeout 1000000 rp
930−
931− -- Wait for a message with zero timeout: non-blocking check. No message is available, we get Nothing
932− Nothing <- receiveChanTimeout 0 rp
933−
934− -- Again, but now there is a message available
935− liftIO $ threadDelay 1000000
936− Just False <- receiveChanTimeout 0 rp
937−
938− liftIO $ putMVar done ()
939−
940− forkTry $ do
941− localNode <- newLocalNode transport initRemoteTable
942− runProcess localNode $ do
943− sp <- liftIO $ readMVar sendPort
944−
945− liftIO $ threadDelay 1500000
946− sendChan sp True
947−
948− liftIO $ threadDelay 500000
949− sendChan sp False
950−
951− takeMVar done
952−
953−-- | Test Functor, Applicative, Alternative and Monad instances for ReceiveChan
954−testReceiveChanFeatures :: NT.Transport -> Assertion
955−testReceiveChanFeatures transport = do
956− done <- newEmptyMVar
957−
958− forkTry $ do
959− localNode <- newLocalNode transport initRemoteTable
960− runProcess localNode $ do
961− (spInt, rpInt) <- newChan :: Process (SendPort Int, ReceivePort Int)
962− (spBool, rpBool) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
963−
964− -- Test Functor instance
965−
966− sendChan spInt 2
967− sendChan spBool False
968−
969− rp1 <- mergePortsBiased [even <$> rpInt, rpBool]
970−
971− True <- receiveChan rp1
972− False <- receiveChan rp1
973−
974− -- Test Applicative instance
975−
976− sendChan spInt 3
977− sendChan spInt 4
978−
979− let rp2 = pure (+) <*> rpInt <*> rpInt
980−
981− 7 <- receiveChan rp2
982−
983− -- Test Alternative instance
984−
985− sendChan spInt 3
986− sendChan spBool True
987−
988− let rp3 = (even <$> rpInt) <|> rpBool
989−
990− False <- receiveChan rp3
991− True <- receiveChan rp3
992−
993− -- Test Monad instance
994−
995− sendChan spBool True
996− sendChan spBool False
997− sendChan spInt 5
998−
999− let rp4 :: ReceivePort Int
1000− rp4 = do b <- rpBool
1001− if b
1002− then rpInt
1003− else return 7
1004−
1005− 5 <- receiveChan rp4
1006− 7 <- receiveChan rp4
1007−
1008− liftIO $ putMVar done ()
1009−
1010− takeMVar done
1011−
1012−testKillLocal :: NT.Transport -> Assertion
1013−testKillLocal transport = do
1014− localNode <- newLocalNode transport initRemoteTable
1015− done <- newEmptyMVar
1016−
1017− pid <- forkProcess localNode $ do
1018− liftIO $ threadDelay 1000000
1019−
1020− runProcess localNode $ do
1021− ref <- monitor pid
1022− us <- getSelfPid
1023− kill pid "TestKill"
1024− ProcessMonitorNotification ref' pid' (DiedException ex) <- expect
1025− True <- return $ ref == ref' && pid == pid' && ex == "killed-by=" ++ show us ++ ",reason=TestKill"
1026− liftIO $ putMVar done ()
1027−
1028− takeMVar done
1029−
1030−testKillRemote :: NT.Transport -> Assertion
1031−testKillRemote transport = do
1032− node1 <- newLocalNode transport initRemoteTable
1033− node2 <- newLocalNode transport initRemoteTable
1034− done <- newEmptyMVar
1035−
1036− pid <- forkProcess node1 $ do
1037− liftIO $ threadDelay 1000000
1038−
1039− runProcess node2 $ do
1040− ref <- monitor pid
1041− us <- getSelfPid
1042− kill pid "TestKill"
1043− ProcessMonitorNotification ref' pid' (DiedException reason) <- expect
1044− True <- return $ ref == ref' && pid == pid' && reason == "killed-by=" ++ show us ++ ",reason=TestKill"
1045− liftIO $ putMVar done ()
1046−
1047− takeMVar done
1048−
1049−testCatchesExit :: NT.Transport -> Assertion
1050−testCatchesExit transport = do
1051− localNode <- newLocalNode transport initRemoteTable
1052− done <- newEmptyMVar
1053−
1054− _ <- forkProcess localNode $ do
1055− (die ("foobar", 123 :: Int))
1056− `catchesExit` [
1057− (\_ m -> handleMessage m (\(_ :: String) -> return ()))
1058− , (\_ m -> handleMessage m (\(_ :: Maybe Int) -> return ()))
1059− , (\_ m -> handleMessage m (\(_ :: String, _ :: Int)
1060− -> (liftIO $ putMVar done ()) >> return ()))
1061− ]
1062−
1063− takeMVar done
1064−
1065−testCatches :: NT.Transport -> Assertion
1066−testCatches transport = do
1067− localNode <- newLocalNode transport initRemoteTable
1068− done <- newEmptyMVar
1069−
1070− _ <- forkProcess localNode $ do
1071− node <- getSelfNode
1072− (liftIO $ throwIO (ProcessLinkException (nullProcessId node) DiedNormal))
1073− `catches` [
1074− Handler (\(ProcessLinkException _ _) -> liftIO $ putMVar done ())
1075− ]
1076−
1077− takeMVar done
1078−
1079−testMaskRestoreScope :: NT.Transport -> Assertion
1080−testMaskRestoreScope transport = do
1081− localNode <- newLocalNode transport initRemoteTable
1082− parentPid <- newEmptyMVar :: IO (MVar ProcessId)
1083− spawnedPid <- newEmptyMVar :: IO (MVar ProcessId)
1084−
1085− void $ runProcess localNode $ mask $ \unmask -> do
1086− getSelfPid >>= liftIO . putMVar parentPid
1087− void $ spawnLocal $ unmask (getSelfPid >>= liftIO . putMVar spawnedPid)
1088−
1089− parent <- liftIO $ takeMVar parentPid
1090− child <- liftIO $ takeMVar spawnedPid
1091− Rematch.expect parent $ isNot $ equalTo child
1092−
1093−testDie :: NT.Transport -> Assertion
1094−testDie transport = do
1095− localNode <- newLocalNode transport initRemoteTable
1096− done <- newEmptyMVar
1097−
1098− _ <- forkProcess localNode $ do
1099− (die ("foobar", 123 :: Int))
1100− `catchExit` \_from reason -> do
1101− -- TODO: should verify that 'from' has the right value
1102− True <- return $ reason == ("foobar", 123 :: Int)
1103− liftIO $ putMVar done ()
1104−
1105− takeMVar done
1106−
1107−testPrettyExit :: NT.Transport -> Assertion
1108−testPrettyExit transport = do
1109− localNode <- newLocalNode transport initRemoteTable
1110− done <- newEmptyMVar
1111−
1112− _ <- forkProcess localNode $ do
1113− (die "timeout")
1114− `catch` \ex@(ProcessExitException from _) ->
1115− let expected = "exit-from=" ++ (show from)
1116− in do
1117− True <- return $ (show ex) == expected
1118− liftIO $ putMVar done ()
1119−
1120− takeMVar done
1121−
1122−testExitLocal :: NT.Transport -> Assertion
1123−testExitLocal transport = do
1124− localNode <- newLocalNode transport initRemoteTable
1125− supervisedDone <- newEmptyMVar
1126− supervisorDone <- newEmptyMVar
1127−
1128− pid <- forkProcess localNode $ do
1129− (liftIO $ threadDelay 100000)
1130− `catchExit` \_from reason -> do
1131− -- TODO: should verify that 'from' has the right value
1132− True <- return $ reason == "TestExit"
1133− liftIO $ putMVar supervisedDone ()
1134−
1135− runProcess localNode $ do
1136− ref <- monitor pid
1137− exit pid "TestExit"
1138− -- This time the client catches the exception, so it dies normally
1139− ProcessMonitorNotification ref' pid' DiedNormal <- expect
1140− True <- return $ ref == ref' && pid == pid'
1141− liftIO $ putMVar supervisorDone ()
1142−
1143− takeMVar supervisedDone
1144− takeMVar supervisorDone
1145−
1146−testExitRemote :: NT.Transport -> Assertion
1147−testExitRemote transport = do
1148− node1 <- newLocalNode transport initRemoteTable
1149− node2 <- newLocalNode transport initRemoteTable
1150− supervisedDone <- newEmptyMVar
1151− supervisorDone <- newEmptyMVar
1152−
1153− pid <- forkProcess node1 $ do
1154− (liftIO $ threadDelay 100000)
1155− `catchExit` \_from reason -> do
1156− -- TODO: should verify that 'from' has the right value
1157− True <- return $ reason == "TestExit"
1158− liftIO $ putMVar supervisedDone ()
1159−
1160− runProcess node2 $ do
1161− ref <- monitor pid
1162− exit pid "TestExit"
1163− ProcessMonitorNotification ref' pid' DiedNormal <- expect
1164− True <- return $ ref == ref' && pid == pid'
1165− liftIO $ putMVar supervisorDone ()
1166−
1167− takeMVar supervisedDone
1168− takeMVar supervisorDone
1169−
1170−tests :: (NT.Transport, TransportInternals) -> [Test]
1171−tests (transport, transportInternals) = [
1172− testGroup "Basic features" [
1173− testCase "Ping" (testPing transport)
1174− , testCase "Math" (testMath transport)
1175− , testCase "Timeout" (testTimeout transport)
1176− , testCase "Timeout0" (testTimeout0 transport)
1177− , testCase "SendToTerminated" (testSendToTerminated transport)
1178− , testCase "TypedChannnels" (testTypedChannels transport)
1179− , testCase "MergeChannels" (testMergeChannels transport)
1180− , testCase "Terminate" (testTerminate transport)
1181− , testCase "Registry" (testRegistry transport)
1182− , testCase "RemoteRegistry" (testRemoteRegistry transport)
1183− , testCase "SpawnLocal" (testSpawnLocal transport)
1184− , testCase "MatchAny" (testMatchAny transport)
1185− , testCase "MatchAnyHandle" (testMatchAnyHandle transport)
1186− , testCase "MatchAnyNoHandle" (testMatchAnyNoHandle transport)
1187− , testCase "MatchAnyIf" (testMatchAnyIf transport)
1188− , testCase "MatchMessageUnwrap" (testMatchMessageWithUnwrap transport)
1189− , testCase "ReceiveChanTimeout" (testReceiveChanTimeout transport)
1190− , testCase "ReceiveChanFeatures" (testReceiveChanFeatures transport)
1191− , testCase "KillLocal" (testKillLocal transport)
1192− , testCase "KillRemote" (testKillRemote transport)
1193− , testCase "Die" (testDie transport)
1194− , testCase "PrettyExit" (testPrettyExit transport)
1195− , testCase "CatchesExit" (testCatchesExit transport)
1196− , testCase "Catches" (testCatches transport)
1197− , testCase "MaskRestoreScope" (testMaskRestoreScope transport)
1198− , testCase "ExitLocal" (testExitLocal transport)
1199− , testCase "ExitRemote" (testExitRemote transport)
1200− ]
1201− , testGroup "Monitoring and Linking" [
1202− -- Monitoring processes
1203− --
1204− -- The "missing" combinations in the list below don't make much sense, as
1205− -- we cannot guarantee that the monitor reply or link exception will not
1206− -- happen before the unmonitor or unlink
1207− testCase "MonitorUnreachable" (testMonitorUnreachable transport True False)
1208− , testCase "MonitorNormalTermination" (testMonitorNormalTermination transport True False)
1209− , testCase "MonitorAbnormalTermination" (testMonitorAbnormalTermination transport True False)
1210− , testCase "MonitorLocalDeadProcess" (testMonitorLocalDeadProcess transport True False)
1211− , testCase "MonitorRemoteDeadProcess" (testMonitorRemoteDeadProcess transport True False)
1212− , testCase "MonitorDisconnect" (testMonitorDisconnect transport True False)
1213− , testCase "LinkUnreachable" (testMonitorUnreachable transport False False)
1214− , testCase "LinkNormalTermination" (testMonitorNormalTermination transport False False)
1215− , testCase "LinkAbnormalTermination" (testMonitorAbnormalTermination transport False False)
1216− , testCase "LinkLocalDeadProcess" (testMonitorLocalDeadProcess transport False False)
1217− , testCase "LinkRemoteDeadProcess" (testMonitorRemoteDeadProcess transport False False)
1218− , testCase "LinkDisconnect" (testMonitorDisconnect transport False False)
1219− , testCase "UnmonitorNormalTermination" (testMonitorNormalTermination transport True True)
1220− , testCase "UnmonitorAbnormalTermination" (testMonitorAbnormalTermination transport True True)
1221− , testCase "UnmonitorDisconnect" (testMonitorDisconnect transport True True)
1222− , testCase "UnlinkNormalTermination" (testMonitorNormalTermination transport False True)
1223− , testCase "UnlinkAbnormalTermination" (testMonitorAbnormalTermination transport False True)
1224− , testCase "UnlinkDisconnect" (testMonitorDisconnect transport False True)
1225− -- Monitoring nodes and channels
1226− , testCase "MonitorNode" (testMonitorNode transport)
1227− , testCase "MonitorChannel" (testMonitorChannel transport)
1228− -- Reconnect
1229− , testCase "Reconnect" (testReconnect transport transportInternals)
1230− ]
1231− ]
1232−
1233−main :: IO ()
1234−main = do
1235− Right transport <- createTransportExposeInternals "127.0.0.1" "8080" defaultTCPParameters
1236− defaultMain (tests transport)
tests/TestClosure.hsdeleted−480
@@ -1,480 +0,0 @@
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)