Add component example and CI

Signed-off-by: James Sturtevant <jsturtevant@gmail.com>

Author: jsturtevant

.github/workflows/dep_rust.yml

@@ -77,8 +77,12 @@ jobs:
           name: guest-modules
           path: ./x64/${{ matrix.config }}
 
-      - name: Build Rust Wasi examples
-        run:  just build-rust-wasi-examples ${{ matrix.config }}
+      - name: Build Rust component model examples
+        run:  |
+          # this must be build before the formatting and other jobs run
+          # because the component model example depends on the wasm component built here
+          just ensure-tools
+          just build-rust-component-examples ${{ matrix.config }}
       
       - name: Fmt
         run: just fmt-check
@@ -127,8 +131,8 @@ jobs:
           # required for gh cli when downloading
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Test Wasi Examples
-        run: just examples-wasi ${{ matrix.config }} ${{ matrix.hypervisor == 'mshv3' && 'mshv3' || ''}}
+      - name: Test Component Model Examples
+        run: just examples-components ${{ matrix.config }} ${{ matrix.hypervisor == 'mshv3' && 'mshv3' || ''}}
         working-directory: ./src/hyperlight_wasm
 
       ### Benchmarks ###

.gitignore

@@ -478,4 +478,4 @@ target/
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
-src/wasi_samples/wit/component-world.wasm
+src/component_sample/**/*.wasm

Cargo.toml

@@ -1,6 +1,6 @@
 [workspace]
 members = [ "src/hyperlight_wasm", "src/examples_common", "src/hyperlight_wasm_aot" ]
-exclude = [ "src/wasm_runtime",  "src/rust_wasm_samples", "src/hyperlight_wasm_macro", "src/wasi_samples" ]
+exclude = [ "src/wasm_runtime",  "src/rust_wasm_samples", "src/hyperlight_wasm_macro", "src/component_sample" ]
 resolver = "2"
 
 [workspace.dependencies]

Justfile

@@ -3,11 +3,15 @@ default-tag:= "latest"
 build-wasm-examples-command := if os() == "windows" { "./src/hyperlight_wasm/scripts/build-wasm-examples.bat" } else { "./src/hyperlight_wasm/scripts/build-wasm-examples.sh" }
 mkdir-arg := if os() == "windows" { "-Force" } else { "-p" }
 latest-release:= if os() == "windows" {"$(git tag -l --sort=v:refname | select -last 2 | select -first 1)"} else {`git tag -l --sort=v:refname | tail -n 2 | head -n 1`}
-wit-world := if os() == "windows" { "$env:WIT_WORLD=\"" + justfile_directory() + "\\src\\wasi_samples\\wit\\component-world.wasm" + "\";" } else { "WIT_WORLD=" + justfile_directory() + "/src/wasi_samples/wit/component-world.wasm" }
+wit-world := if os() == "windows" { "$env:WIT_WORLD=\"" + justfile_directory() + "\\src\\component_sample\\wit\\component-world.wasm" + "\";" } else { "WIT_WORLD=" + justfile_directory() + "/src/component_sample/wit/component-world.wasm" }
 
 set windows-shell := ["pwsh.exe", "-NoLogo", "-Command"]
 
-build-all target=default-target: (build target) (build-wasm-examples target) (build-rust-wasm-examples target) (build-wasm-runtime target) (build-rust-wasi-examples target)
+ensure-tools:
+    cargo install --locked wasm-tools --version 1.235.0
+    cargo install cargo-component --locked --version 0.21.1
+
+build-all target=default-target: (build target) (build-wasm-examples target) (build-rust-wasm-examples target) (build-wasm-runtime target) (build-rust-component-examples target)
 
 build target=default-target features="": (build-wasm-runtime target) (fmt-check)
     cargo build {{ if features =="" {''} else if features=="no-default-features" {"--no-default-features" } else {"--no-default-features -F " + features } }} --verbose --profile={{ if target == "debug" {"dev"} else { target } }}
@@ -32,39 +36,37 @@ build-rust-wasm-examples target=default-target: (mkdir-redist target)
     cargo run -p hyperlight-wasm-aot compile ./src/rust_wasm_samples/target/wasm32-unknown-unknown/{{ target }}/rust_wasm_samples.wasm ./x64/{{ target }}/rust_wasm_samples.aot
     cp ./x64/{{ target }}/rust_wasm_samples.aot ./x64/{{ target }}/rust_wasm_samples.wasm
 
