nim-libp2p/libp2p/muxers/mplex/mplex.nim

228 lines
8.0 KiB
Nim
Raw Normal View History

2019-09-03 20:40:51 +00:00
## Nim-LibP2P
2019-09-24 17:48:23 +00:00
## Copyright (c) 2019 Status Research & Development GmbH
2019-09-03 20:40:51 +00:00
## 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.
import tables, sequtils, oids
2020-06-03 02:21:11 +00:00
import chronos, chronicles, stew/byteutils
import ../muxer,
../../connection,
../../stream/lpstream,
../../stream/bufferstream,
../../utility,
../../errors,
coder,
types,
lpchannel
2019-09-03 20:40:51 +00:00
2019-09-10 02:15:52 +00:00
logScope:
2019-09-12 02:10:38 +00:00
topic = "Mplex"
2019-09-10 02:15:52 +00:00
2019-09-04 03:08:51 +00:00
type
2019-09-03 20:40:51 +00:00
Mplex* = ref object of Muxer
remote: Table[uint64, LPChannel]
local: Table[uint64, LPChannel]
2020-05-23 16:50:05 +00:00
conns: seq[Connection]
handlerFuts: seq[Future[void]]
2020-03-23 17:14:06 +00:00
currentId*: uint64
maxChannels*: uint64
isClosed: bool
when chronicles.enabledLogLevel == LogLevel.TRACE:
oid*: Oid
2019-09-03 20:40:51 +00:00
2020-03-23 17:14:06 +00:00
proc getChannelList(m: Mplex, initiator: bool): var Table[uint64, LPChannel] =
2019-09-04 01:42:00 +00:00
if initiator:
trace "picking local channels", initiator = initiator, oid = m.oid
2019-09-03 20:40:51 +00:00
result = m.local
else:
trace "picking remote channels", initiator = initiator, oid = m.oid
result = m.remote
2019-09-03 20:40:51 +00:00
2019-09-04 01:42:00 +00:00
proc newStreamInternal*(m: Mplex,
initiator: bool = true,
2020-03-23 17:14:06 +00:00
chanId: uint64 = 0,
name: string = "",
lazy: bool = false):
Future[LPChannel] {.async, gcsafe.} =
2019-09-03 20:40:51 +00:00
## create new channel/stream
2020-05-23 19:25:53 +00:00
let id = if initiator:
m.currentId.inc(); m.currentId
else: chanId
trace "creating new channel", channelId = id,
initiator = initiator,
name = name,
oid = m.oid
result = newChannel(id,
m.connection,
initiator,
name,
lazy = lazy)
2019-09-04 01:42:00 +00:00
m.getChannelList(initiator)[id] = result
2019-09-03 20:40:51 +00:00
method handle*(m: Mplex) {.async, gcsafe.} =
trace "starting mplex main loop", oid = m.oid
try:
2020-05-25 14:33:24 +00:00
try:
while not m.connection.closed:
trace "waiting for data", oid = m.oid
let (id, msgType, data) = await m.connection.readMsg()
trace "read message from connection", id = id,
msgType = msgType,
data = data.shortLog,
oid = m.oid
let initiator = bool(ord(msgType) and 1)
var channel: LPChannel
if MessageType(msgType) != MessageType.New:
let channels = m.getChannelList(initiator)
if id notin channels:
trace "Channel not found, skipping", id = id,
initiator = initiator,
msg = msgType,
oid = m.oid
continue
channel = channels[id]
case msgType:
of MessageType.New:
2020-06-03 02:21:11 +00:00
let name = string.fromBytes(data)
2020-05-25 14:33:24 +00:00
channel = await m.newStreamInternal(false, id, name)
trace "created channel", id = id,
name = name,
inititator = channel.initiator,
channoid = channel.oid,
oid = m.oid
if not isNil(m.streamHandler):
let stream = newConnection(channel)
m.conns.add(stream)
stream.peerInfo = m.connection.peerInfo
var fut = newFuture[void]()
proc handler() {.async.} =
try:
await m.streamHandler(stream)
except CatchableError as exc:
trace "exception in stream handler", exc = exc.msg
finally:
m.conns.keepItIf(it != stream)
m.handlerFuts.keepItIf(it != fut)
fut = handler()
of MessageType.MsgIn, MessageType.MsgOut:
trace "pushing data to channel", id = id,
initiator = initiator,
2020-02-12 14:37:22 +00:00
msgType = msgType,
2020-05-25 14:33:24 +00:00
size = data.len,
name = channel.name,
channoid = channel.oid,
oid = m.oid
2020-05-25 14:33:24 +00:00
if data.len > MaxMsgSize:
raise newLPStreamLimitError()
await channel.pushTo(data)
of MessageType.CloseIn, MessageType.CloseOut:
trace "closing channel", id = id,
initiator = initiator,
msgType = msgType,
name = channel.name,
channoid = channel.oid,
oid = m.oid
await channel.closeRemote()
m.getChannelList(initiator).del(id)
trace "deleted channel", id = id,
initiator = initiator,
msgType = msgType,
name = channel.name,
channoid = channel.oid,
oid = m.oid
of MessageType.ResetIn, MessageType.ResetOut:
trace "resetting channel", id = id,
initiator = initiator,
msgType = msgType,
name = channel.name,
channoid = channel.oid,
oid = m.oid
await channel.reset()
m.getChannelList(initiator).del(id)
trace "deleted channel", id = id,
initiator = initiator,
msgType = msgType,
name = channel.name,
channoid = channel.oid,
oid = m.oid
break
finally:
trace "stopping mplex main loop", oid = m.oid
await m.close()
except CatchableError as exc:
trace "Exception occurred", exception = exc.msg, oid = m.oid
2019-09-03 20:40:51 +00:00
proc newMplex*(conn: Connection,
2019-09-03 20:40:51 +00:00
maxChanns: uint = MaxChannels): Mplex =
new result
result.connection = conn
result.maxChannels = maxChanns
2020-03-23 17:14:06 +00:00
result.remote = initTable[uint64, LPChannel]()
result.local = initTable[uint64, LPChannel]()
2019-09-03 20:40:51 +00:00
when chronicles.enabledLogLevel == LogLevel.TRACE:
result.oid = genOid()
proc cleanupChann(m: Mplex, chann: LPChannel) {.async, inline.} =
## remove the local channel from the internal tables
##
await chann.closeEvent.wait()
if not isNil(chann):
m.getChannelList(true).del(chann.id)
trace "cleaned up channel", id = chann.id
2020-02-12 14:37:22 +00:00
method newStream*(m: Mplex,
name: string = "",
lazy: bool = false): Future[Connection] {.async, gcsafe.} =
let channel = await m.newStreamInternal(lazy = lazy)
if not lazy:
await channel.open()
2019-09-04 01:42:00 +00:00
result = newConnection(channel)
2019-09-11 19:04:27 +00:00
result.peerInfo = m.connection.peerInfo
2019-09-03 20:40:51 +00:00
asyncCheck m.cleanupChann(channel)
method close*(m: Mplex) {.async, gcsafe.} =
if m.isClosed:
return
2020-05-27 20:46:25 +00:00
try:
trace "closing mplex muxer", oid = m.oid
let channs = toSeq(m.remote.values) &
toSeq(m.local.values)
for chann in channs:
try:
await chann.reset()
except CatchableError as exc:
warn "error resetting channel", exc = exc.msg
for conn in m.conns:
try:
await conn.close()
except CatchableError as exc:
warn "error closing channel's connection"
checkFutures(
await allFinished(m.handlerFuts))
2020-05-27 20:46:25 +00:00
2020-05-25 14:33:24 +00:00
await m.connection.close()
finally:
2020-05-27 20:46:25 +00:00
m.remote.clear()
m.local.clear()
m.conns = @[]
m.handlerFuts = @[]
m.isClosed = true