summaryrefslogtreecommitdiffhomepage
path: root/src (follow)
AgeCommit message (Collapse)AuthorFilesLines
2023-09-25rust/rusty: Add wrappers for new functionsAndrew Clayton1-0/+13
libunit-wasm added two new functions, luw_req_buf_copy() & luw_mem_splice_file(). See the previous two commits... This second function takes a file-descriptor as one of its arguments, in rusty we make this a Rust File object, then pass the underlying fd into libunit-wasm. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-09-25libunit-wasm: Add a luw_mem_splice_file() functionAndrew Clayton2-0/+39
This is inspired by the likes of splice(2) and sendfile(2) in that it takes data from one place and puts it in another. This function write(2)'s the request data straight from the shared memory to a given file (referenced by its file descriptor). This is an alternative to using luw_req_buf_copy() and avoids an extra copying of the request data. E.g /* In the request_handler */ if (total_bytes_wrote == 0) { luw_init_ctx(&ctx, addr, 0); luw_set_req_buf(&ctx, &request_buf, LUW_SRB_NONE); fd = open("/var/tmp/large-file.dat", O_CREAT|O_TRUNC|O_WRONLY, 0666); } total_bytes_wrote += luw_mem_splice_file(addr, fd); if (total_bytes_wrote == luw_get_http_content_len(&ctx)) { close(fd); total_bytes_wrote = 0; luw_http_response_end(); } NOTE: We include a typedef definition for ssize_t in unit-wasm.h, to avoid having a dependency on the wasi-sysroot when generating the rust bindings. ssize_t is defined in sys/types.h which is provided by libc and not the compiler. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-09-25libunit-wasm: Add a luw_req_buf_copy() functionAndrew Clayton2-0/+12
This is analogous to luw_req_buf_append() but rather than appending request data to the buffer it simply overwrites what's currently there. This is needed to take advantage of the new ability to receive >4GiB requests/payloads. On a new request you would call luw_init_ctx(), luw_set_req_buf() & open(2). On subsequent calls to the request_handler (for this same HTTP request/upload) you would call this new function and then write out the data to a file. E.g /* In the request_handler */ if (total_bytes_wrote == 0) { luw_init_ctx(&ctx, addr, 0); luw_set_req_buf(&ctx, &request_buf, LUW_SRB_NONE); fd = open("/var/tmp/large-file.dat", O_CREAT|O_TRUNC|O_WRONLY, 0666); } else { luw_req_buf_copy(&ctx, addr); } buf = luw_get_http_content(&ctx); bytes_wrote = write(fd, buf, luw_get_http_content_sent(&ctx)); total_bytes_wrote += bytes_wrote; if (total_bytes_wrote == luw_get_http_content_len(&ctx)) { close(fd); total_bytes_wrote = 0; luw_http_response_end(); } Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-09-25libunit-wasm: Allow uploads larger than 4GiBAndrew Clayton3-12/+20
Currently Wasm modules are limited to a 32bit address space (until at least the memory64 work is completed). All the counters etc in the request structure were u32's. Which matched with the 32bit memory limitation. However there is really no need to not allow >4GiB uploads that can be saved off to disk or some such. To do this we need to increase the ->content_len & ->total_content_sent members to u64's and also adjust the return types of (luw,uwr}_get_http_content_len() and {luw,uwr}_get_http_total_content_sent() similarly. However because we need the request structure to have the exact same layout on 32bit (for Wasm modules) as it does on 64bit we need to re-jig the order of some of these members and add a four-byte padding member. Thus the request structure now looks like on 32bit (as shown by pahole(1)) struct luw_req { u32 method_off; /* 0 4 */ u32 method_len; /* 4 4 */ u32 version_off; /* 8 4 */ u32 version_len; /* 12 4 */ u32 path_off; /* 16 4 */ u32 path_len; /* 20 4 */ u32 query_off; /* 24 4 */ u32 query_len; /* 28 4 */ u32 remote_off; /* 32 4 */ u32 remote_len; /* 36 4 */ u32 local_addr_off; /* 40 4 */ u32 local_addr_len; /* 44 4 */ u32 local_port_off; /* 48 4 */ u32 local_port_len; /* 52 4 */ u32 server_name_off; /* 56 4 */ u32 server_name_len; /* 60 4 */ /* --- cacheline 1 boundary (64 bytes) --- */ u64 content_len; /* 64 8 */ u64 total_content_sent; /* 72 8 */ u32 content_sent; /* 80 4 */ u32 content_off; /* 84 4 */ u32 request_size; /* 88 4 */ u32 nr_fields; /* 92 4 */ u32 tls; /* 96 4 */ char __pad[4]; /* 100 4 */ struct luw_hdr_field fields[]; /* 104 0 */ /* size: 104, cachelines: 2, members: 25 */ /* last cacheline: 40 bytes */ }; and the same structure (taken from Unit) compiled as 64bit struct nxt_wasm_request_s { uint32_t method_off; /* 0 4 */ uint32_t method_len; /* 4 4 */ uint32_t version_off; /* 8 4 */ uint32_t version_len; /* 12 4 */ uint32_t path_off; /* 16 4 */ uint32_t path_len; /* 20 4 */ uint32_t query_off; /* 24 4 */ uint32_t query_len; /* 28 4 */ uint32_t remote_off; /* 32 4 */ uint32_t remote_len; /* 36 4 */ uint32_t local_addr_off; /* 40 4 */ uint32_t local_addr_len; /* 44 4 */ uint32_t local_port_off; /* 48 4 */ uint32_t local_port_len; /* 52 4 */ uint32_t server_name_off; /* 56 4 */ uint32_t server_name_len; /* 60 4 */ /* --- cacheline 1 boundary (64 bytes) --- */ uint64_t content_len; /* 64 8 */ uint64_t total_content_sent; /* 72 8 */ uint32_t content_sent; /* 80 4 */ uint32_t content_off; /* 84 4 */ uint32_t request_size; /* 88 4 */ uint32_t nfields; /* 92 4 */ uint32_t tls; /* 96 4 */ char __pad[4]; /* 100 4 */ nxt_wasm_http_field_t fields[]; /* 104 0 */ /* size: 104, cachelines: 2, members: 25 */ /* last cacheline: 40 bytes */ }; We can see the structures have the same layout, same size and no padding. We need the __pad member as otherwise I saw gcc and clang on Alpine Linux automatically add the 'packed' attribute to the structure which made the two structures not match. Link: <https://github.com/WebAssembly/memory64> Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-09-12rust/rusty: Add a wrapper for the new luw_http_set_response_status()Andrew Clayton2-0/+7
The new uwr_http_set_response_status() function allows to set the HTTP response status in Rust WebAssembly modules. It takes one of the luw_http_status_t response status values. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-09-12libunit-wasm: Allow to set the HTTP response statusAndrew Clayton2-0/+52
This adds a new luw_http_set_response_status() function that takes one of the luw_http_status_t response status codes. This function should be called before any calls to luw_http_send_headers() or luw_http_send_response(). This function calls into Unit via a new function import, nxt_wasm_set_resp_status(). Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-09-05rust: Change how bindgen creates enumsAndrew Clayton2-4/+7
Previously bindgen was picking the 'constified_enum'. E.g it would turn the luw_srb_flags_t enum typedef enum { LUW_SRB_NONE = 0x00, LUW_SRB_APPEND = 0x01, LUW_SRB_ALLOC = 0x02, LUW_SRB_FULL_SIZE = 0x04, LUW_SRB_FLAGS_ALL = (LUW_SRB_NONE|LUW_SRB_APPEND|LUW_SRB_ALLOC| LUW_SRB_FULL_SIZE) } luw_srb_flags_t; into pub const luw_srb_flags_t_LUW_SRB_NONE: luw_srb_flags_t = 0; pub const luw_srb_flags_t_LUW_SRB_APPEND: luw_srb_flags_t = 1; pub const luw_srb_flags_t_LUW_SRB_ALLOC: luw_srb_flags_t = 2; pub const luw_srb_flags_t_LUW_SRB_FULL_SIZE: luw_srb_flags_t = 4; pub const luw_srb_flags_t_LUW_SRB_FLAGS_ALL: luw_srb_flags_t = 7; But then this requires some further changes to make the names nicer without the type prefixed. This will only be exasperated when adding an enum containing the HTTP status codes... So instead, tell bindgen to use the 'rustified_enum' method which produces this pub enum luw_srb_flags_t { LUW_SRB_NONE = 0, LUW_SRB_APPEND = 1, LUW_SRB_ALLOC = 2, LUW_SRB_FULL_SIZE = 4, LUW_SRB_FLAGS_ALL = 7, } which in theory requires no extra changes (it doesn't with the http status codes enum), however in this specific case, because these are actually bitflags we still need to cast them to u32 so they can be OR'd. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-30unit-wasm 0.2.0v0.2.0Andrew Clayton4-5/+5
Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-29Rust/rusty: Make use of uwr_get_http_total_content_sent()Andrew Clayton1-1/+1
When the uwr_get_http_content_str() function, which returns the request body content as a string, was added it used uwr_get_http_content_len() to determine the length of the returned string (the request body content is not null-terminated). This could potentially in some circumstances return too much data if the request was split over multiple calls into the Wasm module and uwr_get_http_content_str() was called before all the data had actually been received. Instead use the newly introduced uwr_get_http_total_content_sent() function to determine the amount of data to return in the string as it currently stands. Fixes: bf968c9 ("Rust/rusty: Add uwr_get_http_content_str()") Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-29Rust/rusty: Add a wrapper for luw_get_http_total_content_sent()Andrew Clayton1-0/+4
This returns the total amount of content that the Wasm module has received so far. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-29Rust/rusty: Re-order some functions more logicallyAndrew Clayton1-8/+8
This may not matter in rust (if you use a function before the compiler has seen a definition for it), but anyway in preparation for adding a uwr_get_http_total_content_sent() function, put the content length related functions before the functions that return the content. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-29libunit-wasm: Add a luw_get_http_total_content_sent() functionAndrew Clayton2-0/+7
This function returns the total amount of content that the Wasm module has received so far. This will be used in the rusty API's uwr_get_http_content_str() function which returns the body content as a string. Due to the body content not being null-terminated we need to know how much data to use for the string, for which we are currently using uwr_get_http_content_len(), which could in some cases return too much if a request is being split over multiple calls the module. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-29Rust/rusty: Add a couple of convenience functionsAndrew Clayton1-0/+12
This adds the following convenience functions for adding HTTP response headers, Content-Type & Content-length uwr_http_add_header_content_type(ctx: *mut luw_ctx_t, ctype: &str); uwr_http_add_header_content_len(ctx: *mut luw_ctx_t); These are perhaps the two most common headers so it makes sense to reduce the effort to adding them. E.g before uwr_http_add_header(&ctx, "Content-Type", "text/plain"); uwr_http_add_header( ctx, "Content-Length", &format!("{}", uwr_get_response_data_size(ctx)), ); after uwr_http_add_header_content_type(ctx, "text/plain"); uwr_http_add_header_content_len(ctx); Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-29Rust/rusty: Add uwr_get_http_content_str()Andrew Clayton1-0/+12
This function is like uwr_get_http_content() except that it returns a Rust str. This is more convenient if you want to operate on the body content within Rust. It's worth noting that uwr_get_http_content() returns a non null terminated buffer which makes it tricky to work with in Rust. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-29Rust/rusty: Run rusty.rs through rustfmtAndrew Clayton1-6/+5
Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-28Rust/unit-wasm: Version 0.1.2Andrew Clayton1-1/+1
luw_http_add_header() no longer takes an idx argument. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-28Rust/unit-wasm-sys: Version 0.1.4Andrew Clayton2-2/+2
luw_http_add_header() no longer takes an idx argument. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-28Rust/unit-wasm-sys: Re-generate the bindings on changes to unit-wasm.hAndrew Clayton1-1/+1
Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-28Rust/rusty: Make a bunch of functions take ctx as constAndrew Clayton1-8/+8
The various uwr_get_ functions should take the context pointer as a const. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-28libunit-wasm: Pass ctx into luw_http_hdr_get_value() as constAndrew Clayton3-4/+5
Technically the context pointer can be passed in const even though we then un-const it passing it to the luw_foreach_http_hdr() macro. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-28libunit-wasm: Remove the idx argument from luw_http_add_header()Andrew Clayton3-5/+16
This was used to specify the index of the response header being added, starting at 0 and incrementing by one for each header. Instead of having the programmer specify this, track it internally. We add an extra check in luw_http_add_header() to make sure we aren't trying to add more headers than we said with luw_http_init_headers(), if we are, simply return. This updates the API-C.md and the various examples and 'rusty' API wrapper. Suggested-by: Liam Crilly <liam@nginx.com> Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-26Rust/unit-wasm: Version 0.1.1Andrew Clayton1-1/+1
Bump the version for the 'rusty' API. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-26Rust/unit-wasm-sys: Version 0.1.3Andrew Clayton2-2/+2
Bump the version for the 'rusty' API. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-26libunit-wasm: Fix rust buildAndrew Clayton2-2/+2
The rust build failed when trying to publish new crates, although for some reason it didn't fail before that, due to the luw_srb_flags_t enums generated by bindgen being 32 bit unsigned integers and the flags argument to luw_set_req_buf() being an unsigned long (which is 64 bits on my system) and thus producing a type mismatch error. Rather than fight with rust just make the flags argument an unsigned int, 32 bits is more than enough for this anyway. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-26Rust/unit-wasm-sys: Don't require the wasi-sysrootAndrew Clayton1-3/+0
When I added the luw_http_hdr_get_value() function I needed to include strings.h, unfortunately I added it to unit-wasm.h instead of libunit-wasm.c This then meant that we needed to point bindgen/clang, for generating the bindings, to the wasi-sysroot for the strings.h file. I guess this is a system dependant include or something and when we use the wasm32-wasi target in clang it uses a paired down include search path list, none of which have strings.h This then had the knock on effect of requiring to inform cargo build of the wasi-sysroot path. Now that we put strings.h in the right place, we don't need the wasi-sysroot when building the rust stuff. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-26libunit-wasm: Include strings.h in the right fileAndrew Clayton2-1/+1
When I added the luw_http_hdr_get_value() function I needed to include strings.h, unfortunately I added it to unit-wasm.h instead of libunit-wasm.c This had the undesirable effect of requiring the wasi-sysroot when building the rust stuff for generating the libunit-wasm rust bindings. By including strings.h in the right file we get rid of that requirement which a subsequent commit will take care of. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-26Rust/unit-wasm-sys: Remove reference to wrapper.h from build.rsAndrew Clayton1-1/+0
There is no wrapper.h in the repository. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-26Rust/unit-wasm-sys: Run build.rs through rustfmtAndrew Clayton1-3/+4
This in preparation for some upcoming changes. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-25Rust: Add a nicer wrapper around the libunit-wasm bindingsAndrew Clayton5-0/+225
This adds a nice wrapper (aka rusty) around the generated libunit-wasm bindings. This should provide a more native rust like experience with the following benefits - No casting. So no things like 'as *mut c_void' - Native rust strings. So no things like '.as_ptr() as *const c_char' - Better ctx initialisation. Filed initialisation is now hidden away - Great reduction in the amount of unsafe {} blocks required - Generally more compact There are also some new macros - C2S!() converts a CStr to a Str - S2C!() converts a formatted Str to a Cstr using format!() - uwr_write_str!() a wrapper around luw_mem_writep_data and format!() This wrapper uses a uwr (Unit Wasm Rust) prefix under a 'rusty' namespace. The luw_http_hdr_iter() function proved tricky to wrap and the callback function still takes C style arguments due to the fact that this function is called from the libunit-wasm C library. The provided wrapper simply means we can use this without having to use an unsafe {} block around it in application code. Similarly with other functions that technically didn't need to be wrapped, wrapping them means that the unsafe {} blocks are hidden away. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-25Rust: Don't disable dead code warningsAndrew Clayton1-1/+0
Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-25Rust/unit-wasm-sys: Bump the version of the crateAndrew Clayton2-2/+2
unit-wasm-sys 0.1.2 Might as well do this now before the code changes and we bump the version again. This version was published to crates.io Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-24libunit-wasm: Remove left over prototype from unit-wasm.hAndrew Clayton1-1/+0
There was a luw_destroy_ctx() function at one point and its prototype was still in the header file... Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-24libunit-wasm: Put LUW_SRB_FLAGS_ALL in the enumAndrew Clayton1-2/+3
No reason why this needed to be a separate #define. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
2023-08-21Initial commitv0.1.0Andrew Clayton16-0/+782
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>