Document and update the API of the externals.rs module (#812)

* Document and update the API of the `externals.rs` module

This commit ensures that all public methods and items are documented in
the `externals.rs` module, notably all external values that can be
imported and exported in WebAssembly. Along the way this also tidies up
the API and fixes a few bugs:

* `Global::new` now returns a `Result` and fails if the provided value
  does not match the type of the global.
* `Global::set` now returns a `Result` and fails if the global is either
  immutable or the provided value doesn't match the type of the global.
* `Table::new` now fails if the provided initializer does not match the
  element type.
* `Table::get` now returns `Option<Val>` instead of implicitly returning
  null.
* `Table::set` now returns `Result<()>`, returning an error on out of
  bounds or if the input type is of the wrong type.
* `Table::grow` now returns `Result<u32>`, returning the previous number
  of table elements if succesful or an error if the maximum is reached
  or the initializer value is of the wrong type. Additionally a bug was
  fixed here where if the wrong initializer was provided the table would
  be grown still, but initialization would fail.
* `Memory::data` was renamed to `Memory::data_unchecked_mut`.
  Additionally `Memory::data_unchecked` was added. Lots of caveats were
  written down about how using the method can go wrong.
* `Memory::grow` now returns `Result<u32>`, returning an error if growth
  fails or the number of pages previous the growth if successful.

* Run rustfmt

* Fix another test

* Update crates/api/src/externals.rs

Co-Authored-By: Sergei Pepyakin <s.pepyakin@gmail.com>

Co-authored-by: Sergei Pepyakin <s.pepyakin@gmail.com>
This commit is contained in:
Alex Crichton
2020-01-17 09:43:35 -06:00
committed by GitHub
parent 7890fa6705
commit 0bee67a852
10 changed files with 384 additions and 99 deletions

View File

@@ -1381,11 +1381,16 @@ pub unsafe extern "C" fn wasm_global_new(
gt: *const wasm_globaltype_t,
val: *const wasm_val_t,
) -> *mut wasm_global_t {
let global = HostRef::new(Global::new(
&(*store).store.borrow(),
(*gt).globaltype.clone(),
(*val).val(),
));
let global = HostRef::new(
match Global::new(
&(*store).store.borrow(),
(*gt).globaltype.clone(),
(*val).val(),
) {
Ok(g) => g,
Err(_) => return ptr::null_mut(),
},
);
let g = Box::new(wasm_global_t {
ext: wasm_extern_t {
which: ExternHost::Global(global),
@@ -1401,7 +1406,8 @@ pub unsafe extern "C" fn wasm_global_get(g: *const wasm_global_t, out: *mut wasm
#[no_mangle]
pub unsafe extern "C" fn wasm_global_set(g: *mut wasm_global_t, val: *const wasm_val_t) {
(*g).global().borrow().set((*val).val())
let result = (*g).global().borrow().set((*val).val());
drop(result); // TODO: should communicate this via the api somehow?
}
#[no_mangle]
@@ -1480,7 +1486,7 @@ pub unsafe extern "C" fn wasm_memory_grow(
m: *mut wasm_memory_t,
delta: wasm_memory_pages_t,
) -> bool {
(*m).memory().borrow().grow(delta)
(*m).memory().borrow().grow(delta).is_ok()
}
#[no_mangle]
@@ -1570,13 +1576,13 @@ pub unsafe extern "C" fn wasm_table_new(
} else {
Val::AnyRef(AnyRef::Null)
};
let table = match Table::new(&(*store).store.borrow(), (*tt).tabletype.clone(), init) {
Ok(table) => table,
Err(_) => return ptr::null_mut(),
};
let t = Box::new(wasm_table_t {
ext: wasm_extern_t {
which: ExternHost::Table(HostRef::new(Table::new(
&(*store).store.borrow(),
(*tt).tabletype.clone(),
init,
))),
which: ExternHost::Table(HostRef::new(table)),
},
});
Box::into_raw(t)
@@ -1607,8 +1613,10 @@ pub unsafe extern "C" fn wasm_table_get(
t: *const wasm_table_t,
index: wasm_table_size_t,
) -> *mut wasm_ref_t {
let val = (*t).table().borrow().get(index);
into_funcref(val)
match (*t).table().borrow().get(index) {
Some(val) => into_funcref(val),
None => into_funcref(Val::AnyRef(AnyRef::Null)),
}
}
#[no_mangle]
@@ -1618,7 +1626,7 @@ pub unsafe extern "C" fn wasm_table_set(
r: *mut wasm_ref_t,
) -> bool {
let val = from_funcref(r);
(*t).table().borrow().set(index, val)
(*t).table().borrow().set(index, val).is_ok()
}
#[no_mangle]
@@ -1633,7 +1641,7 @@ pub unsafe extern "C" fn wasm_table_grow(
init: *mut wasm_ref_t,
) -> bool {
let init = from_funcref(init);
(*t).table().borrow().grow(delta, init)
(*t).table().borrow().grow(delta, init).is_ok()
}
#[no_mangle]