nim-libp2p/libp2p/switch.nim

204 lines
6.9 KiB
Nim
Raw Normal View History

2019-08-27 21:46:12 +00:00
## Nim-LibP2P
## Copyright (c) 2018 Status Research & Development GmbH
## Licensed under either of
## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
## * MIT license ([LICENSE-MIT](LICENSE-MIT))
## at your option.
## This file may not be copied, modified, or distributed except according to
## those terms.
2019-09-04 22:00:39 +00:00
import tables, sequtils, options, strformat
2019-08-27 21:46:12 +00:00
import chronos
2019-09-06 07:13:47 +00:00
import connection,
transports/transport,
2019-09-01 17:31:24 +00:00
stream/lpstream,
2019-09-06 07:13:47 +00:00
multistream,
protocols/protocol,
protocols/secure,
peerinfo,
multiaddress,
protocols/identify,
muxers/muxer,
2019-09-08 06:34:08 +00:00
peer,
helpers/debug
type
Switch* = ref object of RootObj
2019-08-30 05:17:07 +00:00
peerInfo*: PeerInfo
connections*: TableRef[string, Connection]
2019-09-04 22:00:39 +00:00
muxed*: TableRef[string, Muxer]
2019-08-30 05:17:07 +00:00
transports*: seq[Transport]
protocols*: seq[LPProtocol]
2019-09-04 22:00:39 +00:00
muxers*: Table[string, MuxerProvider]
2019-08-30 05:17:07 +00:00
ms*: MultisteamSelect
2019-09-04 01:50:17 +00:00
identity*: Identify
2019-09-06 07:13:47 +00:00
streamHandler*: StreamHandler
secureManager*: Secure
2019-08-27 21:46:12 +00:00
2019-09-06 07:13:47 +00:00
proc secure(s: Switch, conn: Connection): Future[Connection] {.async, gcsafe.} =
## secure the incoming connection
2019-09-04 22:00:39 +00:00
2019-09-06 07:13:47 +00:00
# plaintext for now, doesn't do anything
if not (await s.ms.select(conn, s.secureManager.codec)):
raise newException(CatchableError, "Unable to negotiate a secure channel!")
2019-09-04 01:50:17 +00:00
2019-09-06 07:13:47 +00:00
result = conn
2019-08-31 17:58:49 +00:00
2019-09-04 22:00:39 +00:00
proc identify(s: Switch, conn: Connection) {.async, gcsafe.} =
2019-09-04 01:50:17 +00:00
## identify the connection
2019-09-06 07:13:47 +00:00
# s.peerInfo.protocols = await s.ms.list(conn) # update protos before engagin in identify
try:
if (await s.ms.select(conn, s.identity.codec)):
let info = await s.identity.identify(conn, conn.peerInfo)
let id = if conn.peerInfo.isSome:
conn.peerInfo.get().peerId.pretty
else:
""
if id.len > 0 and s.connections.contains(id):
let connection = s.connections[id]
var peerInfo = conn.peerInfo.get()
peerInfo.peerId = PeerID.init(info.pubKey) # we might not have a peerId at all
peerInfo.addrs = info.addrs
peerInfo.protocols = info.protos
2019-09-08 07:43:33 +00:00
debug &"identify: identified remote peer {peerInfo.peerId.pretty}"
2019-09-06 07:13:47 +00:00
except IdentityInvalidMsgError as exc:
2019-09-08 06:34:08 +00:00
debug exc.msg
2019-09-06 07:13:47 +00:00
except IdentityNoMatchError as exc:
2019-09-08 06:34:08 +00:00
debug exc.msg
2019-09-06 07:13:47 +00:00
2019-09-08 07:43:33 +00:00
proc mux(s: Switch, conn: Connection): Future[void] {.async, gcsafe.} =
2019-09-04 01:50:17 +00:00
## mux incoming connection
2019-09-04 22:00:39 +00:00
let muxers = toSeq(s.muxers.keys)
let muxerName = await s.ms.select(conn, muxers)
2019-09-06 07:13:47 +00:00
if muxerName.len == 0 or muxerName == "na":
2019-09-04 22:00:39 +00:00
return
let muxer = s.muxers[muxerName].newMuxer(conn)
# install stream handler
2019-09-06 07:13:47 +00:00
muxer.streamHandler = s.streamHandler
2019-09-04 22:00:39 +00:00
# do identify first, so that we have a
# PeerInfo in case we didn't before
2019-09-08 07:43:33 +00:00
let stream = await muxer.newStream()
let handlerFut = muxer.handle()
# add muxer handler cleanup proc
handlerFut.addCallback(
proc(udata: pointer = nil) {.gcsafe.} =
if handlerFut.finished:
debug &"Muxer handler completed for peer {conn.peerInfo.get().peerId.pretty}"
)
await s.identify(stream)
await stream.close() # close idenity stream
2019-09-08 06:34:08 +00:00
2019-09-05 15:19:39 +00:00
# store it in muxed connections if we have a peer for it
# TODO: We should make sure that this are cleaned up properly
# on exit even if there is no peer for it. This shouldn't
# happen once secio is in place, but still something to keep
# in mind
2019-09-04 22:00:39 +00:00
if conn.peerInfo.isSome:
s.muxed[conn.peerInfo.get().peerId.pretty] = muxer
proc handleConn(s: Switch, conn: Connection): Future[Connection] {.async, gcsafe.} =
2019-09-06 07:13:47 +00:00
result = conn
2019-09-04 01:50:17 +00:00
## perform upgrade flow
2019-09-06 07:13:47 +00:00
if result.peerInfo.isSome:
let id = result.peerInfo.get().peerId.pretty
2019-09-04 22:00:39 +00:00
if s.connections.contains(id):
# if we already have a connection for this peer,
# close the incoming connection and return the
# existing one
2019-09-06 07:13:47 +00:00
await result.close()
2019-09-04 22:00:39 +00:00
return s.connections[id]
2019-09-06 07:13:47 +00:00
s.connections[id] = result
2019-09-04 22:00:39 +00:00
2019-09-06 07:13:47 +00:00
result = await s.secure(conn) # secure the connection
2019-09-08 07:43:33 +00:00
await s.mux(result) # mux it if possible
2019-09-04 22:00:39 +00:00
proc cleanupConn(s: Switch, conn: Connection) {.async, gcsafe.} =
let id = if conn.peerInfo.isSome: conn.peerInfo.get().peerId.pretty else: ""
if conn.peerInfo.isSome:
if s.muxed.contains(id):
await s.muxed[id].close
if s.connections.contains(id):
await s.connections[id].close()
2019-09-04 01:50:17 +00:00
2019-09-05 15:19:39 +00:00
proc dial*(s: Switch,
peer: PeerInfo,
proto: string = ""):
Future[Connection] {.async.} =
2019-08-31 17:58:49 +00:00
for t in s.transports: # for each transport
for a in peer.addrs: # for each address
if t.handles(a): # check if it can dial it
2019-09-06 07:13:47 +00:00
result = await t.dial(a)
result.peerInfo = some(peer)
result = await s.handleConn(result)
2019-09-08 07:43:33 +00:00
# if there is a muxer for the connection
# use it instead to create a muxed stream
2019-09-04 22:00:39 +00:00
if s.muxed.contains(peer.peerId.pretty):
2019-09-06 07:13:47 +00:00
result = await s.muxed[peer.peerId.pretty].newStream()
2019-09-08 07:43:33 +00:00
debug &"dial: attempting to select remote proto {proto}"
2019-09-08 06:34:08 +00:00
if not (await s.ms.select(result, proto)):
2019-09-08 07:43:33 +00:00
debug &"dial: Unable to select protocol: {proto}"
2019-08-31 18:52:56 +00:00
raise newException(CatchableError,
2019-09-04 22:00:39 +00:00
&"Unable to select protocol: {proto}")
2019-08-27 21:46:12 +00:00
2019-09-06 07:13:47 +00:00
proc mount*[T: LPProtocol](s: Switch, proto: T) {.gcsafe.} =
2019-08-31 17:58:49 +00:00
if isNil(proto.handler):
raise newException(CatchableError,
"Protocol has to define a handle method or proc")
2019-08-27 21:46:12 +00:00
2019-09-06 07:13:47 +00:00
if proto.codec.len == 0:
2019-08-31 18:52:56 +00:00
raise newException(CatchableError,
"Protocol has to define a codec string")
2019-08-31 17:58:49 +00:00
s.ms.addHandler(proto.codec, proto)
2019-08-28 02:30:53 +00:00
proc start*(s: Switch) {.async.} =
2019-08-31 18:52:56 +00:00
proc handle(conn: Connection): Future[void] {.async, closure, gcsafe.} =
2019-09-04 22:00:39 +00:00
try:
2019-09-06 07:13:47 +00:00
if (await s.ms.select(conn)):
await s.ms.handle(conn) # handle incoming connection
2019-09-04 22:00:39 +00:00
except:
await s.cleanupConn(conn)
2019-08-27 21:46:12 +00:00
2019-08-28 02:30:53 +00:00
for t in s.transports: # for each transport
for a in s.peerInfo.addrs:
if t.handles(a): # check if it handles the multiaddr
await t.listen(a, handle) # listen for incoming connections
2019-08-27 21:46:12 +00:00
2019-08-28 02:30:53 +00:00
proc stop*(s: Switch) {.async.} =
2019-08-31 17:58:49 +00:00
await allFutures(s.transports.mapIt(it.close()))
2019-09-06 07:13:47 +00:00
proc newSwitch*(peerInfo: PeerInfo,
transports: seq[Transport],
identity: Identify,
muxers: Table[string, MuxerProvider]): Switch =
new result
result.peerInfo = peerInfo
result.ms = newMultistream()
result.transports = transports
result.connections = newTable[string, Connection]()
result.muxed = newTable[string, Muxer]()
result.identity = identity
result.muxers = muxers
let s = result # can't capture result
result.streamHandler = proc(stream: Connection) {.async, gcsafe.} =
# TODO: figure out proper way of handling this.
# Perhaps it's ok to discard this Future and handle
# errors elsewere?
await s.ms.handle(stream) # handle incoming connection
result.mount(identity)
for key, val in muxers:
val.streamHandler = result.streamHandler
result.mount(val)
result.secureManager = Secure(newPlainText())
result.mount(result.secureManager)