1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
{-# LANGUAGE ExistentialQuantification #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE NondecreasingIndentation #-}
module Announcer
( Announcer
, AnnounceKey
, packAnnounceKey
, unpackAnnounceKey
, AnnounceMethod(..)
, forkAnnouncer
, stopAnnouncer
, schedule
, cancel
) where
import qualified Data.MinMaxPSQ as MM
import Data.Wrapper.PSQ as PSQ
import InterruptibleDelay
import Network.Kademlia.Routing as R
import Network.Kademlia.Search
import Control.Concurrent.Lifted.Instrument
import Control.Concurrent.STM
import Control.Monad
import Data.ByteString (ByteString)
import qualified Data.ByteString.Char8 as Char8
import Data.Function
import Data.Hashable
import Data.Maybe
import Data.Ord
import Data.Time.Clock.POSIX
newtype AnnounceKey = AnnounceKey ByteString
deriving (Hashable,Ord,Eq)
packAnnounceKey :: Announcer -> String -> STM AnnounceKey
packAnnounceKey _ = return . AnnounceKey . Char8.pack
unpackAnnounceKey :: AnnounceKey -> AnnounceKey -> STM String
unpackAnnounceKey _ (AnnounceKey bs) = return $ Char8.unpack bs
data ScheduledItem
= StopAnnouncer
| NewAnnouncement (STM (IO ())) (IO ()) (IO ()) POSIXTime
| SearchFinished (IO ()) (IO ()) POSIXTime
| Announce (STM (IO ())) (IO ()) POSIXTime
| DeleteAnnouncement
data Announcer = Announcer
{ scheduled :: TVar (PSQ' AnnounceKey POSIXTime ScheduledItem)
, announcerActive :: TVar Bool
, interrutible :: InterruptibleDelay
}
announceK :: Int
announceK = 8
data AnnounceState = forall nid addr tok ni r. AnnounceState
{ aState :: SearchState nid addr tok ni r
, aStoringNodes :: TVar (MM.MinMaxPSQ ni (Down POSIXTime))
}
scheduleImmediately :: Announcer -> AnnounceKey -> ScheduledItem -> STM ()
scheduleImmediately announcer k item
= modifyTVar' (scheduled announcer) (PSQ.insert' k item 0)
stopAnnouncer :: Announcer -> IO ()
stopAnnouncer announcer = do
atomically $ scheduleImmediately announcer (AnnounceKey "*stop*") StopAnnouncer
interruptDelay (interrutible announcer)
atomically $ readTVar (announcerActive announcer) >>= check . not
data AnnounceMethod r = forall nid ni sr addr tok a.
( Show nid
, Hashable nid
, Hashable ni
, Ord addr
, Ord nid
, Ord ni
) => AnnounceMethod
{ aSearch :: Search nid addr tok ni sr
, aPublish :: r -> tok -> Maybe ni -> IO (Maybe a)
, aBuckets :: TVar (R.BucketList ni)
, aTarget :: nid
, aInterval :: POSIXTime
}
schedule :: Announcer -> AnnounceKey -> AnnounceMethod r -> r -> IO ()
schedule announcer k AnnounceMethod{aSearch,aPublish,aBuckets,aTarget,aInterval} r = do
st <- atomically $ newSearch aSearch aTarget []
ns <- atomically $ newTVar MM.empty
let astate = AnnounceState st ns
publishToNodes is = do
forM_ is $ \(Binding ni mtok _) -> do
forM_ mtok $ \tok -> do
got <- aPublish r tok (Just ni)
now <- getPOSIXTime
forM_ got $ \_ -> do
atomically $ modifyTVar ns $ MM.insertTake announceK ni (Down now)
announce = do -- publish to current search results
is <- atomically $ do
bs <- readTVar (searchInformant st {- :: TVar (MinMaxPSQ' ni nid tok -})
return $ MM.toList bs
publishToNodes is
onResult _ = return True -- action for each search-hit (True = keep searching)
searchAgain = searchIsFinished st >>= \isfin -> return $ when isfin $ void $ fork search
search = do -- thread to fork
atomically $ reset aBuckets aSearch aTarget st
searchLoop aSearch aTarget onResult st
fork $ do -- Announce to any nodes we haven't already announced to.
is <- atomically $ do
bs <- readTVar (searchInformant st {- :: TVar (MinMaxPSQ' ni nid tok -})
nq <- readTVar ns
return $ filter (\(Binding ni _ _) -> not $ isJust $ MM.lookup' ni nq)
$ MM.toList bs
publishToNodes is
return ()
{-
atomically $ scheduleImmediately announcer k
$ SearchFinished {- st -} search announce aInterval
interruptDelay (interrutible announcer)
-}
atomically $ scheduleImmediately announcer k $ NewAnnouncement searchAgain search announce aInterval
interruptDelay (interrutible announcer)
cancel :: Announcer -> AnnounceKey -> AnnounceMethod r -> r -> IO ()
cancel announcer k _ _ = do
atomically $ scheduleImmediately announcer k $ DeleteAnnouncement
interruptDelay (interrutible announcer)
forkAnnouncer :: IO Announcer
forkAnnouncer = do
delay <- interruptibleDelay
announcer <- atomically $ Announcer <$> newTVar PSQ.empty
<*> newTVar True
<*> pure delay
fork $ announceThread announcer
return announcer
announceThread :: Announcer -> IO ()
announceThread announcer = do
myThreadId >>= flip labelThread "announcer"
fix $ \loop -> do
join $ atomically $ do
item <- maybe retry return =<< findMin <$> readTVar (scheduled announcer)
return $ do
now <- getPOSIXTime
-- Is it time to do something?
if (prio item < now)
then do -- Yes. Dequeue and handle this event.
action <- atomically $ do
modifyTVar' (scheduled announcer)
(PSQ.delete (key item))
performScheduledItem announcer now item
-- Are we finished?
mapM_ (>> loop) -- No? Okay, perform scheduled op and loop.
action
else do -- No. Wait a bit.
startDelay (interrutible announcer) (microseconds $ prio item - now)
loop
-- We're done. Let 'stopAnnouncer' know that it can stop blocking.
atomically $ writeTVar (announcerActive announcer) False
performScheduledItem :: Announcer -> POSIXTime -> Binding' AnnounceKey POSIXTime ScheduledItem -> STM (Maybe (IO ()))
performScheduledItem announcer now = \case
(Binding _ StopAnnouncer _) -> return Nothing
-- announcement started:
(Binding k (NewAnnouncement checkFin search announce interval) _) -> do
modifyTVar (scheduled announcer)
(PSQ.insert' k (Announce checkFin announce interval) (now + interval))
return $ Just $ void $ fork search
-- announcement removed:
(Binding k DeleteAnnouncement _) -> return $ Just $ return ()
-- time for periodic announce:
-- (re-)announce to the current known set of storing-nodes.
-- TODO: If the search is finished, restart the search.
(Binding k (Announce checkFin announce interval) _) -> do
isfin <- checkFin
modifyTVar (scheduled announcer)
(PSQ.insert' k (Announce checkFin announce interval) (now + interval))
return $ Just $ do
isfin
announce
-- search finished:
-- if any of the current storing-nodes set have not been
-- announced to, announce to them.
(Binding _ (SearchFinished {- st -} search announce interval) _) -> return $ Just $ return ()
|