fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-05-01 05:32:19 +00:00
Code Issues Projects Releases Wiki Activity

docs/coding-guidelines: Document limit on number of tasks (#2839)

Browse Source 
Add guideline to limit number of tasks being spawned.
This commit is contained in:
Max Inden 2022-08-26 09:02:14 +02:00 committed by GitHub
parent ca07ce4d64
commit a3dec471c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/coding-guidelines.md
View File

@ -10,6 +10,7 @@
- [Bound everything](#bound-everything) - [Bound everything](#bound-everything)
- [Channels](#channels) - [Channels](#channels)
- [Local queues](#local-queues) - [Local queues](#local-queues)
- [Tasks](#tasks)
- [Further reading](#further-reading) - [Further reading](#further-reading)
- [No premature optimizations](#no-premature-optimizations) - [No premature optimizations](#no-premature-optimizations)
- [Keep things sequential unless proven to be slow](#keep-things-sequential-unless-proven-to-be-slow) - [Keep things sequential unless proven to be slow](#keep-things-sequential-unless-proven-to-be-slow)
@ -201,6 +202,19 @@ growth and high latencies.
Note that rust-libp2p fails at this guideline, i.e. still has many unbounded Note that rust-libp2p fails at this guideline, i.e. still has many unbounded
local queues. local queues.
### Tasks
Bound the number of
[tasks](https://docs.rs/futures/latest/futures/task/index.html) being spawned.
As an example, say we spawn one task per incoming request received from a
socket. If the number of pending requests is not bounded by some limit, a
misbehaving or malicious remote peer can send requests at a higher rate than the
local node can respond at. This results in unbounded growth in the number of
requests, and thus unbounded growth in the number of tasks and used memory.
Simply put, rust-libp2p spawns one task per connection but limits the overall
number of connections, thus adhering to this guideline.
### Further reading ### Further reading
- https://en.wikipedia.org/wiki/Bufferbloat - https://en.wikipedia.org/wiki/Bufferbloat