-build-rust-wasi-examples target=default-target:
-    cargo install --locked wasm-tools
-    cargo install cargo-component --locked
-    wasm-tools component wit ./src/wasi_samples/wit/example.wit -w -o ./src/wasi_samples/wit/component-world.wasm
+build-rust-component-examples target=default-target:
+    wasm-tools component wit ./src/component_sample/wit/example.wit -w -o ./src/component_sample/wit/component-world.wasm
     # use cargo component so we don't get all the wasi imports https://github.com/bytecodealliance/cargo-component?tab=readme-ov-file#relationship-with-wasm32-wasip2
     # we also explicitly target wasm32-unknown-unknown since cargo component might try to pull in wasi imports https://github.com/bytecodealliance/cargo-component/issues/290
     rustup target add wasm32-unknown-unknown
-    cd ./src/wasi_samples && cargo component build --target wasm32-unknown-unknown --profile={{ if target == "debug" {"dev"} else { target } }}
-    cargo run -p hyperlight-wasm-aot compile --component ./src/wasi_samples/target/wasm32-unknown-unknown/{{ target }}/wasi_samples.wasm ./x64/{{ target }}/wasi_samples.aot
-    cp ./x64/{{ target }}/wasi_samples.aot ./x64/{{ target }}/wasi_samples.wasm
+    cd ./src/component_sample && cargo component build --target wasm32-unknown-unknown --profile={{ if target == "debug" {"dev"} else { target } }}
+    cargo run -p hyperlight-wasm-aot compile --component ./src/component_sample/target/wasm32-unknown-unknown/{{ target }}/component_sample.wasm ./x64/{{ target }}/component_sample.aot
+    cp ./x64/{{ target }}/component_sample.aot ./x64/{{ target }}/component_sample.wasm
 
 check target=default-target:
     cargo check --profile={{ if target == "debug" {"dev"} else { target } }}
     cd src/rust_wasm_samples  && cargo check --profile={{ if target == "debug" {"dev"} else { target } }}
-    cd src/wasi_samples  && cargo check --profile={{ if target == "debug" {"dev"} else { target } }}
+    cd src/component_sample  && cargo check --profile={{ if target == "debug" {"dev"} else { target } }}
     cd src/wasm_runtime && cargo check --profile={{ if target == "debug" {"dev"} else { target } }}
 
 fmt-check:
     rustup toolchain install nightly -c rustfmt && cargo +nightly fmt -v --all -- --check
     cd src/rust_wasm_samples && rustup toolchain install nightly -c rustfmt && cargo +nightly fmt -v --all -- --check
-    cd src/wasi_samples && rustup toolchain install nightly -c rustfmt && cargo +nightly fmt -v --all -- --check
+    cd src/component_sample && rustup toolchain install nightly -c rustfmt && cargo +nightly fmt -v --all -- --check
     cd src/wasm_runtime && rustup toolchain install nightly -c rustfmt && cargo +nightly fmt -v --all -- --check
 fmt:
     rustup toolchain install nightly -c rustfmt
     cargo +nightly fmt --all
-    cd src/rust_wasm_samples &&  cargo +nightly fmt
-    cd src/wasi_samples &&  cargo +nightly fmt
-    cd src/wasm_runtime && cargo +nightly fmt
+    cd src/rust_wasm_samples &&  cargo +nightly fmt -v --all
+    cd src/component_sample &&  cargo +nightly fmt -v --all
+    cd src/wasm_runtime && cargo +nightly fmt -v --all
 
 clippy target=default-target: (check target)
     cargo clippy --profile={{ if target == "debug" {"dev"} else { target } }} --all-targets --all-features -- -D warnings
     cd src/rust_wasm_samples &&  cargo clippy --profile={{ if target == "debug" {"dev"} else { target } }} --all-targets --all-features -- -D warnings
-    cd src/wasi_samples &&  cargo clippy --profile={{ if target == "debug" {"dev"} else { target } }} --all-targets --all-features -- -D warnings
+    cd src/component_sample &&  cargo clippy --profile={{ if target == "debug" {"dev"} else { target } }} --all-targets --all-features -- -D warnings
     cd src/wasm_runtime && cargo clippy --profile={{ if target == "debug" {"dev"} else { target } }} --all-targets --all-features -- -D warnings
 
 # TESTING
