-
Notifications
You must be signed in to change notification settings - Fork 957
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[mplex] Refactoring with Patches (#1769)
* Refactor Mplex.
Thereby addressing the following issues:
* Send a `Reset` frame when open substreams get dropped (313).
* Avoid stalls caused by a read operation on one substream
reading (and buffering) frames for another substream without
notifying the corresponding task. I.e. the tracked read-interest
must be scoped to a substream.
* Remove dropped substreams from the tracked set of open
substreams, to avoid artificially running into substream
limits.
* Update CHANGELOG.
* Refine behaviour of dropping substreams.
By taking the substream state into account. The refined
behaviour is modeled after the behaviour of Yamux.
* Tweak docs and recv buffer retention.
* Further small tweaks.
* Make the pending frames a FIFO queue.
* Take more care to avoid keeping read-wakers around
and to notify them when streams close.
* Prefer wake over unregister.
It is probably safer to always wake pending wakers.
* Update muxers/mplex/src/codec.rs
Co-authored-by: Max Inden <mail@max-inden.de>
* Update muxers/mplex/src/io.rs
Co-authored-by: Max Inden <mail@max-inden.de>
* Some review feedback and cosmetics.
* Update muxers/mplex/src/io.rs
Co-authored-by: Max Inden <mail@max-inden.de>
* Revise read control flow for clarity.
While seemingly duplicating some control flow between
`poll_next_strean` and `poll_read_stream`, the individual
control flow of each read operation is easier to follow.
* CI
* Rename Status::Ok to Status::Open.
* Rename pending_flush to pending_flush_open.
* Finishing touches.
* Tweak changelog.
Co-authored-by: Max Inden <mail@max-inden.de>- Loading branch information
Showing
7 changed files
with
1,099 additions
and
607 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| // Copyright 2018 Parity Technologies (UK) Ltd. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a | ||
| // copy of this software and associated documentation files (the "Software"), | ||
| // to deal in the Software without restriction, including without limitation | ||
| // the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||
| // and/or sell copies of the Software, and to permit persons to whom the | ||
| // Software is furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | ||
| // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
| // DEALINGS IN THE SOFTWARE. | ||
|
|
||
| use crate::codec::MAX_FRAME_SIZE; | ||
| use std::cmp; | ||
|
|
||
| /// Configuration for the multiplexer. | ||
| #[derive(Debug, Clone)] | ||
| pub struct MplexConfig { | ||
| /// Maximum number of simultaneously-open substreams. | ||
| pub(crate) max_substreams: usize, | ||
| /// Maximum number of frames in the internal buffer. | ||
| pub(crate) max_buffer_len: usize, | ||
| /// Behaviour when the buffer size limit is reached. | ||
| pub(crate) max_buffer_behaviour: MaxBufferBehaviour, | ||
| /// When sending data, split it into frames whose maximum size is this value | ||
| /// (max 1MByte, as per the Mplex spec). | ||
| pub(crate) split_send_size: usize, | ||
| } | ||
|
|
||
| impl MplexConfig { | ||
| /// Builds the default configuration. | ||
| pub fn new() -> MplexConfig { | ||
| Default::default() | ||
| } | ||
|
|
||
| /// Sets the maximum number of simultaneously open substreams. | ||
| /// | ||
| /// When the limit is reached, opening of outbound substreams | ||
| /// is delayed until another substream closes, whereas new | ||
| /// inbound substreams are immediately answered with a `Reset`. | ||
| /// If the number of inbound substreams that need to be reset | ||
| /// accumulates too quickly (judged by internal bounds), the | ||
| /// connection is closed, the connection is closed with an error | ||
| /// due to the misbehaved remote. | ||
| pub fn max_substreams(&mut self, max: usize) -> &mut Self { | ||
| self.max_substreams = max; | ||
| self | ||
| } | ||
|
|
||
| /// Sets the maximum number of frames buffered that have | ||
| /// not yet been consumed. | ||
| /// | ||
| /// A limit is necessary in order to avoid DoS attacks. | ||
| pub fn max_buffer_len(&mut self, max: usize) -> &mut Self { | ||
| self.max_buffer_len = max; | ||
| self | ||
| } | ||
|
|
||
| /// Sets the behaviour when the maximum buffer length has been reached. | ||
| /// | ||
| /// See the documentation of `MaxBufferBehaviour`. | ||
| pub fn max_buffer_len_behaviour(&mut self, behaviour: MaxBufferBehaviour) -> &mut Self { | ||
| self.max_buffer_behaviour = behaviour; | ||
| self | ||
| } | ||
|
|
||
| /// Sets the frame size used when sending data. Capped at 1Mbyte as per the | ||
| /// Mplex spec. | ||
| pub fn split_send_size(&mut self, size: usize) -> &mut Self { | ||
| let size = cmp::min(size, MAX_FRAME_SIZE); | ||
| self.split_send_size = size; | ||
| self | ||
| } | ||
| } | ||
|
|
||
| /// Behaviour when the maximum length of the buffer is reached. | ||
| #[derive(Debug, Copy, Clone, PartialEq, Eq)] | ||
| pub enum MaxBufferBehaviour { | ||
| /// Produce an error on all the substreams. | ||
| CloseAll, | ||
| /// No new message will be read from the underlying connection if the buffer is full. | ||
| /// | ||
| /// This can potentially introduce a deadlock if you are waiting for a message from a substream | ||
| /// before processing the messages received on another substream. | ||
| Block, | ||
| } | ||
|
|
||
| impl Default for MplexConfig { | ||
| fn default() -> MplexConfig { | ||
| MplexConfig { | ||
| max_substreams: 128, | ||
| max_buffer_len: 4096, | ||
| max_buffer_behaviour: MaxBufferBehaviour::CloseAll, | ||
| split_send_size: 1024, | ||
| } | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.