-
Notifications
You must be signed in to change notification settings - Fork 721
/
POM.hs
331 lines (285 loc) · 15.2 KB
/
POM.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
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# OPTIONS_GHC -Wno-noncanonical-monoid-instances #-}
{-# OPTIONS_GHC -Wno-orphans #-} -- TODO: REMOVE ME
module Cardano.Node.Configuration.POM
( NodeConfigurationF (..)
, PartialNodeConfiguration(..)
, defaultPartialNodeConfiguration
, lastOption
, makeNodeConfiguration
, parseNodeConfigurationFP
)
where
import Cardano.Prelude
import Prelude (String)
import Control.Monad (fail)
import Data.Aeson
import Data.Semigroup (Semigroup (..))
import Data.Yaml (decodeFileThrow)
import Generic.Data (gmappend)
import Generic.Data.Orphans ()
import Options.Applicative
import System.FilePath (takeDirectory, (</>))
import System.Posix.Types (Fd (..))
import qualified Cardano.Chain.Update as Byron
import Cardano.Crypto (RequiresNetworkMagic (..))
import Cardano.Node.Protocol.Types (Protocol (..))
import Cardano.Node.Types hiding (NodeConfiguration (..))
import Cardano.Tracing.Config
import Ouroboros.Network.Block (MaxSlotNo (..))
data NodeConfigurationF
= NodeConfigurationF
{ ncNodeAddr :: !(Maybe NodeAddress)
-- | Filepath of the configuration yaml file. This file determines
-- all the configuration settings required for the cardano node
-- (logging, tracing, protocol, slot length etc)
, ncConfigFile :: !ConfigYamlFilePath
, ncTopologyFile :: !TopologyFile
, ncDatabaseFile :: !DbFile
, ncProtocolFiles :: !ProtocolFilepaths
, ncValidateDB :: !Bool
, ncShutdownIPC :: !(Maybe Fd)
, ncShutdownOnSlotSynced :: !MaxSlotNo
-- What used to be the NodeConfiguration
-- Protocol-specific parameters:
, ncProtocolConfig :: !NodeProtocolConfiguration
-- Node parameters, not protocol-specific:
, ncSocketPath :: !(Maybe SocketPath)
-- BlockFetch configuration
, ncMaxConcurrencyBulkSync :: !(Maybe MaxConcurrencyBulkSync)
, ncMaxConcurrencyDeadline :: !(Maybe MaxConcurrencyDeadline)
-- Logging parameters:
, ncViewMode :: !ViewMode
, ncLoggingSwitch :: !Bool
, ncLogMetrics :: !Bool
, ncTraceConfig :: !TraceOptions
} deriving Show
data PartialNodeConfiguration
= PartialNodeConfiguration
{ -- Previously NodeCLI
pncNodeAddr :: !(Last NodeAddress)
-- | Filepath of the configuration yaml file. This file determines
-- all the configuration settings required for the cardano node
-- (logging, tracing, protocol, slot length etc)
, pncConfigFile :: !(Last ConfigYamlFilePath)
, pncTopologyFile :: !(Last TopologyFile)
, pncDatabaseFile :: !(Last DbFile)
-- , pncsocketFile :: !(Last (Maybe SocketPath))
, pncProtocolFiles :: !(Last ProtocolFilepaths)
, pncValidateDB :: !(Last Bool)
, pncShutdownIPC :: !(Last (Maybe Fd))
, pncShutdownOnSlotSynced :: !(Last MaxSlotNo)
-- From here onward was the original NodeConfiguration
-- Protocol-specific parameters:
, pncProtocolConfig :: !(Last NodeProtocolConfiguration)
-- Node parameters, not protocol-specific:
, pncSocketPath :: !(Last SocketPath)
-- BlockFetch configuration
, pncMaxConcurrencyBulkSync :: !(Last (Maybe MaxConcurrencyBulkSync))
, pncMaxConcurrencyDeadline :: !(Last (Maybe MaxConcurrencyDeadline))
-- Logging parameters:
, pncViewMode :: !(Last ViewMode)
, pncLoggingSwitch :: !(Last Bool)
, pncLogMetrics :: !(Last Bool)
, pncTraceConfig :: !(Last TraceOptions)
} deriving (Eq, Generic, Show)
instance AdjustFilePaths PartialNodeConfiguration where
adjustFilePaths f x@PartialNodeConfiguration {
pncProtocolConfig,
pncSocketPath
} =
x {
pncProtocolConfig = adjustFilePaths f pncProtocolConfig,
pncSocketPath = adjustFilePaths f pncSocketPath
}
instance AdjustFilePaths (Last NodeProtocolConfiguration) where
adjustFilePaths f (Last (Just (NodeProtocolConfigurationByron pc))) =
Last . Just $ NodeProtocolConfigurationByron (adjustFilePaths f pc)
adjustFilePaths f (Last (Just (NodeProtocolConfigurationShelley pc))) =
Last . Just $ NodeProtocolConfigurationShelley (adjustFilePaths f pc)
adjustFilePaths f (Last (Just (NodeProtocolConfigurationCardano pcb pcs pch))) =
Last . Just $ NodeProtocolConfigurationCardano (adjustFilePaths f pcb)
(adjustFilePaths f pcs)
pch
adjustFilePaths _ (Last Nothing) = Last Nothing
instance AdjustFilePaths (Last SocketPath) where
adjustFilePaths f (Last (Just (SocketPath p))) = Last . Just $ SocketPath (f p)
adjustFilePaths _ (Last Nothing) = Last Nothing
instance Semigroup PartialNodeConfiguration where
(<>) = gmappend
instance Monoid PartialNodeConfiguration where
mempty = PartialNodeConfiguration mempty mempty mempty mempty mempty mempty mempty mempty mempty mempty mempty mempty mempty mempty mempty mempty
mappend x y = PartialNodeConfiguration
{ pncNodeAddr = pncNodeAddr x <> pncNodeAddr y
, pncConfigFile = pncConfigFile x <> pncConfigFile y
, pncTopologyFile = pncTopologyFile x <> pncTopologyFile y
, pncDatabaseFile = pncDatabaseFile x <> pncDatabaseFile y
-- , pncsocketFile = pncSocketFile x <> pncSocketFile y
, pncProtocolFiles = pncProtocolFiles x <> pncProtocolFiles y
, pncValidateDB = pncValidateDB x <> pncValidateDB y
, pncShutdownIPC = pncShutdownIPC x <> pncShutdownIPC y
, pncShutdownOnSlotSynced = pncShutdownOnSlotSynced x <> pncShutdownOnSlotSynced y
, pncProtocolConfig = pncProtocolConfig x <> pncProtocolConfig y
, pncSocketPath = pncSocketPath x <> pncSocketPath y
, pncMaxConcurrencyBulkSync = pncMaxConcurrencyBulkSync x <> pncMaxConcurrencyBulkSync y
, pncMaxConcurrencyDeadline = pncMaxConcurrencyDeadline x <> pncMaxConcurrencyDeadline y
, pncViewMode = pncViewMode x <> pncViewMode y
, pncLoggingSwitch = pncLoggingSwitch x <> pncLoggingSwitch y
, pncLogMetrics = pncLogMetrics x <> pncLogMetrics y
, pncTraceConfig = pncTraceConfig x <> pncTraceConfig y
}
instance FromJSON PartialNodeConfiguration where
parseJSON =
withObject "PartialNodeConfiguration" $ \v -> do
-- Node parameters, not protocol-specific
pncSocketPath' <- Last <$> v .:? "SocketPath"
-- Blockfetch parameters
pncMaxConcurrencyBulkSync' <- Last <$> v .:? "MaxConcurrencyBulkSync"
pncMaxConcurrencyDeadline' <- Last <$> v .:? "MaxConcurrencyDeadline"
-- Logging parameters
pncViewMode' <- Last <$> v .:? "ViewMode" -- This needs to be in the default config .!= SimpleView
pncLoggingSwitch' <- v .:? "TurnOnLogging" .!= True -- This needs to be in the default config .!= True
pncLogMetrics' <- Last <$> v .:? "TurnOnLogMetrics" -- This needs to be in the default config .!= True
pncTraceConfig' <- if pncLoggingSwitch' -- TODO: Need to unpackage last and check the bool
then Last . Just <$> traceConfigParser v
else return . Last $ Just TracingOff
-- Protocol parameters
protocol <- v .:? "Protocol" .!= ByronProtocol -- Should be in the default config
pncProtocolConfig' <-
case protocol of
ByronProtocol ->
Last . Just . NodeProtocolConfigurationByron <$> parseByronProtocol v
ShelleyProtocol ->
Last . Just . NodeProtocolConfigurationShelley <$> parseShelleyProtocol v
CardanoProtocol ->
Last . Just <$> (NodeProtocolConfigurationCardano <$> parseByronProtocol v
<*> parseShelleyProtocol v
<*> parseHardForkProtocol v)
pure mempty {
pncProtocolConfig = pncProtocolConfig'
, pncSocketPath = pncSocketPath'
, pncMaxConcurrencyBulkSync = pncMaxConcurrencyBulkSync'
, pncMaxConcurrencyDeadline = pncMaxConcurrencyDeadline'
, pncViewMode = pncViewMode'
, pncLoggingSwitch = Last $ Just pncLoggingSwitch'
, pncLogMetrics = pncLogMetrics'
, pncTraceConfig = pncTraceConfig'
}
where
parseByronProtocol v = do
primary <- v .:? "ByronGenesisFile"
secondary <- v .:? "GenesisFile"
npcByronGenesisFile <-
case (primary, secondary) of
(Just g, Nothing) -> return g
(Nothing, Just g) -> return g
(Nothing, Nothing) -> fail $ "Missing required field, either "
++ "ByronGenesisFile or GenesisFile"
(Just _, Just _) -> fail $ "Specify either ByronGenesisFile"
++ "or GenesisFile, but not both"
npcByronGenesisFileHash <- v .:? "ByronGenesisHash"
npcByronReqNetworkMagic <- v .:? "RequiresNetworkMagic"
.!= RequiresNoMagic
npcByronPbftSignatureThresh <- v .:? "PBftSignatureThreshold"
npcByronApplicationName <- v .:? "ApplicationName"
.!= Byron.ApplicationName "cardano-sl"
npcByronApplicationVersion <- v .:? "ApplicationVersion" .!= 1
protVerMajor <- v .: "LastKnownBlockVersion-Major"
protVerMinor <- v .: "LastKnownBlockVersion-Minor"
protVerAlt <- v .: "LastKnownBlockVersion-Alt" .!= 0
pure NodeByronProtocolConfiguration {
npcByronGenesisFile
, npcByronGenesisFileHash
, npcByronReqNetworkMagic
, npcByronPbftSignatureThresh
, npcByronApplicationName
, npcByronApplicationVersion
, npcByronSupportedProtocolVersionMajor = protVerMajor
, npcByronSupportedProtocolVersionMinor = protVerMinor
, npcByronSupportedProtocolVersionAlt = protVerAlt
}
parseShelleyProtocol v = do
primary <- v .:? "ShelleyGenesisFile"
secondary <- v .:? "GenesisFile"
npcShelleyGenesisFile <-
case (primary, secondary) of
(Just g, Nothing) -> return g
(Nothing, Just g) -> return g
(Nothing, Nothing) -> fail $ "Missing required field, either "
++ "ShelleyGenesisFile or GenesisFile"
(Just _, Just _) -> fail $ "Specify either ShelleyGenesisFile"
++ "or GenesisFile, but not both"
npcShelleyGenesisFileHash <- v .:? "ShelleyGenesisHash"
--TODO: these are silly names, allow better aliases:
protVerMajor <- v .: "LastKnownBlockVersion-Major"
protVerMinor <- v .: "LastKnownBlockVersion-Minor"
protVerMajroMax <- v .:? "MaxKnownMajorProtocolVersion" .!= 1
pure NodeShelleyProtocolConfiguration {
npcShelleyGenesisFile
, npcShelleyGenesisFileHash
, npcShelleySupportedProtocolVersionMajor = protVerMajor
, npcShelleySupportedProtocolVersionMinor = protVerMinor
, npcShelleyMaxSupportedProtocolVersion = protVerMajroMax
}
parseHardForkProtocol v = do
npcTestShelleyHardForkAtEpoch <- v .:? "TestShelleyHardForkAtEpoch"
npcTestShelleyHardForkAtVersion <- v .:? "TestShelleyHardForkAtVersion"
npcShelleyHardForkNotBeforeEpoch <- v .:? "ShelleyHardForkNotBeforeEpoch"
pure NodeHardForkProtocolConfiguration {
npcTestShelleyHardForkAtEpoch,
npcTestShelleyHardForkAtVersion,
npcShelleyHardForkNotBeforeEpoch
}
defaultPartialNodeConfiguration :: PartialNodeConfiguration
defaultPartialNodeConfiguration = mempty
{ pncViewMode = Last $ Just SimpleView
, pncLoggingSwitch = Last $ Just True
}
lastOption :: Parser a -> Parser (Last a)
lastOption parser = fmap Last $ optional parser
lastToEither :: String -> Last a -> Either String a
lastToEither errMsg (Last x) = maybe (Left errMsg) Right x
makeNodeConfiguration :: PartialNodeConfiguration -> Either String NodeConfigurationF
makeNodeConfiguration pnc = do
configFile <- lastToEither "Missing ConfigFile" $ pncConfigFile pnc
topologyFile <- lastToEither "Missing TopologyFile" $ pncTopologyFile pnc
databaseFile <- lastToEither "Missing DatabaseFile" $ pncDatabaseFile pnc
-- socketFile <- lastToEither "Missing SocketFile" $ pncSocketFile pnc
protocolFiles <- lastToEither "Missing ProtocolFiles" $ pncProtocolFiles pnc
validateDB <- lastToEither "Missing ValidateDB" $ pncValidateDB pnc
shutdownIPC <- lastToEither "Missing ShutdownIPC" $ pncShutdownIPC pnc
shutdownOnSlotSynced <- lastToEither "Missing ShutdownOnSlotSynced" $ pncShutdownOnSlotSynced pnc
--pncSocketPath
protocolConfig <- lastToEither "Missing ProtocolConfig" $ pncProtocolConfig pnc
maxConcurrencyBulkSync <- lastToEither "Missing MaxConcurrencyBulkSync" $ pncMaxConcurrencyBulkSync pnc
maxConcurrencyDeadline <- lastToEither "Missing MaxConcurrencyDeadline" $ pncMaxConcurrencyDeadline pnc
viewMode <- lastToEither "Missing ViewMode" $ pncViewMode pnc
loggingSwitch <- lastToEither "Missing LoggingSwitch" $ pncLoggingSwitch pnc
logMetrics <- lastToEither "Missing LogMetrics" $ pncLogMetrics pnc
traceConfig <- lastToEither "Missing TraceConfig" $ pncTraceConfig pnc
return $ NodeConfigurationF
{ ncNodeAddr = getLast $ pncNodeAddr pnc
, ncConfigFile = configFile
, ncTopologyFile = topologyFile
, ncDatabaseFile = databaseFile
, ncProtocolFiles = protocolFiles
, ncValidateDB = validateDB
, ncShutdownIPC = shutdownIPC
, ncShutdownOnSlotSynced = shutdownOnSlotSynced
, ncProtocolConfig = protocolConfig
, ncSocketPath = getLast $ pncSocketPath pnc
, ncMaxConcurrencyBulkSync = maxConcurrencyBulkSync
, ncMaxConcurrencyDeadline = maxConcurrencyDeadline
, ncViewMode = viewMode
, ncLoggingSwitch = loggingSwitch
, ncLogMetrics = logMetrics
, ncTraceConfig = traceConfig
}
parseNodeConfigurationFP :: Maybe ConfigYamlFilePath -> IO PartialNodeConfiguration
parseNodeConfigurationFP Nothing = panic "No configuration yaml filepath provided"
parseNodeConfigurationFP (Just (ConfigYamlFilePath fp)) = do
nc <- decodeFileThrow fp
-- Make all the files be relative to the location of the config file.
pure $ adjustFilePaths (takeDirectory fp </>) nc