@@ -88,8 +90,8 @@ examples-ci target=default-target features="": (build-rust-wasm-examples target)
     cargo run {{ if features =="" {''} else {"--no-default-features -F function_call_metrics," + features } }} --profile={{ if target == "debug" {"dev"} else { target } }} --example metrics
     cargo run {{ if features =="" {"--no-default-features --features kvm,mshv2"} else {"--no-default-features -F function_call_metrics," + features } }} --profile={{ if target == "debug" {"dev"} else { target } }} --example metrics 
 
-examples-wasi target=default-target features="": (build-rust-wasi-examples target) 
-    {{ wit-world }} cargo run {{ if features =="" {''} else {"--no-default-features -F " + features } }} --profile={{ if target == "debug" {"dev"} else { target } }} --example wasi_examples
+examples-components target=default-target features="": (build-rust-component-examples target) 
+    {{ wit-world }} cargo run {{ if features =="" {''} else {"--no-default-features -F " + features } }} --profile={{ if target == "debug" {"dev"} else { target } }} --example component_example
 
 # warning, compares to and then OVERWRITES the given baseline
 bench-ci baseline target=default-target features="":

src/wasi_samples/Cargo.lock src/component_sample/Cargo.locksrc/wasi_samples/Cargo.lock renamed to src/component_sample/Cargo.lock

@@ -1,5 +1,5 @@
 [package]
-name = "wasi_samples"
+name = "component_sample"
 version = "0.1.0"
 edition = "2024"
 
@@ -10,7 +10,7 @@ wit-bindgen-rt = { version = "0.41.0", features = ["bitflags"] }
 crate-type = ["cdylib"]
 
 [package.metadata.component]
-package = "wasi-sample:example"
+package = "component-sample:example"
 
 [package.metadata.component.target]
 path = "wit/example.wit"

src/wasi_samples/Cargo.toml src/component_sample/Cargo.tomlsrc/wasi_samples/Cargo.toml renamed to src/component_sample/Cargo.toml

@@ -3,7 +3,7 @@
 //   * runtime_path: "wit_bindgen_rt"
 #[rustfmt::skip]
 #[allow(dead_code, clippy::all)]
