1
0
Fork 0
mirror of https://gitee.com/fantix/kloop.git synced 2024-10-31 15:38:51 +00:00
kloop/README.md
2022-06-26 11:48:32 -04:00

54 lines
2.1 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# kLoop
[中文](README.zh.md)
kLoop is an implementation of the Python
[asyncio](https://docs.python.org/3/library/asyncio.html) event loop written
in [Cython](https://cython.org/), using
[io_uring](https://unixism.net/loti/what_is_io_uring.html) and
[kTLS](https://www.kernel.org/doc/html/latest/networking/tls-offload.html)
features of the Linux kernel, therefore called k(ernel)Loop.
kLoop is open-sourced and released under the
[MulanPSL - 2.0 license](http://license.coscl.org.cn/MulanPSL2).
**WARNING: THIS PROJECT IS IN PROOF-OF-CONCEPT STAGE!⚠️**
## Features
* **Minimum syscalls** - all I/O calls are done in the kernel thanks to
io_uring, and the only remaining syscall to `io_uring_enter()` is also
optimized to be only called when necessary using the `SQPOLL` feature. That
means most of the overhead of syscalls is gone;
* **No GIL in the main-loop** - the hot-path is written in Cython without GIL,
that means it's compiled into pure C code without Python structures, saving
some memory and execution time. On the other hand, GIL is only taken before
Python callbacks, so it's slightly more friendly to multithreading, which is
still not recommended though.
* **TLS offloading** - all symmetric-key encryption and decryption work is
offloaded to the NIC if supported, or to the thread pool of io_uring
otherwise. This allows us to free up CPU for more I/O, or leverage all the
CPU cores even if the application is running single-threaded.
* **Asynchronous DNS resolving** - we blended in the Rust
[trust-dns](https://github.com/bluejekyll/trust-dns/) library with a custom
I/O runtime bridging to io_uring in C (including reading the
`/etc/resolv.conf` and `/etc/hosts` files), providing flexible APIs to manage
the concurrency, cache and configuration in Python.
## Requirements
* Python >= 3.10
* Linux >= 5.11 (enable kTLS with `modprobe tls`)
* OpenSSL >= 3.0 (kTLS receive offloading requires the latest development
version)
Development and testing is done on Ubuntu 22.04.
## Architecture Diagram
![architecture.png](architecture.en.png)
Looks like the Lucky Charms factory, says @aaronbrighton ...