-
Notifications
You must be signed in to change notification settings - Fork 721
/
Run.hs
440 lines (382 loc) · 17.5 KB
/
Run.hs
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE ScopedTypeVariables #-}
#if !defined(mingw32_HOST_OS)
#define UNIX
#endif
module Cardano.Node.Run
( runNode
, checkVRFFilePermissions
) where
import Cardano.Prelude hiding (ByteString, atomically, take, trace)
import Prelude (String)
import qualified Control.Concurrent.Async as Async
import Control.Monad.Trans.Except.Extra (left)
import Control.Tracer
import Data.Text (breakOn, pack, take)
import qualified Data.Text as Text
import Data.Time.Clock (getCurrentTime)
import Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds)
import Data.Version (showVersion)
import Network.HostName (getHostName)
import Network.Socket (AddrInfo, Socket)
import System.Directory (canonicalizePath, createDirectoryIfMissing, makeAbsolute)
import System.Environment (lookupEnv)
#ifdef UNIX
import System.Posix.Files
import System.Posix.Types (FileMode)
#else
import System.Win32.File
#endif
import Cardano.BM.Data.LogItem (LOContent (..), LogObject (..), PrivacyAnnotation (..),
mkLOMeta)
import Cardano.BM.Data.Tracer (ToLogObject (..), TracingVerbosity (..))
import Cardano.BM.Data.Transformers (setHostname)
import Cardano.BM.Trace
import Paths_cardano_node (version)
import qualified Cardano.Crypto.Libsodium as Crypto
import Cardano.Node.Configuration.Logging (LoggingLayer (..), Severity (..),
createLoggingLayer, nodeBasicInfo, shutdownLoggingLayer)
import Cardano.Node.Configuration.POM (NodeConfiguration (..),
PartialNodeConfiguration (..), defaultPartialNodeConfiguration,
makeNodeConfiguration, parseNodeConfigurationFP)
import Cardano.Node.Types
import Cardano.Tracing.Config (TraceOptions (..), TraceSelection (..))
import Ouroboros.Consensus.Block (BlockProtocol)
import qualified Ouroboros.Consensus.Cardano as Consensus
import qualified Ouroboros.Consensus.Config as Consensus
import Ouroboros.Consensus.Config.SupportsNode (getNetworkMagic)
import Ouroboros.Consensus.Node (DiffusionArguments (..), DiffusionTracers (..),
DnsSubscriptionTarget (..), IPSubscriptionTarget (..), RunNode,
RunNodeArgs (..), StdRunNodeArgs (..))
import qualified Ouroboros.Consensus.Node as Node (getChainDB, run)
import Ouroboros.Consensus.Node.ProtocolInfo
import Ouroboros.Consensus.Util.Orphans ()
import Ouroboros.Network.Magic (NetworkMagic (..))
import Ouroboros.Network.NodeToNode (AcceptedConnectionsLimit (..), DiffusionMode)
import Cardano.Node.Configuration.Socket (SocketOrSocketInfo (..),
gatherConfiguredSockets, getSocketOrSocketInfoAddr, renderSocketConfigError)
import Cardano.Node.Configuration.Topology
import Cardano.Node.Handlers.Shutdown
import Cardano.Node.Protocol (mkConsensusProtocol, renderProtocolInstantiationError)
import Cardano.Node.Protocol.Types
import Cardano.Tracing.Kernel
import Cardano.Tracing.Peer
import Cardano.Tracing.Tracers
{- HLINT ignore "Use fewer imports" -}
runNode
:: PartialNodeConfiguration
-> IO ()
runNode cmdPc = do
-- TODO: Remove sodiumInit: https://github.com/input-output-hk/cardano-base/issues/175
Crypto.sodiumInit
configYamlPc <- parseNodeConfigurationFP . getLast $ pncConfigFile cmdPc
nc <- case makeNodeConfiguration $ defaultPartialNodeConfiguration <> configYamlPc <> cmdPc of
Left err -> panic $ "Error in creating the NodeConfiguration: " <> Text.pack err
Right nc' -> return nc'
case shelleyVRFFile $ ncProtocolFiles nc of
Just vrfFp -> do vrf <- runExceptT $ checkVRFFilePermissions vrfFp
case vrf of
Left err ->
putTextLn (renderVRFPrivateKeyFilePermissionError err) >> exitFailure
Right () ->
pure ()
Nothing -> pure ()
eitherSomeProtocol <- runExceptT $ mkConsensusProtocol nc
SomeConsensusProtocol (p :: Consensus.Protocol IO blk (BlockProtocol blk)) <-
case eitherSomeProtocol of
Left err -> putTextLn (renderProtocolInstantiationError err) >> exitFailure
Right (SomeConsensusProtocol p) -> pure $ SomeConsensusProtocol p
eLoggingLayer <- runExceptT $ createLoggingLayer
(Text.pack (showVersion version))
nc
p
loggingLayer <- case eLoggingLayer of
Left err -> putTextLn (show err) >> exitFailure
Right res -> return res
!trace <- setupTrace loggingLayer
let tracer = contramap pack $ toLogObject trace
logTracingVerbosity nc tracer
-- This IORef contains node kernel structure which holds node kernel.
-- Used for ledger queries and peer connection status.
nodeKernelData :: NodeKernelData blk <- mkNodeKernelData
tracers <- mkTracers
(ncTraceConfig nc)
trace
nodeKernelData
(llEKGDirect loggingLayer)
Async.withAsync (handlePeersListSimple trace nodeKernelData)
$ \_peerLogingThread ->
-- We ignore peer loging thread if it dies, but it will be killed
-- when 'handleSimpleNode' terminates.
handleSimpleNode p trace tracers nc (setNodeKernel nodeKernelData)
`finally`
shutdownLoggingLayer loggingLayer
logTracingVerbosity :: NodeConfiguration -> Tracer IO String -> IO ()
logTracingVerbosity nc tracer =
case ncTraceConfig nc of
TracingOff -> return ()
TracingOn traceConf ->
case traceVerbosity traceConf of
NormalVerbosity -> traceWith tracer "tracing verbosity = normal verbosity "
MinimalVerbosity -> traceWith tracer "tracing verbosity = minimal verbosity "
MaximalVerbosity -> traceWith tracer "tracing verbosity = maximal verbosity "
-- | Add the application name and unqualified hostname to the logging
-- layer basic trace.
--
-- If the @CARDANO_NODE_LOGGING_HOSTNAME@ environment variable is set,
-- it overrides the system hostname. This is useful when running a
-- local test cluster with all nodes on the same host.
setupTrace
:: LoggingLayer
-> IO (Trace IO Text)
setupTrace loggingLayer = do
hn <- maybe hostname (pure . pack) =<< lookupEnv "CARDANO_NODE_LOGGING_HOSTNAME"
return $
setHostname hn $
llAppendName loggingLayer "node" (llBasicTrace loggingLayer)
where
hostname = do
hn0 <- pack <$> getHostName
return $ take 8 $ fst $ breakOn "." hn0
handlePeersListSimple
:: Trace IO Text
-> NodeKernelData blk
-> IO ()
handlePeersListSimple tr nodeKern = forever $ do
getCurrentPeers nodeKern >>= tracePeers tr
threadDelay 2000000 -- 2 seconds.
-- | Sets up a simple node, which will run the chain sync protocol and block
-- fetch protocol, and, if core, will also look at the mempool when trying to
-- create a new block.
handleSimpleNode
:: forall blk. RunNode blk
=> Consensus.Protocol IO blk (BlockProtocol blk)
-> Trace IO Text
-> Tracers RemoteConnectionId LocalConnectionId blk
-> NodeConfiguration
-> (NodeKernel IO RemoteConnectionId LocalConnectionId blk -> IO ())
-- ^ Called on the 'NodeKernel' after creating it, but before the network
-- layer is initialised. This implies this function must not block,
-- otherwise the node won't actually start.
-> IO ()
handleSimpleNode p trace nodeTracers nc onKernel = do
meta <- mkLOMeta Notice Public
let pInfo = Consensus.protocolInfo p
tracer = toLogObject trace
createTracers nc trace tracer
(publicIPv4SocketOrAddr, publicIPv6SocketOrAddr, localSocketOrPath) <- do
result <- runExceptT (gatherConfiguredSockets nc)
case result of
Right triplet -> return triplet
Left error -> do
traceNamedObject
(appendName "error" trace)
(meta, LogMessage (Text.pack (renderSocketConfigError error)))
throwIO error
dbPath <- canonDbPath nc
eitherTopology <- readTopologyFile nc
nt <- either (\err -> panic $ "Cardano.Node.Run.handleSimpleNode.readTopologyFile: " <> err) pure eitherTopology
let diffusionTracers :: DiffusionTracers
diffusionTracers = createDiffusionTracers nodeTracers
(ipProducerAddrs, dnsProducerAddrs) = producerAddresses nt
dnsProducers :: [DnsSubscriptionTarget]
dnsProducers = uncurry dnsSubscriptionTarget `map` dnsProducerAddrs
ipProducers :: IPSubscriptionTarget
ipProducers = ipSubscriptionTargets ipProducerAddrs
diffusionArguments :: DiffusionArguments
diffusionArguments =
createDiffusionArguments
publicIPv4SocketOrAddr
publicIPv6SocketOrAddr
localSocketOrPath
(ncDiffusionMode nc)
ipProducers
dnsProducers
ipv4 <- traverse getSocketOrSocketInfoAddr publicIPv4SocketOrAddr
ipv6 <- traverse getSocketOrSocketInfoAddr publicIPv6SocketOrAddr
traceNamedObject
(appendName "addresses" trace)
(meta, LogMessage . Text.pack . show $ catMaybes [ipv4, ipv6])
traceNamedObject
(appendName "diffusion-mode" trace)
(meta, LogMessage . Text.pack . show . ncDiffusionMode $ nc)
traceNamedObject
(appendName "dns-producers" trace)
(meta, LogMessage . Text.pack . show $ dnsProducers)
traceNamedObject
(appendName "ip-producers" trace)
(meta, LogMessage . Text.pack . show $ ipProducers)
withShutdownHandling nc trace $ \sfds ->
Node.run
RunNodeArgs
{ rnTraceConsensus = consensusTracers nodeTracers
, rnTraceNTN = nodeToNodeTracers nodeTracers
, rnTraceNTC = nodeToClientTracers nodeTracers
, rnProtocolInfo = pInfo
, rnNodeKernelHook = \registry nodeKernel -> do
maybeSpawnOnSlotSyncedShutdownHandler nc sfds trace registry
(Node.getChainDB nodeKernel)
onKernel nodeKernel
}
StdRunNodeArgs
{ srnBfcMaxConcurrencyBulkSync = unMaxConcurrencyBulkSync <$> ncMaxConcurrencyBulkSync nc
, srnBfcMaxConcurrencyDeadline = unMaxConcurrencyDeadline <$> ncMaxConcurrencyDeadline nc
, srnChainDbValidateOverride = ncValidateDB nc
, srnDatabasePath = dbPath
, srnDiffusionArguments = diffusionArguments
, srnDiffusionTracers = diffusionTracers
, srnEnableInDevelopmentVersions = ncTestInDevelopmentVersions nc
, srnTraceChainDB = chainDBTracer nodeTracers
}
where
createDiffusionTracers :: Tracers RemoteConnectionId LocalConnectionId blk
-> DiffusionTracers
createDiffusionTracers nodeTracers' = DiffusionTracers
{ dtIpSubscriptionTracer = ipSubscriptionTracer nodeTracers'
, dtDnsSubscriptionTracer = dnsSubscriptionTracer nodeTracers'
, dtDnsResolverTracer = dnsResolverTracer nodeTracers'
, dtErrorPolicyTracer = errorPolicyTracer nodeTracers'
, dtLocalErrorPolicyTracer = localErrorPolicyTracer nodeTracers'
, dtAcceptPolicyTracer = acceptPolicyTracer nodeTracers'
, dtMuxTracer = muxTracer nodeTracers'
, dtMuxLocalTracer = nullTracer
, dtHandshakeTracer = handshakeTracer nodeTracers'
, dtHandshakeLocalTracer = localHandshakeTracer nodeTracers'
, dtDiffusionInitializationTracer = diffusionInitializationTracer nodeTracers'
, dtLedgerPeersTracer = nullTracer -- TODO network team
}
createTracers
:: NodeConfiguration
-> Trace IO Text
-> Tracer IO Text
-> IO ()
createTracers NodeConfiguration { ncValidateDB }
tr tracer = do
let ProtocolInfo{ pInfoConfig = cfg } = Consensus.protocolInfo p
meta <- mkLOMeta Notice Public
traceNamedObject (appendName "networkMagic" tr)
(meta, LogMessage ("NetworkMagic " <> show (unNetworkMagic . getNetworkMagic $ Consensus.configBlock cfg)))
startTime <- getCurrentTime
traceNodeBasicInfo tr =<< nodeBasicInfo nc p startTime
traceCounter "nodeStartTime" tr (ceiling $ utcTimeToPOSIXSeconds startTime)
when ncValidateDB $ traceWith tracer "Performing DB validation"
traceNodeBasicInfo :: Trace IO Text -> [LogObject Text] -> IO ()
traceNodeBasicInfo tr basicInfoItems =
forM_ basicInfoItems $ \(LogObject nm mt content) ->
traceNamedObject (appendName nm tr) (mt, content)
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------
canonDbPath :: NodeConfiguration -> IO FilePath
canonDbPath NodeConfiguration{ncDatabaseFile = DbFile dbFp} = do
fp <- canonicalizePath =<< makeAbsolute dbFp
createDirectoryIfMissing True fp
return fp
-- | Make sure the VRF private key file is readable only
-- by the current process owner the node is running under.
checkVRFFilePermissions :: FilePath -> ExceptT VRFPrivateKeyFilePermissionError IO ()
#ifdef UNIX
checkVRFFilePermissions vrfPrivKey = do
fs <- liftIO $ getFileStatus vrfPrivKey
let fm = fileMode fs
-- Check the the VRF private key file does not give read/write/exec permissions to others.
when (hasOtherPermissions fm)
(left $ OtherPermissionsExist vrfPrivKey)
-- Check the the VRF private key file does not give read/write/exec permissions to any group.
when (hasGroupPermissions fm)
(left $ GroupPermissionsExist vrfPrivKey)
where
hasPermission :: FileMode -> FileMode -> Bool
hasPermission fModeA fModeB = fModeA `intersectFileModes` fModeB /= nullFileMode
hasOtherPermissions :: FileMode -> Bool
hasOtherPermissions fm' = fm' `hasPermission` otherModes
hasGroupPermissions :: FileMode -> Bool
hasGroupPermissions fm' = fm' `hasPermission` groupModes
#else
checkVRFFilePermissions vrfPrivKey = do
attribs <- liftIO $ getFileAttributes vrfPrivKey
-- https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilea
-- https://docs.microsoft.com/en-us/windows/win32/fileio/file-access-rights-constants
-- https://docs.microsoft.com/en-us/windows/win32/secauthz/standard-access-rights
-- https://docs.microsoft.com/en-us/windows/win32/secauthz/generic-access-rights
-- https://docs.microsoft.com/en-us/windows/win32/secauthz/access-mask
when (attribs `hasPermission` genericPermissions)
(left $ GenericPermissionsExist vrfPrivKey)
where
genericPermissions = gENERIC_ALL .|. gENERIC_READ .|. gENERIC_WRITE .|. gENERIC_EXECUTE
hasPermission fModeA fModeB = fModeA .&. fModeB /= gENERIC_NONE
#endif
createDiffusionArguments
:: Maybe (SocketOrSocketInfo Socket AddrInfo)
-- ^ Either a socket bound to IPv4 address provided by systemd or IPv4
-- address to bind to for NodeToNode communication.
-> Maybe (SocketOrSocketInfo Socket AddrInfo)
-- ^ Either a socket bound to IPv6 address provided by systemd or IPv6
-- address to bind to for NodeToNode communication.
-> SocketOrSocketInfo Socket SocketPath
-- ^ Either a SOCKET_UNIX socket provided by systemd or a path for
-- NodeToClient communication.
-> DiffusionMode
-> IPSubscriptionTarget
-> [DnsSubscriptionTarget]
-> DiffusionArguments
createDiffusionArguments publicIPv4SocketsOrAddrs
publicIPv6SocketsOrAddrs
localSocketOrPath
diffusionMode
ipProducers dnsProducers
=
DiffusionArguments
-- This is not elegant, but it will change once `coot/connection-manager` is
-- merged into `ouroboros-networ`.
{ daIPv4Address = eitherSocketOrSocketInfo <$> publicIPv4SocketsOrAddrs
, daIPv6Address = eitherSocketOrSocketInfo <$> publicIPv6SocketsOrAddrs
, daLocalAddress = fmap unSocketPath
. eitherSocketOrSocketInfo
$ localSocketOrPath
, daIpProducers = ipProducers
, daDnsProducers = dnsProducers
-- TODO: these limits are arbitrary at the moment;
-- issue: https://github.com/input-output-hk/ouroboros-network/issues/1836
, daAcceptedConnectionsLimit = AcceptedConnectionsLimit {
acceptedConnectionsHardLimit = 512
, acceptedConnectionsSoftLimit = 384
, acceptedConnectionsDelay = 5
}
, daDiffusionMode = diffusionMode
}
where
eitherSocketOrSocketInfo :: SocketOrSocketInfo a b -> Either a b
eitherSocketOrSocketInfo (ActualSocket a) = Left a
eitherSocketOrSocketInfo (SocketInfo b) = Right b
dnsSubscriptionTarget :: NodeDnsAddress -> Int -> DnsSubscriptionTarget
dnsSubscriptionTarget na valency =
DnsSubscriptionTarget { dstDomain = nodeHostDnsAddressToDomain (naHostAddress na)
, dstPort = naPort na
, dstValency = valency
}
ipSubscriptionTargets :: [NodeIPAddress] -> IPSubscriptionTarget
ipSubscriptionTargets ipProdAddrs =
let ips = nodeAddressToSockAddr <$> ipProdAddrs
in IPSubscriptionTarget { ispIps = ips
, ispValency = length ips
}
producerAddresses
:: NetworkTopology
-> ( [NodeIPAddress]
, [(NodeDnsAddress, Int)])
producerAddresses nt =
case nt of
RealNodeTopology producers' ->
partitionEithers
. mapMaybe remoteAddressToNodeAddress
$ producers'
MockNodeTopology nodeSetup ->
partitionEithers
. mapMaybe remoteAddressToNodeAddress
. concatMap producers
$ nodeSetup