-pub mod wasi_sample {
+pub mod component_sample {
     pub mod example {
         #[allow(dead_code, async_fn_in_trait, unused_imports, clippy::all)]
         pub mod host {
@@ -18,7 +18,7 @@ pub mod wasi_sample {
                     let ptr0 = vec0.as_ptr().cast::<u8>();
                     let len0 = vec0.len();
                     #[cfg(target_arch = "wasm32")]
-                    #[link(wasm_import_module = "wasi-sample:example/host")]
+                    #[link(wasm_import_module = "component-sample:example/host")]
                     unsafe extern "C" {
                         #[link_name = "print"]
                         fn wit_import1(_: *mut u8, _: usize);
@@ -49,7 +49,7 @@ pub mod wasi_sample {
                     let len0 = vec0.len();
                     let ptr1 = ret_area.0.as_mut_ptr().cast::<u8>();
                     #[cfg(target_arch = "wasm32")]
-                    #[link(wasm_import_module = "wasi-sample:example/host")]
+                    #[link(wasm_import_module = "component-sample:example/host")]
                     unsafe extern "C" {
                         #[link_name = "host-function"]
                         fn wit_import2(_: *mut u8, _: usize, _: *mut u8);
@@ -75,7 +75,7 @@ pub mod wasi_sample {
 #[rustfmt::skip]
 #[allow(dead_code, clippy::all)]
 pub mod exports {
-    pub mod wasi_sample {
+    pub mod component_sample {
         pub mod example {
             #[allow(dead_code, async_fn_in_trait, unused_imports, clippy::all)]
             pub mod adder {
@@ -123,24 +123,29 @@ pub mod exports {
                     fn call_host(input: _rt::String) -> _rt::String;
                 }
                 #[doc(hidden)]
-                macro_rules! __export_wasi_sample_example_adder_cabi {
+                macro_rules! __export_component_sample_example_adder_cabi {
                     ($ty:ident with_types_in $($path_to_types:tt)*) => {
                         const _ : () = { #[unsafe (export_name =
-                        "wasi-sample:example/adder#add")] unsafe extern "C" fn
+                        "component-sample:example/adder#add")] unsafe extern "C" fn
                         export_add(arg0 : i32, arg1 : i32,) -> i32 { unsafe {
                         $($path_to_types)*:: _export_add_cabi::<$ty > (arg0, arg1) } }
-                        #[unsafe (export_name = "wasi-sample:example/adder#call-host")]
-                        unsafe extern "C" fn export_call_host(arg0 : * mut u8, arg1 :
-                        usize,) -> * mut u8 { unsafe { $($path_to_types)*::
-                        _export_call_host_cabi::<$ty > (arg0, arg1) } } #[unsafe
-                        (export_name = "cabi_post_wasi-sample:example/adder#call-host")]
-                        unsafe extern "C" fn _post_return_call_host(arg0 : * mut u8,) {
-                        unsafe { $($path_to_types)*:: __post_return_call_host::<$ty >
-                        (arg0) } } };
+                        #[unsafe (export_name =
+                        "component-sample:example/adder#call-host")] unsafe extern "C" fn
+                        export_call_host(arg0 : * mut u8, arg1 : usize,) -> * mut u8 {
+                        unsafe { $($path_to_types)*:: _export_call_host_cabi::<$ty >
+                        (arg0, arg1) } } #[unsafe (export_name =
+                        "cabi_post_component-sample:example/adder#call-host")] unsafe
+                        extern "C" fn _post_return_call_host(arg0 : * mut u8,) { unsafe {
+                        $($path_to_types)*:: __post_return_call_host::<$ty > (arg0) } }
+                        #[unsafe (export_name =
+                        "component-sample:example/adder#do-something")] unsafe extern "C"
+                        fn export_do_something(arg0 : i32,) { unsafe {
+                        $($path_to_types)*:: _export_do_something_cabi::<$ty > (arg0) } }
+                        };
                     };
                 }
                 #[doc(hidden)]
-                pub(crate) use __export_wasi_sample_example_adder_cabi;
+                pub(crate) use __export_component_sample_example_adder_cabi;
                 #[cfg_attr(target_pointer_width = "64", repr(align(8)))]
                 #[cfg_attr(target_pointer_width = "32", repr(align(4)))]
                 struct _RetArea(
@@ -265,24 +270,28 @@ macro_rules! __export_example_impl {
     };
     ($ty:ident with_types_in $($path_to_types_root:tt)*) => {
         $($path_to_types_root)*::
-        exports::wasi_sample::example::adder::__export_wasi_sample_example_adder_cabi!($ty
-        with_types_in $($path_to_types_root)*:: exports::wasi_sample::example::adder);
+        exports::component_sample::example::adder::__export_component_sample_example_adder_cabi!($ty
+        with_types_in $($path_to_types_root)*::
+        exports::component_sample::example::adder);
     };
 }
 #[doc(inline)]
 pub(crate) use __export_example_impl as export;
 #[cfg(target_arch = "wasm32")]
-#[unsafe(link_section = "component-type:wit-bindgen:0.41.0:wasi-sample:example:example:encoded world")]
+#[unsafe(
+    link_section = "component-type:wit-bindgen:0.41.0:component-sample:example:example:encoded world"
+)]
 #[doc(hidden)]
 #[allow(clippy::octal_escapes)]
-pub static __WIT_BINDGEN_COMPONENT_TYPE: [u8; 335] = *b"\
-\0asm\x0d\0\x01\0\0\x19\x16wit-component-encoding\x04\0\x07\xd1\x01\x01A\x02\x01\
+pub static __WIT_BINDGEN_COMPONENT_TYPE: [u8; 380] = *b"\
+\0asm\x0d\0\x01\0\0\x19\x16wit-component-encoding\x04\0\x07\xfe\x01\x01A\x02\x01\
 A\x04\x01B\x04\x01@\x01\x07messages\x01\0\x04\0\x05print\x01\0\x01@\x01\x05input\
-s\0s\x04\0\x0dhost-function\x01\x01\x03\0\x18wasi-sample:example/host\x05\0\x01B\
-\x04\x01@\x02\x04lefty\x05righty\0y\x04\0\x03add\x01\0\x01@\x01\x05inputs\0s\x04\
-\0\x09call-host\x01\x01\x04\0\x19wasi-sample:example/adder\x05\x01\x04\0\x1bwasi\
--sample:example/example\x04\0\x0b\x0d\x01\0\x07example\x03\0\0\0G\x09producers\x01\
-\x0cprocessed-by\x02\x0dwit-component\x070.227.1\x10wit-bindgen-rust\x060.41.0";
+s\0s\x04\0\x0dhost-function\x01\x01\x03\0\x1dcomponent-sample:example/host\x05\0\
+\x01B\x06\x01@\x02\x04lefty\x05righty\0y\x04\0\x03add\x01\0\x01@\x01\x05inputs\0\
+s\x04\0\x09call-host\x01\x01\x01@\x01\x06numbery\x01\0\x04\0\x0cdo-something\x01\
+\x02\x04\0\x1ecomponent-sample:example/adder\x05\x01\x04\0\x20component-sample:e\
+xample/example\x04\0\x0b\x0d\x01\0\x07example\x03\0\0\0G\x09producers\x01\x0cpro\
+cessed-by\x02\x0dwit-component\x070.227.1\x10wit-bindgen-rust\x060.41.0";
 #[inline(never)]
 #[doc(hidden)]
 pub fn __link_custom_section_describing_imports() {

src/wasi_samples/src/bindings.rs src/component_sample/src/bindings.rssrc/wasi_samples/src/bindings.rs renamed to src/component_sample/src/bindings.rs

@@ -2,8 +2,8 @@
 #[rustfmt::skip]
 mod bindings;
 
-use bindings::exports::wasi_sample::example::adder::Guest;
-use bindings::wasi_sample::example::host::{host_function, print};
+use bindings::component_sample::example::host::{host_function, print};
+use bindings::exports::component_sample::example::adder::Guest;
 
 struct Component {}
 

src/wasi_samples/src/lib.rs src/component_sample/src/lib.rssrc/wasi_samples/src/lib.rs renamed to src/component_sample/src/lib.rs

@@ -1,4 +1,4 @@
-package wasi-sample:example;
+package component-sample:example;
 
 world example {
   import host;

src/wasi_samples/wit/example.wit src/component_sample/wit/example.witsrc/wasi_samples/wit/example.wit renamed to src/component_sample/wit/example.wit

@@ -1,9 +1,13 @@
-use bindings::wasi_sample::example::Adder;
+#![allow(renamed_and_removed_lints)]
+#![allow(unknown_lints)]
+#![allow(unused_unit)]
+
+use bindings::component_sample::example::Adder;
 use examples_common::get_wasm_module_path;
 
 extern crate alloc;
 mod bindings {
-    hyperlight_component_macro::host_bindgen!("../wasi_samples/wit/component-world.wasm");
+    hyperlight_component_macro::host_bindgen!("../component_sample/wit/component-world.wasm");
 }
 
 pub struct State {}
@@ -19,7 +23,7 @@ impl Default for State {
     }
 }
 
-impl bindings::wasi_sample::example::Host for State {
+impl bindings::component_sample::example::Host for State {
     fn r#print(&mut self, message: alloc::string::String) {
         println!("Logged from component: {message}");
     }
@@ -30,7 +34,7 @@ impl bindings::wasi_sample::example::Host for State {
 }
 
 #[allow(refining_impl_trait)]
-impl bindings::wasi_sample::example::ExampleImports for State {
+impl bindings::component_sample::example::ExampleImports for State {
     type Host = State;
 
     fn r#host(&mut self) -> &mut Self {
@@ -50,12 +54,12 @@ fn main() {
 
     let sb = sb.load_runtime().unwrap();
 
-    let mod_path = get_wasm_module_path("wasi_samples.wasm").unwrap();
+    let mod_path = get_wasm_module_path("component_sample.wasm").unwrap();
     let sb = sb.load_module(mod_path).unwrap();
 
     let mut wrapped = bindings::ExampleSandbox { sb, rt };
 
-    let instance = bindings::wasi_sample::example::ExampleExports::adder(&mut wrapped);
+    let instance = bindings::component_sample::example::ExampleExports::adder(&mut wrapped);
     let result = instance.add(1, 2);
     assert_eq!(3, result);
     println!("Add result is {result}");