Initial commitv0.1.0

libunit-wasm and example C and Rust WebAssembly modules for NGINX Unit.

Co-developed-by: Timo Stark <t.stark@nginx.com>
Co-developed-by: Liam Crilly <liam@nginx.com>
Signed-off-by: Andrew Clayton <a.clayton@nginx.com>

6 files changed, 375 insertions, 0 deletions

diff --git a/examples/rust/.gitignore b/examples/rust/.gitignore
new file mode 100644
index 0000000..559d663
--- /dev/null
+++ b/examples/rust/.gitignore
@@ -0,0 +1,3 @@
+Cargo.lock
+
+target/
diff --git a/examples/rust/Makefile b/examples/rust/Makefile
new file mode 100644
index 0000000..b41bc33
--- /dev/null
+++ b/examples/rust/Makefile
@@ -0,0 +1,17 @@
+include ../../shared.mk
+
+SDIR = examples/rust
+
+examples: rust-echo-request rust-upload-reflector
+
+rust-echo-request: echo-request/Cargo.toml echo-request/src/lib.rs
+	$(PP_GEN) $(SDIR)/echo-request/target/wasm32-wasi/
+	$(v)cd echo-request; cargo build --target=wasm32-wasi
+
+rust-upload-reflector: upload-reflector/Cargo.toml upload-reflector/src/lib.rs
+	$(PP_GEN) $(SDIR)/upload-reflector/target/wasm32-wasi/
+	$(v)cd upload-reflector; cargo build --target=wasm32-wasi
+
+clean:
+	rm -f echo-request/Cargo.lock upload-reflector/Cargo.lock
+	rm -rf echo-request/target upload-reflector/target
diff --git a/examples/rust/echo-request/Cargo.toml b/examples/rust/echo-request/Cargo.toml
new file mode 100644
index 0000000..256242e
--- /dev/null
+++ b/examples/rust/echo-request/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "rust-echo-request"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+unit-wasm = { path = "../../../src/rust", version = "0.1.0-beta" }
+
+[lib]
+crate-type = ["cdylib"]
diff --git a/examples/rust/echo-request/src/lib.rs b/examples/rust/echo-request/src/lib.rs
new file mode 100644
index 0000000..4802cff
--- /dev/null
+++ b/examples/rust/echo-request/src/lib.rs
@@ -0,0 +1,200 @@
+/* SPDX-License-Identifier: Apache-2.0 */
+
+/*
+ * Copyright (C) Andrew Clayton
+ * Copyright (C) Timo Stark
+ * Copyright (C) F5, Inc.
+ */
+
+// Include RAW FFI Bindings.
+// @todo: Replace this with the new native Rust API
+use unit_wasm::ffi::*;
+
+use std::ffi::CStr;
+use std::os::raw::c_char;
+use std::os::raw::c_void;
+use std::ptr;
+
+// Buffer of some size to store the copy of the request
+static mut REQUEST_BUF: *mut u8 = ptr::null_mut();
+
+#[no_mangle]
+pub extern "C" fn luw_module_end_handler() {
+    unsafe {
+        luw_free(REQUEST_BUF as *mut c_void);
+    }
+}
+
+#[no_mangle]
+pub extern "C" fn luw_module_init_handler() {
+    unsafe {
+        REQUEST_BUF = luw_malloc(luw_mem_get_init_size().try_into().unwrap())
+            as *mut u8;
+    }
+}
+
+pub extern "C" fn hdr_iter_func(
+    ctx: *mut luw_ctx_t,
+    name: *const c_char,
+    value: *const c_char,
+    _data: *mut c_void,
+) -> bool {
+    unsafe {
+        luw_mem_writep(
+            ctx,
+            "%s = %s\n\0".as_ptr() as *const c_char,
+            name,
+            value,
+        );
+    }
+
+    return true;
+}
+
+#[no_mangle]
+pub extern "C" fn luw_request_handler(addr: *mut u8) -> i32 {
+    // Need a initalization
+    //
+    // It sucks that rust needs this, this is supposed to be
+    // an opaque structure and the structure is 0-initialised
+    // in luw_init_ctx();
+    let mut ctx_: luw_ctx_t = luw_ctx_t {
+        addr: ptr::null_mut(),
+        mem: ptr::null_mut(),
+        req: ptr::null_mut(),
+        resp: ptr::null_mut(),
+        resp_hdr: ptr::null_mut(),
+        resp_offset: 0,
+        req_buf: ptr::null_mut(),
+        hdrp: ptr::null_mut(),
+        reqp: ptr::null_mut(),
+    };
+    let ctx: *mut luw_ctx_t = &mut ctx_;
+
+    unsafe {
+        // Initialise the context structure.
+        //
+        // addr is the address of the previously allocated memory shared
+        // between the module and unit.
+        //
+        // The response data will be stored @ addr + offset (of 4096 bytes).
+        // This will leave some space for the response headers.
+        luw_init_ctx(ctx, addr, 4096);
+
+        // Allocate memory to store the request and copy the request data.
+        luw_set_req_buf(ctx, &mut REQUEST_BUF, luw_srb_flags_t_LUW_SRB_NONE);
+
+        // Define the Response Body Text.
+
+        luw_mem_writep(
+            ctx,
+            " * Welcome to WebAssembly in Rust on Unit! \
+            [libunit-wasm (%d.%d.%d/%#0.8x)] \
+            *\n\n\0"
+                .as_ptr() as *const c_char,
+            LUW_VERSION_MAJOR,
+            LUW_VERSION_MINOR,
+            LUW_VERSION_PATCH,
+            LUW_VERSION_NUMBER,
+        );
+
+        luw_mem_writep(ctx, "[Request Info]\n\0".as_ptr() as *const c_char);
+
+        luw_mem_writep(
+            ctx,
+            "REQUEST_PATH = %s\n\0".as_ptr() as *const c_char,
+            luw_get_http_path(ctx) as *const c_char,
+        );
+        luw_mem_writep(
+            ctx,
+            "METHOD       = %s\n\0".as_ptr() as *const c_char,
+            luw_get_http_method(ctx) as *const c_char,
+        );
+        luw_mem_writep(
+            ctx,
+            "VERSION      = %s\n\0".as_ptr() as *const c_char,
+            luw_get_http_version(ctx) as *const c_char,
+        );
+        luw_mem_writep(
+            ctx,
+            "QUERY        = %s\n\0".as_ptr() as *const c_char,
+            luw_get_http_query(ctx) as *const c_char,
+        );
+        luw_mem_writep(
+            ctx,
+            "REMOTE       = %s\n\0".as_ptr() as *const c_char,
+            luw_get_http_remote(ctx) as *const c_char,
+        );
+        luw_mem_writep(
+            ctx,
+            "LOCAL_ADDR   = %s\n\0".as_ptr() as *const c_char,
+            luw_get_http_local_addr(ctx) as *const c_char,
+        );
+        luw_mem_writep(
+            ctx,
+            "LOCAL_PORT   = %s\n\0".as_ptr() as *const c_char,
+            luw_get_http_local_port(ctx) as *const c_char,
+        );
+        luw_mem_writep(
+            ctx,
+            "SERVER_NAME  = %s\n\0".as_ptr() as *const c_char,
+            luw_get_http_server_name(ctx) as *const c_char,
+        );
+
+        luw_mem_writep(
+            ctx,
+            "\n[Request Headers]\n\0".as_ptr() as *const c_char,
+        );
+
+        luw_http_hdr_iter(ctx, Some(hdr_iter_func), ptr::null_mut());
+
+        let method = CStr::from_ptr(luw_get_http_method(ctx)).to_str().unwrap();
+        if method == "POST" || method == "PUT" {
+            luw_mem_writep(
+                ctx,
+                "\n[%s data]\n\0".as_ptr() as *const c_char,
+                luw_get_http_method(ctx) as *const c_char,
+            );
+            luw_mem_writep_data(
+                ctx,
+                luw_get_http_content(ctx),
+                luw_get_http_content_len(ctx),
+            );
+            luw_mem_writep(ctx, "\n\0".as_ptr() as *const c_char);
+        }
+
+        let content_len = format!("{}\0", luw_get_response_data_size(ctx));
+
+        // Init Response Headers
+        //
+        // Needs the context, number of headers about to add as well as
+        // the offset where to store the headers. In this case we are
+        // storing the response headers at the beginning of our shared
+        // memory at offset 0.
+
+        luw_http_init_headers(ctx, 2, 0);
+        luw_http_add_header(
+            ctx,
+            0,
+            "Content-Type\0".as_ptr() as *const c_char,
+            "text/plain\0".as_ptr() as *const c_char,
+        );
+        luw_http_add_header(
+            ctx,
+            1,
+            "Content-Length\0".as_ptr() as *const c_char,
+            content_len.as_ptr() as *const c_char,
+        );
+
+        // This calls nxt_wasm_send_headers() in Unit
+        luw_http_send_headers(ctx);
+
+        // This calls nxt_wasm_send_response() in Unit
+        luw_http_send_response(ctx);
+
+        // This calls nxt_wasm_response_end() in Unit
+        luw_http_response_end();
+    }
+
+    return 0;
+}
diff --git a/examples/rust/upload-reflector/Cargo.toml b/examples/rust/upload-reflector/Cargo.toml
new file mode 100644
index 0000000..dc9d23f
--- /dev/null
+++ b/examples/rust/upload-reflector/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "rust-upload-reflector"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+unit-wasm = { path = "../../../src/rust", version = "0.1.0-beta" }
+
+[lib]
+crate-type = ["cdylib"]
diff --git a/examples/rust/upload-reflector/src/lib.rs b/examples/rust/upload-reflector/src/lib.rs
new file mode 100644
index 0000000..9893d5a
--- /dev/null
+++ b/examples/rust/upload-reflector/src/lib.rs
@@ -0,0 +1,131 @@
+/* SPDX-License-Identifier: Apache-2.0 */
+
+/*
+ * Copyright (C) Andrew Clayton
+ * Copyright (C) Timo Stark
+ * Copyright (C) F5, Inc.
+ */
+
+// Include RAW FFI Bindings.
+// @todo: Replace this with the new native Rust API
+use unit_wasm::ffi::*;
+
+use std::os::raw::c_char;
+use std::os::raw::c_void;
+use std::ptr;
+
+static mut CTX: luw_ctx_t = luw_ctx_t {
+    addr: ptr::null_mut(),
+    mem: ptr::null_mut(),
+    req: ptr::null_mut(),
+    resp: ptr::null_mut(),
+    resp_hdr: ptr::null_mut(),
+    resp_offset: 0,
+    req_buf: ptr::null_mut(),
+    hdrp: ptr::null_mut(),
+    reqp: ptr::null_mut(),
+};
+
+static mut TOTAL_RESPONSE_SENT: usize = 0;
+
+// Buffer of some size to store the copy of the request
+static mut REQUEST_BUF: *mut u8 = ptr::null_mut();
+
+#[no_mangle]
+pub extern "C" fn luw_response_end_handler() {
+    unsafe {
+        TOTAL_RESPONSE_SENT = 0;
+    }
+}
+
+#[no_mangle]
+pub extern "C" fn luw_request_end_handler() {
+    unsafe {
+        if REQUEST_BUF.is_null() {
+            return;
+        }
+
+        luw_free(REQUEST_BUF as *mut c_void);
+        REQUEST_BUF = ptr::null_mut();
+    }
+}
+
+pub fn upload_reflector(ctx: *mut luw_ctx_t) -> i32 {
+    let write_bytes: usize;
+
+    unsafe {
+        // Send headers
+        if TOTAL_RESPONSE_SENT == 0 {
+            let content_len = format!("{}\0", luw_get_http_content_len(ctx));
+            let defct = "application/octet-stream\0".as_ptr() as *const c_char;
+            let mut ct = luw_http_hdr_get_value(
+                ctx,
+                "Content-Type\0".as_ptr() as *const c_char,
+            );
+
+            if ct == ptr::null_mut() {
+                ct = defct;
+            }
+
+            luw_http_init_headers(ctx, 2, 0);
+            luw_http_add_header(
+                ctx,
+                0,
+                "Content-Type\0".as_ptr() as *const c_char,
+                ct,
+            );
+            luw_http_add_header(
+                ctx,
+                1,
+                "Content-Length\0".as_ptr() as *const c_char,
+                content_len.as_ptr() as *const c_char,
+            );
+            luw_http_send_headers(ctx);
+        }
+
+        write_bytes = luw_mem_fill_buf_from_req(ctx, TOTAL_RESPONSE_SENT);
+        TOTAL_RESPONSE_SENT += write_bytes;
+
+        luw_http_send_response(ctx);
+
+        if TOTAL_RESPONSE_SENT == luw_get_http_content_len(ctx) {
+            // Tell Unit no more data to send
+            luw_http_response_end();
+        }
+    }
+
+    return 0;
+}
+
+#[no_mangle]
+pub extern "C" fn luw_request_handler(addr: *mut u8) -> i32 {
+    unsafe {
+        let ctx: *mut luw_ctx_t = &mut CTX;
+
+        if REQUEST_BUF.is_null() {
+            luw_init_ctx(ctx, addr, 0 /* Response offset */);
+            /*
+             * Take a copy of the request and use that, we do this
+             * in APPEND mode so we can build up request_buf from
+             * multiple requests.
+             *
+             * Just allocate memory for the total amount of data we
+             * expect to get, this includes the request structure
+             * itself as well as any body content.
+             */
+            luw_set_req_buf(
+                ctx,
+                &mut REQUEST_BUF,
+                luw_srb_flags_t_LUW_SRB_APPEND
+                    | luw_srb_flags_t_LUW_SRB_ALLOC
+                    | luw_srb_flags_t_LUW_SRB_FULL_SIZE,
+            );
+        } else {
+            luw_req_buf_append(ctx, addr);
+        }
+
+        upload_reflector(ctx);
+    }
+
+    return 0;
+}