|
| 1 | +{-# LANGUAGE LambdaCase #-} |
| 2 | +{-# LANGUAGE TypeApplications #-} |
| 3 | + |
| 4 | +{- HLINT ignore "Move brackets to avoid $" -} |
| 5 | + |
| 6 | +module Cardano.CLI.Ping |
| 7 | + ( PingCmd(..) |
| 8 | + , PingClientCmdError(..) |
| 9 | + , renderPingClientCmdError |
| 10 | + , runPingCmd |
| 11 | + , parsePingCmd |
| 12 | + ) where |
| 13 | + |
| 14 | +import Control.Applicative ((<|>)) |
| 15 | +import Control.Concurrent.Class.MonadSTM.Strict (StrictTMVar) |
| 16 | +import qualified Control.Concurrent.Class.MonadSTM.Strict as STM |
| 17 | +import Control.Exception (SomeException) |
| 18 | +import Control.Monad (forM, unless) |
| 19 | +import Control.Monad.Class.MonadAsync (MonadAsync (async, wait, waitCatch)) |
| 20 | +import Control.Monad.IO.Class (liftIO) |
| 21 | +import Control.Monad.Trans.Except (ExceptT) |
| 22 | +import Control.Monad.Trans.Except.Extra (left) |
| 23 | +import Control.Tracer (Tracer (..)) |
| 24 | +import Data.List (foldl') |
| 25 | +import qualified Data.List as L |
| 26 | +import Data.Text (Text) |
| 27 | +import qualified Data.Text as T |
| 28 | +import Data.Word (Word32) |
| 29 | +import Network.Socket (AddrInfo) |
| 30 | +import qualified Network.Socket as Socket |
| 31 | +import qualified Options.Applicative as Opt |
| 32 | +import qualified Prettyprinter as PP |
| 33 | +import qualified System.Exit as IO |
| 34 | +import qualified System.IO as IO |
| 35 | + |
| 36 | +import qualified Cardano.Network.Ping as CNP |
| 37 | + |
| 38 | +newtype PingClientCmdError = PingClientCmdError [(AddrInfo, SomeException)] |
| 39 | + |
| 40 | +data EndPoint = HostEndPoint String | UnixSockEndPoint String deriving (Eq, Show) |
| 41 | + |
| 42 | +maybeHostEndPoint :: EndPoint -> Maybe String |
| 43 | +maybeHostEndPoint = \case |
| 44 | + HostEndPoint host -> Just host |
| 45 | + UnixSockEndPoint _ -> Nothing |
| 46 | + |
| 47 | +maybeUnixSockEndPoint :: EndPoint -> Maybe String |
| 48 | +maybeUnixSockEndPoint = \case |
| 49 | + HostEndPoint _ -> Nothing |
| 50 | + UnixSockEndPoint sock -> Just sock |
| 51 | + |
| 52 | +data PingCmd = PingCmd |
| 53 | + { pingCmdCount :: !Word32 |
| 54 | + , pingCmdEndPoint :: !EndPoint |
| 55 | + , pingCmdPort :: !String |
| 56 | + , pingCmdMagic :: !Word32 |
| 57 | + , pingCmdJson :: !Bool |
| 58 | + , pingCmdQuiet :: !Bool |
| 59 | + } deriving (Eq, Show) |
| 60 | + |
| 61 | +pingClient :: Tracer IO CNP.LogMsg -> Tracer IO String -> PingCmd -> [CNP.NodeVersion] -> AddrInfo -> IO () |
| 62 | +pingClient stdout stderr cmd = CNP.pingClient stdout stderr opts |
| 63 | + where opts = CNP.PingOpts |
| 64 | + { CNP.pingOptsQuiet = pingCmdQuiet cmd |
| 65 | + , CNP.pingOptsJson = pingCmdJson cmd |
| 66 | + , CNP.pingOptsCount = pingCmdCount cmd |
| 67 | + , CNP.pingOptsHost = maybeHostEndPoint (pingCmdEndPoint cmd) |
| 68 | + , CNP.pingOptsUnixSock = maybeUnixSockEndPoint (pingCmdEndPoint cmd) |
| 69 | + , CNP.pingOptsPort = pingCmdPort cmd |
| 70 | + , CNP.pingOptsMagic = pingCmdMagic cmd |
| 71 | + } |
| 72 | + |
| 73 | +runPingCmd :: PingCmd -> ExceptT PingClientCmdError IO () |
| 74 | +runPingCmd options = do |
| 75 | + let hints = Socket.defaultHints { Socket.addrSocketType = Socket.Stream } |
| 76 | + |
| 77 | + msgQueue <- liftIO STM.newEmptyTMVarIO |
| 78 | + |
| 79 | + -- 'addresses' are all the endpoints to connect to and 'versions' are the node protocol versions |
| 80 | + -- to ping with. |
| 81 | + (addresses, versions) <- case pingCmdEndPoint options of |
| 82 | + HostEndPoint host -> do |
| 83 | + addrs <- liftIO $ Socket.getAddrInfo (Just hints) (Just host) (Just (pingCmdPort options)) |
| 84 | + return (addrs, CNP.supportedNodeToNodeVersions $ pingCmdMagic options) |
| 85 | + UnixSockEndPoint fname -> do |
| 86 | + let addr = Socket.AddrInfo |
| 87 | + [] Socket.AF_UNIX Socket.Stream |
| 88 | + Socket.defaultProtocol (Socket.SockAddrUnix fname) Nothing |
| 89 | + return ([addr], CNP.supportedNodeToClientVersions $ pingCmdMagic options) |
| 90 | + |
| 91 | + -- Logger async thread handle |
| 92 | + laid <- liftIO . async $ CNP.logger msgQueue $ pingCmdJson options |
| 93 | + -- Ping client thread handles |
| 94 | + caids <- forM addresses $ liftIO . async . pingClient (Tracer $ doLog msgQueue) (Tracer doErrLog) options versions |
| 95 | + res <- L.zip addresses <$> mapM (liftIO . waitCatch) caids |
| 96 | + liftIO $ doLog msgQueue CNP.LogEnd |
| 97 | + liftIO $ wait laid |
| 98 | + |
| 99 | + -- Collect errors 'es' from failed pings and 'addrs' from successful pings. |
| 100 | + let (es, addrs) = foldl' partition ([],[]) res |
| 101 | + |
| 102 | + -- Report any errors |
| 103 | + case (es, addrs) of |
| 104 | + ([], _) -> liftIO IO.exitSuccess |
| 105 | + (_, []) -> left $ PingClientCmdError es |
| 106 | + (_, _) -> do |
| 107 | + unless (pingCmdQuiet options) $ mapM_ (liftIO . IO.hPrint IO.stderr) es |
| 108 | + liftIO IO.exitSuccess |
| 109 | + |
| 110 | + where |
| 111 | + partition :: ([(AddrInfo, SomeException)], [AddrInfo]) |
| 112 | + -> (AddrInfo, Either SomeException ()) |
| 113 | + -> ([(AddrInfo, SomeException)], [AddrInfo]) |
| 114 | + partition (es, as) (a, Left e) = ((a, e) : es, as) |
| 115 | + partition (es, as) (a, Right _) = (es, a : as) |
| 116 | + |
| 117 | + doLog :: StrictTMVar IO CNP.LogMsg -> CNP.LogMsg -> IO () |
| 118 | + doLog msgQueue msg = STM.atomically $ STM.putTMVar msgQueue msg |
| 119 | + |
| 120 | + doErrLog :: String -> IO () |
| 121 | + doErrLog = IO.hPutStrLn IO.stderr |
| 122 | + |
| 123 | +renderPingClientCmdError :: PingClientCmdError -> Text |
| 124 | +renderPingClientCmdError = \case |
| 125 | + PingClientCmdError es -> T.intercalate "\n" $ T.pack . show <$> es |
| 126 | + |
| 127 | +parsePingCmd :: Opt.Parser PingCmd |
| 128 | +parsePingCmd = Opt.hsubparser $ mconcat |
| 129 | + [ Opt.metavar "ping" |
| 130 | + , Opt.command "ping" $ Opt.info pPing $ Opt.progDescDoc $ Just $ mconcat |
| 131 | + [ PP.pretty @String "Ping a cardano node either using node-to-node or node-to-client protocol. " |
| 132 | + , PP.pretty @String "It negotiates a handshake and keeps sending keep alive messages." |
| 133 | + ] |
| 134 | + ] |
| 135 | + |
| 136 | +pHost :: Opt.Parser String |
| 137 | +pHost = |
| 138 | + Opt.strOption $ mconcat |
| 139 | + [ Opt.long "host" |
| 140 | + , Opt.short 'h' |
| 141 | + , Opt.metavar "HOST" |
| 142 | + , Opt.help "Hostname/IP, e.g. relay.iohk.example." |
| 143 | + ] |
| 144 | + |
| 145 | +pUnixSocket :: Opt.Parser String |
| 146 | +pUnixSocket = |
| 147 | + Opt.strOption $ mconcat |
| 148 | + [ Opt.long "unixsock" |
| 149 | + , Opt.short 'u' |
| 150 | + , Opt.metavar "SOCKET" |
| 151 | + , Opt.help "Unix socket, e.g. file.socket." |
| 152 | + ] |
| 153 | + |
| 154 | +pEndPoint :: Opt.Parser EndPoint |
| 155 | +pEndPoint = fmap HostEndPoint pHost <|> fmap UnixSockEndPoint pUnixSocket |
| 156 | + |
| 157 | +pPing :: Opt.Parser PingCmd |
| 158 | +pPing = PingCmd |
| 159 | + <$> ( Opt.option Opt.auto $ mconcat |
| 160 | + [ Opt.long "count" |
| 161 | + , Opt.short 'c' |
| 162 | + , Opt.metavar "COUNT" |
| 163 | + , Opt.help $ mconcat |
| 164 | + [ "Stop after sending count requests and receiving count responses. " |
| 165 | + , "If this option is not specified, ping will operate until interrupted. " |
| 166 | + ] |
| 167 | + , Opt.value maxBound |
| 168 | + ] |
| 169 | + ) |
| 170 | + <*> pEndPoint |
| 171 | + <*> ( Opt.strOption $ mconcat |
| 172 | + [ Opt.long "port" |
| 173 | + , Opt.short 'p' |
| 174 | + , Opt.metavar "PORT" |
| 175 | + , Opt.help "Port number, e.g. 1234." |
| 176 | + , Opt.value "3001" |
| 177 | + ] |
| 178 | + ) |
| 179 | + <*> ( Opt.option Opt.auto $ mconcat |
| 180 | + [ Opt.long "magic" |
| 181 | + , Opt.short 'm' |
| 182 | + , Opt.metavar "MAGIC" |
| 183 | + , Opt.help "Network magic." |
| 184 | + , Opt.value CNP.mainnetMagic |
| 185 | + ] |
| 186 | + ) |
| 187 | + <*> ( Opt.switch $ mconcat |
| 188 | + [ Opt.long "json" |
| 189 | + , Opt.short 'j' |
| 190 | + , Opt.help "JSON output flag." |
| 191 | + ] |
| 192 | + ) |
| 193 | + <*> ( Opt.switch $ mconcat |
| 194 | + [ Opt.long "quiet" |
| 195 | + , Opt.short 'q' |
| 196 | + , Opt.help "Quiet flag, CSV/JSON only output" |
| 197 | + ] |
| 198 | + ) |
0 commit comments