MagicStack / MagicStack/uvloop
Using vectorized IO (scatter/gather)
Nobody has claimed this yet.
- Dominant language
- Cython
- Stars
- 11.9k
- Forks
- 616
- PR merge metrics
- No merged PRs in 30d
Description
Operations like `writelines` in [the Stream]( https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.writelines ) and [the Transport]( https://docs.python.org/3/library/asyncio-protocol.html?highlight=writelines#asyncio.WriteTransport.writelines ) APIs provide library authors the opportunity to send collections of buffers that they would like written, sent, etc. in one go. This can be really handy as it takes only one pass (as opposed to multiple passes) through layers of code to prepare buffers before they go out.
Many OSes supply similar C-level operations like [`writev` on POSIX compatible or similar on Windows]( https://en.wikipedia.org/wiki/Vectored_I/O ) for operating on file descriptors. Similarly [`sendmsg` on Linux and Unix]( https://linux.die.net/man/3/sendmsg ) or [`WSASend` on Windows]( https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasend ) provide implementations for sockets.
Admittedly am not very familiar with `libuv`'s API (so maybe devs here can comment on this), but it appears there are some APIs in `libuv` like [`uv_write`]( http://docs.libuv.org/en/v1.x/stream.html#c.uv_write ) can take multiple buffers, which can [internally redirect]( https://github.com/libuv/libuv/blob/285a5ea819035ff777b8b7c6a367f3f5b55d8809/src/unix/udp.c#L728 ) to [`sendmsg`]( https://github.com/libuv/libuv/blob/285a5ea819035ff777b8b7c6a367f3f5b55d8809/src/unix/udp.c#L448 ) or [`WSASend`]( https://github.com/libuv/libuv/blob/4ddc292774be827a297449e2d5ef4047c85de7ca/src/win/tcp.c#L934 ). This also appears to be true for files with the [`uv_fs_write`]( http://docs.libuv.org/en/v1.x/fs.html#c.uv_fs_write ) API.
AFAICT (and I could be wrong about this) `uvloop`'s `writelines` for Streams calls an internal [`_write` function in a loop]( https://github.com/MagicStack/uvloop/blob/70cafc82ccfc660c52ed2e31d9e36dfb3afe5c9d/uvloop/handles/stream.pyx#L692-L693 ), which could [write one entire buffer (if it is sufficiently large, etc.)]( https://github.com/MagicStack/uvloop/blob/70cafc82ccfc660c52ed2e31d9e36dfb3afe5c9d/uvloop/handles/stream.pyx#L433 ) or at least [queue a write]( https://github.com/MagicStack/uvloop/blob/70cafc82ccfc660c52ed2e31d9e36dfb3afe5c9d/uvloop/handles/stream.pyx#L449 ). Please correct me if I'm misunderstanding anything here.
However given libuv's own propensity to use scatter/gather IO under-the-hood, it might be worth holding off on queuing write operations until all of the buffers in `writelines` are collected and prepped. This would allow one larger send, write, etc. to occur and if it is above the high watermark for any buffer (likely?), no additional buffer prepping would be necessary either.
**Side note:** A separate interesting question would be doing something similar for reading. Not sure there is an API that could leverage this currently (may be wrong about this though). Maybe through pausing and resuming reading one could get close (though likely still leaves something on the table)?
**Note:** There may be similar optimizations possible in [asyncio]( https://bugs.python.org/issue40007 ) ( https://github.com/python/asyncio/pull/339 ) ( https://github.com/python/cpython/pull/19062 )
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with uvloop/handles/stream.pyx around the referenced writelines and _write lines, then inspect the linked libuv uv_write, uv_fs_write, sendmsg, and WSASend APIs. Determine whether collecting writelines buffers can enable one vectorized operation and define the resulting scope and completion criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- networking, performance
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100