unit-rs

unit-rs is a safe wrapper around the libunit.a C library from NGINX Unit which allows creating Unit applications in Rust.

Example

Add unit-rs as a dependency:

[dependencies]
unit-rs = "0.2"

And add the following to src/main.rs:

use unit_rs::{Unit, Request};

fn main() {
    let mut unit = Unit::new().unwrap();

    unit.set_request_handler(|req: Request<'_>| {
        let headers = &[("Content-Type", "text/plain")];
        let body = "Hello world!\n";
        req.send_response(200, headers, body)?;

        Ok(())
    });

    unit.run();
}

Once compiled, a running NGINX Unit server can be configured to use it with an external application pointing to the binary's path:

{
  "listeners": {
      "*:8080": {
          "pass": "applications/rustapp"
      }
  },
  "applications": {
      "rustapp": {
          "type": "external",
          "working_directory": "/path/to/package",
          "executable": "/path/to/package/hello_world",
          "processes": 4
      }
  }
}

See the examples/request_info.rs example for a more in-depth example, and the deploy.sh script for an example curl command.

Features

Currently not all features are supported, but enough are available to inspect all aspects of a request and create a response.

This library is also capable of multi-threading by creating additional instances of Unit objects.

When the http feature enabled, the http::HttpHandler adapter can be used to write handlers using types from the http crate.

Missing features

Support for WebSockets is not yet implemented.

A callback for inspecting a request header (and potentially closing the request) before Unit buffers the whole request body is not yet available.

There is currently no way to perform asynchronous handling of requests. Handlers with expensive computations or blocking IO will block the whole thread context.

Requests with non-UTF8 paths or fields in their header will cause the request handler to panic.

There is no way to gracefully cancel other Unit threads when a single thread panics. This may be mitigated by using multiple processes instead of threads.

Building

In order to build, the library requires libclang (needed by bindgen) and unit-dev (which provides libunit.a and its headers).

Most distributions will have a libclang-dev package (or similar), while unit-dev must be installed from Unit's own repositories linked in their installation guide.

Note that NGINX Unit requires the server and applicaton to have the same version; an application compiled with a libunit from an older or newer version of NGINX Unit will not work.

Safety

unit-rs attempts to be a safe wrapper by making all invalid uses of the libunit APIs impossible, and preventing all undefined behavior.

Some of this is achieved at the expense of some runtime performance, using Rust's mandatory bounds-checking for all arrays.

For example, applications using unit-rs will experience runtime panics when:

Reading more bytes from a request than available
Writing more bytes to a response than allocated

However, Rust's type system also allows for many compile-time guarantees. When using unit-rs, the following become either compile-time errors or impossible to express:

Moving Unit contexts or sharing request data between threads
Accessing more fields/headers than available
Storing pointers to request data in variables that outlive the request handler function
Storing pointers to or into a shared memory buffer in variables that outlive the buffer
Sending a shared memory buffer that was already sent
Sending uninitialized shared memory regions
Forgetting to drop a shared memory buffer

Through the use of a global mutex, unit-rs will also ensure that any additional multi-threaded Unit contexts will be spawned from a primary context, and that the primary context outlives all secondary contexts.

Benchmarks

A test on a Ryzen 7 CPU with the wrk benchmarking tool shows Unit reaching ~250000 requests per second, mostly maxing out on the Unit server and the wrk tool itself.

For comparison, a classic Nginx server serving static files reached ~200000 requests per second (although note that the classic Nginx has significantly more features).

andreivasiliu / unit-rs