diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 8ac002a4cd..192e9f9141 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -302,7 +302,7 @@ jobs: - run: $CENTOS cargo build --release --bin wasmtime --bin wasm2obj shell: bash # Build `libwasmtime.so` - - run: $CENTOS cargo build --release --manifest-path crates/api/Cargo.toml + - run: $CENTOS cargo build --release --manifest-path crates/c-api/Cargo.toml shell: bash # Test what we just built - run: $CENTOS cargo test --features test_programs --release --all --exclude lightbeam --exclude wasmtime --exclude wasmtime-fuzzing diff --git a/.gitmodules b/.gitmodules index 2bb139cd81..59646f986c 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,8 +1,8 @@ [submodule "spec_testsuite"] path = tests/spec_testsuite url = https://github.com/WebAssembly/testsuite -[submodule "crates/api/c-examples/wasm-c-api"] - path = crates/api/c-examples/wasm-c-api +[submodule "crates/c-api/examples/wasm-c-api"] + path = crates/c-api/examples/wasm-c-api url = https://github.com/WebAssembly/wasm-c-api [submodule "crates/wasi-common/WASI"] path = crates/wasi-common/wig/WASI diff --git a/Cargo.lock b/Cargo.lock index d8b036cd0f..f7aa569109 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2007,6 +2007,13 @@ dependencies = [ "winapi", ] +[[package]] +name = "wasmtime-c-api" +version = "0.9.0" +dependencies = [ + "wasmtime", +] + [[package]] name = "wasmtime-cli" version = "0.9.0" diff --git a/Cargo.toml b/Cargo.toml index 378189e3c2..09bdaa1cfe 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -55,6 +55,7 @@ members = [ "crates/fuzzing", "crates/misc/rust", "crates/misc/py", + "crates/c-api", "fuzz", ] diff --git a/ci/build-tarballs.sh b/ci/build-tarballs.sh index b998bb93c9..433450116b 100755 --- a/ci/build-tarballs.sh +++ b/ci/build-tarballs.sh @@ -48,7 +48,7 @@ mkdir tmp/$api_pkgname/lib mkdir tmp/$api_pkgname/include cp LICENSE README.md tmp/$api_pkgname mv bins-$src/* tmp/$api_pkgname/lib -cp crates/api/c-examples/wasm-c-api/include/wasm.h tmp/$api_pkgname/include +cp crates/c-api/examples/wasm-c-api/include/wasm.h tmp/$api_pkgname/include mktarball $api_pkgname # Move wheels to dist folder diff --git a/crates/api/Cargo.toml b/crates/api/Cargo.toml index 67961e0299..f524f3d036 100644 --- a/crates/api/Cargo.toml +++ b/crates/api/Cargo.toml @@ -8,10 +8,6 @@ repository = "https://github.com/bytecodealliance/wasmtime" readme = "README.md" edition = "2018" -[lib] -name = "wasmtime" -crate-type = ["lib", "staticlib", "cdylib"] - [dependencies] wasmtime-runtime = { path = "../runtime", version = "0.9.0" } wasmtime-environ = { path = "../environ", version = "0.9.0" } diff --git a/crates/api/README.md b/crates/api/README.md index b0edded9c2..49ca113c15 100644 --- a/crates/api/README.md +++ b/crates/api/README.md @@ -1,3 +1,8 @@ -# Implementation of wasm-c-api in Rust +## Wasmtime Embedding API -https://github.com/WebAssembly/wasm-c-api +The `wasmtime` crate is an embedding API of the `wasmtime` WebAssembly runtime. +This is intended to be used in Rust projects and provides a high-level API of +working with WebAssembly modules. + +If you're interested in embedding `wasmtime` in other languages, you may wish to +take a look a the [C embedding API](../c-api) instead! diff --git a/crates/api/src/lib.rs b/crates/api/src/lib.rs index 7ccf342ca5..d02a2c16a6 100644 --- a/crates/api/src/lib.rs +++ b/crates/api/src/lib.rs @@ -18,13 +18,11 @@ mod trap; mod types; mod values; -pub mod wasm; - pub use crate::callable::Callable; pub use crate::externals::*; pub use crate::instance::Instance; pub use crate::module::Module; -pub use crate::r#ref::AnyRef; +pub use crate::r#ref::{AnyRef, HostInfo, HostRef}; pub use crate::runtime::{Config, Engine, OptLevel, Store, Strategy}; pub use crate::trap::{FrameInfo, Trap}; pub use crate::types::*; diff --git a/crates/api/src/runtime.rs b/crates/api/src/runtime.rs index 7476bc44c9..76a599d7c2 100644 --- a/crates/api/src/runtime.rs +++ b/crates/api/src/runtime.rs @@ -398,7 +398,13 @@ impl Store { .cloned() } - pub(crate) fn ptr_eq(a: &Store, b: &Store) -> bool { + /// Returns whether the stores `a` and `b` refer to the same underlying + /// `Store`. + /// + /// Because the `Store` type is reference counted multiple clones may point + /// to the same underlying storage, and this method can be used to determine + /// whether two stores are indeed the same. + pub fn same(a: &Store, b: &Store) -> bool { Rc::ptr_eq(&a.inner, &b.inner) } } diff --git a/crates/c-api/Cargo.toml b/crates/c-api/Cargo.toml new file mode 100644 index 0000000000..9c1a820cb2 --- /dev/null +++ b/crates/c-api/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "wasmtime-c-api" +version = "0.9.0" +authors = ["The Wasmtime Project Developers"] +description = "C API to expose the Wasmtime runtime" +license = "Apache-2.0 WITH LLVM-exception" +repository = "https://github.com/bytecodealliance/wasmtime" +readme = "README.md" +edition = "2018" +publish = false + +[lib] +name = "wasmtime" +crate-type = ["staticlib", "cdylib"] +doc = false +test = false +doctest = false + +[dependencies] +wasmtime = { path = "../api" } diff --git a/crates/c-api/LICENSE b/crates/c-api/LICENSE new file mode 100644 index 0000000000..f9d81955f4 --- /dev/null +++ b/crates/c-api/LICENSE @@ -0,0 +1,220 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +--- LLVM Exceptions to the Apache 2.0 License ---- + +As an exception, if, as a result of your compiling your source code, portions +of this Software are embedded into an Object form of such source code, you +may redistribute such embedded portions in such Object form without complying +with the conditions of Sections 4(a), 4(b) and 4(d) of the License. + +In addition, if you combine or link compiled forms of this Software with +software that is licensed under the GPLv2 ("Combined Software") and if a +court of competent jurisdiction determines that the patent provision (Section +3), the indemnity provision (Section 9) or other Section of the License +conflicts with the conditions of the GPLv2, you may retroactively and +prospectively choose to deem waived or otherwise exclude such Section(s) of +the License, but only in their entirety and only with respect to the Combined +Software. + diff --git a/crates/c-api/README.md b/crates/c-api/README.md new file mode 100644 index 0000000000..b0edded9c2 --- /dev/null +++ b/crates/c-api/README.md @@ -0,0 +1,3 @@ +# Implementation of wasm-c-api in Rust + +https://github.com/WebAssembly/wasm-c-api diff --git a/crates/api/c-examples/Makefile b/crates/c-api/examples/Makefile similarity index 100% rename from crates/api/c-examples/Makefile rename to crates/c-api/examples/Makefile diff --git a/crates/api/c-examples/wasm-c-api b/crates/c-api/examples/wasm-c-api similarity index 100% rename from crates/api/c-examples/wasm-c-api rename to crates/c-api/examples/wasm-c-api diff --git a/crates/api/src/wasm.rs b/crates/c-api/src/lib.rs similarity index 99% rename from crates/api/src/wasm.rs rename to crates/c-api/src/lib.rs index 083671406f..ea647d207d 100644 --- a/crates/api/src/wasm.rs +++ b/crates/c-api/src/lib.rs @@ -5,15 +5,14 @@ // TODO complete the C API -use super::{ - AnyRef, Callable, Engine, ExportType, Extern, ExternType, Func, FuncType, Global, GlobalType, - ImportType, Instance, Limits, Memory, MemoryType, Module, Store, Table, TableType, Trap, Val, - ValType, -}; -use crate::r#ref::{HostInfo, HostRef}; use std::cell::RefCell; use std::rc::Rc; use std::{mem, ptr, slice}; +use wasmtime::{ + AnyRef, Callable, Engine, ExportType, Extern, ExternType, Func, FuncType, Global, GlobalType, + HostInfo, HostRef, ImportType, Instance, Limits, Memory, MemoryType, Module, Store, Table, + TableType, Trap, Val, ValType, +}; macro_rules! declare_vec { ($name:ident, $elem_ty:path) => { @@ -569,14 +568,18 @@ impl wasm_val_t { } } -impl Callable for wasm_func_callback_t { +struct Callback { + callback: wasm_func_callback_t, +} + +impl Callable for Callback { fn call(&self, params: &[Val], results: &mut [Val]) -> Result<(), Trap> { let params = params .iter() .map(|p| wasm_val_t::from_val(p)) .collect::>(); let mut out_results = vec![wasm_val_t::default(); results.len()]; - let func = self.expect("wasm_func_callback_t fn"); + let func = self.callback.expect("wasm_func_callback_t fn"); let out = unsafe { func(params.as_ptr(), out_results.as_mut_ptr()) }; if !out.is_null() { let trap: Box = unsafe { Box::from_raw(out) }; @@ -633,7 +636,7 @@ pub unsafe extern "C" fn wasm_func_new( ) -> *mut wasm_func_t { let store = &(*store).store.borrow(); let ty = (*ty).functype.clone(); - let callback = Rc::new(callback); + let callback = Rc::new(Callback { callback }); let func = Box::new(wasm_func_t { ext: wasm_extern_t { which: ExternHost::Func(HostRef::new(Func::new(store, ty, callback))), @@ -700,7 +703,7 @@ pub unsafe extern "C" fn wasm_instance_new( let module = &(*module).module.borrow(); // FIXME(WebAssembly/wasm-c-api#126) what else can we do with the `store` // argument? - if !Store::ptr_eq(&store, module.store()) { + if !Store::same(&store, module.store()) { if !result.is_null() { let trap = Trap::new("wasm_store_t must match store in wasm_module_t"); let trap = Box::new(wasm_trap_t { @@ -1254,7 +1257,7 @@ pub unsafe extern "C" fn wasm_globaltype_content( pub unsafe extern "C" fn wasm_globaltype_mutability( gt: *const wasm_globaltype_t, ) -> wasm_mutability_t { - use super::Mutability::*; + use wasmtime::Mutability::*; match (*gt).globaltype.mutability() { Const => 0, Var => 1, @@ -1411,7 +1414,7 @@ pub unsafe extern "C" fn wasm_globaltype_new( ty: *mut wasm_valtype_t, mutability: wasm_mutability_t, ) -> *mut wasm_globaltype_t { - use super::Mutability::*; + use wasmtime::Mutability::*; let ty = Box::from_raw(ty); let mutability = match mutability { 0 => Const, diff --git a/crates/misc/dotnet/Directory.Build.props b/crates/misc/dotnet/Directory.Build.props index b652414ca0..1f08f77261 100644 --- a/crates/misc/dotnet/Directory.Build.props +++ b/crates/misc/dotnet/Directory.Build.props @@ -1,6 +1,7 @@ - 0.8.0 + 0.8.0 wasmtime + wasmtime-c-api diff --git a/crates/misc/dotnet/Directory.Build.targets b/crates/misc/dotnet/Directory.Build.targets index fd577ba0c8..07c6116112 100644 --- a/crates/misc/dotnet/Directory.Build.targets +++ b/crates/misc/dotnet/Directory.Build.targets @@ -6,7 +6,7 @@ .so $(LibraryPrefix)$(WasmtimeLibraryName)$(LibraryExtension) $(MSBuildThisFileDirectory)../../../target/$(Configuration.ToLower()) - cargo build --release -p $(WasmtimeLibraryName) - cargo build -p $(WasmtimeLibraryName) + cargo build --release -p $(WasmtimePackageName) + cargo build -p $(WasmtimePackageName)