1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
use crate::{Extern, FuncType, Memory, Store, Trap, Val, ValType}; use anyhow::{ensure, Context as _}; use std::cmp::max; use std::fmt; use std::mem; use std::panic::{self, AssertUnwindSafe}; use std::ptr; use wasmtime_runtime::{Export, InstanceHandle, VMContext, VMFunctionBody}; use wasmtime_runtime::{ExportFunction, VMTrampoline}; /// A WebAssembly function which can be called. /// /// This type can represent a number of callable items, such as: /// /// * An exported function from a WebAssembly module. /// * A user-defined function used to satisfy an import. /// /// These types of callable items are all wrapped up in this `Func` and can be /// used to both instantiate an [`Instance`] as well as be extracted from an /// [`Instance`]. /// /// [`Instance`]: crate::Instance /// /// # `Func` and `Clone` /// /// Functions are internally reference counted so you can `clone` a `Func`. The /// cloning process only performs a shallow clone, so two cloned `Func` /// instances are equivalent in their functionality. /// /// # Examples /// /// One way to get a `Func` is from an [`Instance`] after you've instantiated /// it: /// /// ``` /// # use wasmtime::*; /// # fn main() -> anyhow::Result<()> { /// let store = Store::default(); /// let module = Module::new(&store, r#"(module (func (export "foo")))"#)?; /// let instance = Instance::new(&module, &[])?; /// let foo = instance.exports()[0].func().expect("export wasn't a function"); /// /// // Work with `foo` as a `Func` at this point, such as calling it /// // dynamically... /// match foo.call(&[]) { /// Ok(result) => { /* ... */ } /// Err(trap) => { /// panic!("execution of `foo` resulted in a wasm trap: {}", trap); /// } /// } /// foo.call(&[])?; /// /// // ... or we can make a static assertion about its signature and call it. /// // Our first call here can fail if the signatures don't match, and then the /// // second call can fail if the function traps (like the `match` above). /// let foo = foo.get0::<()>()?; /// foo()?; /// # Ok(()) /// # } /// ``` /// /// You can also use the [`wrap` function](Func::wrap) to create a /// `Func` /// /// ``` /// # use wasmtime::*; /// # fn main() -> anyhow::Result<()> { /// let store = Store::default(); /// /// // Create a custom `Func` which can execute arbitrary code inside of the /// // closure. /// let add = Func::wrap(&store, |a: i32, b: i32| -> i32 { a + b }); /// /// // Next we can hook that up to a wasm module which uses it. /// let module = Module::new( /// &store, /// r#" /// (module /// (import "" "" (func $add (param i32 i32) (result i32))) /// (func (export "call_add_twice") (result i32) /// i32.const 1 /// i32.const 2 /// call $add /// i32.const 3 /// i32.const 4 /// call $add /// i32.add)) /// "#, /// )?; /// let instance = Instance::new(&module, &[add.into()])?; /// let call_add_twice = instance.exports()[0].func().expect("export wasn't a function"); /// let call_add_twice = call_add_twice.get0::<i32>()?; /// /// assert_eq!(call_add_twice()?, 10); /// # Ok(()) /// # } /// ``` /// /// Or you could also create an entirely dynamic `Func`! /// /// ``` /// # use wasmtime::*; /// # fn main() -> anyhow::Result<()> { /// let store = Store::default(); /// /// // Here we need to define the type signature of our `Double` function and /// // then wrap it up in a `Func` /// let double_type = wasmtime::FuncType::new( /// Box::new([wasmtime::ValType::I32]), /// Box::new([wasmtime::ValType::I32]) /// ); /// let double = Func::new(&store, double_type, |_, params, results| { /// let mut value = params[0].unwrap_i32(); /// value *= 2; /// results[0] = value.into(); /// Ok(()) /// }); /// /// let module = Module::new( /// &store, /// r#" /// (module /// (import "" "" (func $double (param i32) (result i32))) /// (func $start /// i32.const 1 /// call $double /// drop) /// (start $start)) /// "#, /// )?; /// let instance = Instance::new(&module, &[double.into()])?; /// // .. work with `instance` if necessary /// # Ok(()) /// # } /// ``` #[derive(Clone)] pub struct Func { store: Store, instance: InstanceHandle, export: ExportFunction, ty: FuncType, trampoline: VMTrampoline, } macro_rules! getters { ($( $(#[$doc:meta])* ($name:ident $(,$args:ident)*) )*) => ($( $(#[$doc])* #[allow(non_snake_case)] pub fn $name<'a, $($args,)* R>(&'a self) -> anyhow::Result<impl Fn($($args,)*) -> Result<R, Trap> + 'a> where $($args: WasmTy,)* R: WasmTy, { // Verify all the paramers match the expected parameters, and that // there are no extra parameters... let mut params = self.ty().params().iter().cloned(); let n = 0; $( let n = n + 1; $args::matches(&mut params) .with_context(|| format!("Type mismatch in argument {}", n))?; )* ensure!(params.next().is_none(), "Type mismatch: too many arguments (expected {})", n); // ... then do the same for the results... let mut results = self.ty().results().iter().cloned(); R::matches(&mut results) .context("Type mismatch in return type")?; ensure!(results.next().is_none(), "Type mismatch: too many return values (expected 1)"); // ... and then once we've passed the typechecks we can hand out our // object since our `transmute` below should be safe! let f = self.wasmtime_function(); Ok(move |$($args: $args),*| -> Result<R, Trap> { unsafe { let fnptr = mem::transmute::< *const VMFunctionBody, unsafe extern "C" fn( *mut VMContext, *mut VMContext, $($args,)* ) -> R, >(f.address); let mut ret = None; $(let $args = $args.into_abi();)* wasmtime_runtime::catch_traps(f.vmctx, || { ret = Some(fnptr(f.vmctx, ptr::null_mut(), $($args,)*)); }).map_err(Trap::from_jit)?; Ok(ret.unwrap()) } }) } )*) } impl Func { /// Creates a new `Func` with the given arguments, typically to create a /// user-defined function to pass as an import to a module. /// /// * `store` - a cache of data where information is stored, typically /// shared with a [`Module`](crate::Module). /// /// * `ty` - the signature of this function, used to indicate what the /// inputs and outputs are, which must be WebAssembly types. /// /// * `func` - the native code invoked whenever this `Func` will be called. /// This closure is provided a [`Caller`] as its first argument to learn /// information about the caller, and then it's passed a list of /// parameters as a slice along with a mutable slice of where to write /// results. /// /// Note that the implementation of `func` must adhere to the `ty` /// signature given, error or traps may occur if it does not respect the /// `ty` signature. /// /// Additionally note that this is quite a dynamic function since signatures /// are not statically known. For a more performant `Func` it's recommended /// to use [`Func::wrap`] if you can because with statically known /// signatures the engine can optimize the implementation much more. pub fn new( store: &Store, ty: FuncType, func: impl Fn(Caller<'_>, &[Val], &mut [Val]) -> Result<(), Trap> + 'static, ) -> Self { let store_clone = store.clone(); let ty_clone = ty.clone(); // Create our actual trampoline function which translates from a bunch // of bit patterns on the stack to actual instances of `Val` being // passed to the given function. let func = Box::new(move |caller_vmctx, values_vec: *mut u128| { // We have a dynamic guarantee that `values_vec` has the right // number of arguments and the right types of arguments. As a result // we should be able to safely run through them all and read them. let mut args = Vec::with_capacity(ty_clone.params().len()); for (i, ty) in ty_clone.params().iter().enumerate() { unsafe { args.push(Val::read_value_from(values_vec.add(i), ty)); } } let mut returns = vec![Val::null(); ty_clone.results().len()]; func( Caller { store: &store_clone, caller_vmctx, }, &args, &mut returns, )?; // Unlike our arguments we need to dynamically check that the return // values produced are correct. There could be a bug in `func` that // produces the wrong number or wrong types of values, and we need // to catch that here. for (i, (ret, ty)) in returns.iter_mut().zip(ty_clone.results()).enumerate() { if ret.ty() != *ty { return Err(Trap::new( "function attempted to return an incompatible value", )); } unsafe { ret.write_value_to(values_vec.add(i)); } } Ok(()) }); let (instance, export, trampoline) = crate::trampoline::generate_func_export(&ty, func, store).expect("generated func"); Func { store: store.clone(), ty, instance, export, trampoline, } } /// Creates a new `Func` from the given Rust closure. /// /// This function will create a new `Func` which, when called, will /// execute the given Rust closure. Unlike [`Func::new`] the target /// function being called is known statically so the type signature can /// be inferred. Rust types will map to WebAssembly types as follows: /// /// | Rust Argument Type | WebAssembly Type | /// |--------------------|------------------| /// | `i32` | `i32` | /// | `i64` | `i64` | /// | `f32` | `f32` | /// | `f64` | `f64` | /// | (not supported) | `v128` | /// | (not supported) | `anyref` | /// /// Any of the Rust types can be returned from the closure as well, in /// addition to some extra types /// /// | Rust Return Type | WebAssembly Return Type | Meaning | /// |-------------------|-------------------------|-------------------| /// | `()` | nothing | no return value | /// | `Result<T, Trap>` | `T` | function may trap | /// /// At this time multi-value returns are not supported, and supporting this /// is the subject of [#1178]. /// /// [#1178]: https://github.com/bytecodealliance/wasmtime/issues/1178 /// /// Finally you can also optionally take [`Caller`] as the first argument of /// your closure. If inserted then you're able to inspect the caller's /// state, for example the [`Memory`] it has exported so you can read what /// pointers point to. /// /// Note that when using this API, the intention is to create as thin of a /// layer as possible for when WebAssembly calls the function provided. With /// sufficient inlining and optimization the WebAssembly will call straight /// into `func` provided, with no extra fluff entailed. /// /// # Examples /// /// First up we can see how simple wasm imports can be implemented, such /// as a function that adds its two arguments and returns the result. /// /// ``` /// # use wasmtime::*; /// # fn main() -> anyhow::Result<()> { /// # let store = Store::default(); /// let add = Func::wrap(&store, |a: i32, b: i32| a + b); /// let module = Module::new( /// &store, /// r#" /// (module /// (import "" "" (func $add (param i32 i32) (result i32))) /// (func (export "foo") (param i32 i32) (result i32) /// local.get 0 /// local.get 1 /// call $add)) /// "#, /// )?; /// let instance = Instance::new(&module, &[add.into()])?; /// let foo = instance.exports()[0].func().unwrap().get2::<i32, i32, i32>()?; /// assert_eq!(foo(1, 2)?, 3); /// # Ok(()) /// # } /// ``` /// /// We can also do the same thing, but generate a trap if the addition /// overflows: /// /// ``` /// # use wasmtime::*; /// # fn main() -> anyhow::Result<()> { /// # let store = Store::default(); /// let add = Func::wrap(&store, |a: i32, b: i32| { /// match a.checked_add(b) { /// Some(i) => Ok(i), /// None => Err(Trap::new("overflow")), /// } /// }); /// let module = Module::new( /// &store, /// r#" /// (module /// (import "" "" (func $add (param i32 i32) (result i32))) /// (func (export "foo") (param i32 i32) (result i32) /// local.get 0 /// local.get 1 /// call $add)) /// "#, /// )?; /// let instance = Instance::new(&module, &[add.into()])?; /// let foo = instance.exports()[0].func().unwrap().get2::<i32, i32, i32>()?; /// assert_eq!(foo(1, 2)?, 3); /// assert!(foo(i32::max_value(), 1).is_err()); /// # Ok(()) /// # } /// ``` /// /// And don't forget all the wasm types are supported! /// /// ``` /// # use wasmtime::*; /// # fn main() -> anyhow::Result<()> { /// # let store = Store::default(); /// let debug = Func::wrap(&store, |a: i32, b: f32, c: i64, d: f64| { /// println!("a={}", a); /// println!("b={}", b); /// println!("c={}", c); /// println!("d={}", d); /// }); /// let module = Module::new( /// &store, /// r#" /// (module /// (import "" "" (func $debug (param i32 f32 i64 f64))) /// (func (export "foo") /// i32.const 1 /// f32.const 2 /// i64.const 3 /// f64.const 4 /// call $debug)) /// "#, /// )?; /// let instance = Instance::new(&module, &[debug.into()])?; /// let foo = instance.exports()[0].func().unwrap().get0::<()>()?; /// foo()?; /// # Ok(()) /// # } /// ``` /// /// Finally if you want to get really fancy you can also implement /// imports that read/write wasm module's memory /// /// ``` /// use std::str; /// /// # use wasmtime::*; /// # fn main() -> anyhow::Result<()> { /// # let store = Store::default(); /// let log_str = Func::wrap(&store, |caller: Caller<'_>, ptr: i32, len: i32| { /// let mem = match caller.get_export("memory") { /// Some(Extern::Memory(mem)) => mem, /// _ => return Err(Trap::new("failed to find host memory")), /// }; /// /// // We're reading raw wasm memory here so we need `unsafe`. Note /// // though that this should be safe because we don't reenter wasm /// // while we're reading wasm memory, nor should we clash with /// // any other memory accessors (assuming they're well-behaved /// // too). /// unsafe { /// let data = mem.data_unchecked() /// .get(ptr as u32 as usize..) /// .and_then(|arr| arr.get(..len as u32 as usize)); /// let string = match data { /// Some(data) => match str::from_utf8(data) { /// Ok(s) => s, /// Err(_) => return Err(Trap::new("invalid utf-8")), /// }, /// None => return Err(Trap::new("pointer/length out of bounds")), /// }; /// assert_eq!(string, "Hello, world!"); /// println!("{}", string); /// } /// Ok(()) /// }); /// let module = Module::new( /// &store, /// r#" /// (module /// (import "" "" (func $log_str (param i32 i32))) /// (func (export "foo") /// i32.const 4 ;; ptr /// i32.const 13 ;; len /// call $log_str) /// (memory (export "memory") 1) /// (data (i32.const 4) "Hello, world!")) /// "#, /// )?; /// let instance = Instance::new(&module, &[log_str.into()])?; /// let foo = instance.exports()[0].func().unwrap().get0::<()>()?; /// foo()?; /// # Ok(()) /// # } /// ``` pub fn wrap<Params, Results>(store: &Store, func: impl IntoFunc<Params, Results>) -> Func { func.into_func(store) } /// Returns the underlying wasm type that this `Func` has. pub fn ty(&self) -> &FuncType { &self.ty } /// Returns the number of parameters that this function takes. pub fn param_arity(&self) -> usize { self.ty.params().len() } /// Returns the number of results this function produces. pub fn result_arity(&self) -> usize { self.ty.results().len() } /// Invokes this function with the `params` given, returning the results and /// any trap, if one occurs. /// /// The `params` here must match the type signature of this `Func`, or a /// trap will occur. If a trap occurs while executing this function, then a /// trap will also be returned. /// /// This function should not panic unless the underlying function itself /// initiates a panic. pub fn call(&self, params: &[Val]) -> Result<Box<[Val]>, Trap> { // We need to perform a dynamic check that the arguments given to us // match the signature of this function and are appropriate to pass to // this function. This involves checking to make sure we have the right // number and types of arguments as well as making sure everything is // from the same `Store`. if self.ty.params().len() != params.len() { return Err(Trap::new(format!( "expected {} arguments, got {}", self.ty.params().len(), params.len() ))); } let mut values_vec = vec![0; max(params.len(), self.ty.results().len())]; // Store the argument values into `values_vec`. let param_tys = self.ty.params().iter(); for ((arg, slot), ty) in params.iter().zip(&mut values_vec).zip(param_tys) { if arg.ty() != *ty { return Err(Trap::new("argument type mismatch")); } if !arg.comes_from_same_store(&self.store) { return Err(Trap::new( "cross-`Store` values are not currently supported", )); } unsafe { arg.write_value_to(slot); } } // Call the trampoline. if let Err(error) = unsafe { wasmtime_runtime::catch_traps(self.export.vmctx, || { (self.trampoline)( self.export.vmctx, ptr::null_mut(), self.export.address, values_vec.as_mut_ptr(), ) }) } { return Err(Trap::from_jit(error)); } // Load the return values out of `values_vec`. let mut results = Vec::with_capacity(self.ty.results().len()); for (index, ty) in self.ty.results().iter().enumerate() { unsafe { let ptr = values_vec.as_ptr().add(index); results.push(Val::read_value_from(ptr, ty)); } } Ok(results.into()) } pub(crate) fn wasmtime_function(&self) -> &wasmtime_runtime::ExportFunction { &self.export } pub(crate) fn from_wasmtime_function( export: wasmtime_runtime::ExportFunction, store: &Store, instance: InstanceHandle, ) -> Self { // Signatures should always be registered in the store's registry of // shared signatures, so we should be able to unwrap safely here. let sig = store .compiler() .signatures() .lookup(export.signature) .expect("failed to lookup signature"); // This is only called with `Export::Function`, and since it's coming // from wasmtime_runtime itself we should support all the types coming // out of it, so assert such here. let ty = FuncType::from_wasmtime_signature(sig) .expect("core wasm signature should be supported"); // Each function signature in a module should have a trampoline stored // on that module as well, so unwrap the result here since otherwise // it's a bug in wasmtime. let trampoline = instance .trampoline(export.signature) .expect("failed to retrieve trampoline from module"); Func { instance, export, trampoline, ty, store: store.clone(), } } getters! { /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get0) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// This function serves as an optimized version of the [`Func::call`] /// method if the type signature of a function is statically known to /// the program. This method is faster than `call` on a few metrics: /// /// * Runtime type-checking only happens once, when this method is /// called. /// * The result values, if any, aren't boxed into a vector. /// * Arguments and return values don't go through boxing and unboxing. /// * No trampolines are used to transfer control flow to/from JIT code, /// instead this function jumps directly into JIT code. /// /// For more information about which Rust types match up to which wasm /// types, see the documentation on [`Func::wrap`]. /// /// # Return /// /// This function will return `None` if the type signature asserted /// statically does not match the runtime type signature. `Some`, /// however, will be returned if the underlying function takes one /// parameter of type `A` and returns the parameter `R`. Currently `R` /// can either be `()` (no return values) or one wasm type. At this time /// a multi-value return isn't supported. /// /// The returned closure will always return a `Result<R, Trap>` and an /// `Err` is returned if a trap happens while the wasm is executing. (get1, A1) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get2, A1, A2) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get3, A1, A2, A3) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get4, A1, A2, A3, A4) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get5, A1, A2, A3, A4, A5) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get6, A1, A2, A3, A4, A5, A6) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get7, A1, A2, A3, A4, A5, A6, A7) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get8, A1, A2, A3, A4, A5, A6, A7, A8) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get9, A1, A2, A3, A4, A5, A6, A7, A8, A9) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get10, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get11, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get12, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get13, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get14, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) /// Extracts a natively-callable object from this `Func`, if the /// signature matches. /// /// See the [`Func::get1`] method for more documentation. (get15, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) } pub(crate) fn store(&self) -> &Store { &self.store } } impl fmt::Debug for Func { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "Func") } } /// A trait implemented for types which can be arguments to closures passed to /// [`Func::wrap`] and friends. /// /// This trait should not be implemented by user types. This trait may change at /// any time internally. The types which implement this trait, however, are /// stable over time. /// /// For more information see [`Func::wrap`] pub unsafe trait WasmTy: Copy { #[doc(hidden)] fn push(dst: &mut Vec<ValType>); #[doc(hidden)] fn matches(tys: impl Iterator<Item = ValType>) -> anyhow::Result<()>; #[doc(hidden)] unsafe fn load(ptr: &mut *const u128) -> Self; #[doc(hidden)] unsafe fn store(abi: Self, ptr: *mut u128); } unsafe impl WasmTy for () { fn push(_dst: &mut Vec<ValType>) {} fn matches(_tys: impl Iterator<Item = ValType>) -> anyhow::Result<()> { Ok(()) } #[inline] unsafe fn load(_ptr: &mut *const u128) -> Self {} #[inline] unsafe fn store(_abi: Self, _ptr: *mut u128) {} } unsafe impl WasmTy for i32 { fn push(dst: &mut Vec<ValType>) { dst.push(ValType::I32); } fn matches(mut tys: impl Iterator<Item = ValType>) -> anyhow::Result<()> { let next = tys.next(); ensure!( next == Some(ValType::I32), "Type mismatch, expected i32, got {:?}", next ); Ok(()) } #[inline] unsafe fn load(ptr: &mut *const u128) -> Self { let ret = **ptr as Self; *ptr = (*ptr).add(1); return ret; } #[inline] unsafe fn store(abi: Self, ptr: *mut u128) { *ptr = abi as u128; } } unsafe impl WasmTy for i64 { fn push(dst: &mut Vec<ValType>) { dst.push(ValType::I64); } fn matches(mut tys: impl Iterator<Item = ValType>) -> anyhow::Result<()> { let next = tys.next(); ensure!( next == Some(ValType::I64), "Type mismatch, expected i64, got {:?}", next ); Ok(()) } #[inline] unsafe fn load(ptr: &mut *const u128) -> Self { let ret = **ptr as Self; *ptr = (*ptr).add(1); return ret; } #[inline] unsafe fn store(abi: Self, ptr: *mut u128) { *ptr = abi as u128; } } unsafe impl WasmTy for f32 { fn push(dst: &mut Vec<ValType>) { dst.push(ValType::F32); } fn matches(mut tys: impl Iterator<Item = ValType>) -> anyhow::Result<()> { let next = tys.next(); ensure!( next == Some(ValType::F32), "Type mismatch, expected f32, got {:?}", next ); Ok(()) } #[inline] unsafe fn load(ptr: &mut *const u128) -> Self { let ret = f32::from_bits(**ptr as u32); *ptr = (*ptr).add(1); return ret; } #[inline] unsafe fn store(abi: Self, ptr: *mut u128) { *ptr = abi.to_bits() as u128; } } unsafe impl WasmTy for f64 { fn push(dst: &mut Vec<ValType>) { dst.push(ValType::F64); } fn matches(mut tys: impl Iterator<Item = ValType>) -> anyhow::Result<()> { let next = tys.next(); ensure!( next == Some(ValType::F64), "Type mismatch, expected f64, got {:?}", next ); Ok(()) } #[inline] unsafe fn load(ptr: &mut *const u128) -> Self { let ret = f64::from_bits(**ptr as u64); *ptr = (*ptr).add(1); return ret; } #[inline] unsafe fn store(abi: Self, ptr: *mut u128) { *ptr = abi.to_bits() as u128; } } /// A trait implemented for types which can be returned from closures passed to /// [`Func::wrap`] and friends. /// /// This trait should not be implemented by user types. This trait may change at /// any time internally. The types which implement this trait, however, are /// stable over time. /// /// For more information see [`Func::wrap`] pub unsafe trait WasmRet { #[doc(hidden)] type Abi; #[doc(hidden)] fn push(dst: &mut Vec<ValType>); #[doc(hidden)] fn matches(tys: impl Iterator<Item = ValType>) -> anyhow::Result<()>; #[doc(hidden)] fn into_abi(self) -> Self::Abi; #[doc(hidden)] unsafe fn store(abi: Self::Abi, ptr: *mut u128); } unsafe impl<T: WasmTy> WasmRet for T { type Abi = T; fn push(dst: &mut Vec<ValType>) { T::push(dst) } fn matches(tys: impl Iterator<Item = ValType>) -> anyhow::Result<()> { T::matches(tys) } #[inline] fn into_abi(self) -> Self::Abi { self } #[inline] unsafe fn store(abi: Self::Abi, ptr: *mut u128) { T::store(abi, ptr); } } unsafe impl<T: WasmTy> WasmRet for Result<T, Trap> { type Abi = T; fn push(dst: &mut Vec<ValType>) { T::push(dst) } fn matches(tys: impl Iterator<Item = ValType>) -> anyhow::Result<()> { T::matches(tys) } #[inline] fn into_abi(self) -> Self::Abi { match self { Ok(val) => return T::into_abi(val), Err(trap) => handle_trap(trap), } fn handle_trap(trap: Trap) -> ! { unsafe { wasmtime_runtime::raise_user_trap(Box::new(trap)) } } } #[inline] unsafe fn store(abi: Self::Abi, ptr: *mut u128) { T::store(abi, ptr); } } /// Internal trait implemented for all arguments that can be passed to /// [`Func::wrap`]. /// /// This trait should not be implemented by external users, it's only intended /// as an implementation detail of this crate. pub trait IntoFunc<Params, Results> { #[doc(hidden)] fn into_func(self, store: &Store) -> Func; } /// A structure representing the *caller's* context when creating a function /// via [`Func::wrap`]. /// /// This structure can be taken as the first parameter of a closure passed to /// [`Func::wrap`], and it can be used to learn information about the caller of /// the function, such as the calling module's memory, exports, etc. /// /// The primary purpose of this structure is to provide access to the /// caller's information, such as it's exported memory. This allows /// functions which take pointers as arguments to easily read the memory the /// pointers point into. /// /// Note that this is intended to be a pretty temporary mechanism for accessing /// the caller's memory until interface types has been fully standardized and /// implemented. pub struct Caller<'a> { store: &'a Store, caller_vmctx: *mut VMContext, } impl Caller<'_> { /// Looks up an export from the caller's module by the `name` given. /// /// Note that this function is only implemented for the `Extern::Memory` /// type currently. No other exported structure can be acquired through this /// just yet, but this may be implemented in the future! /// /// # Return /// /// If a memory export with the `name` provided was found, then it is /// returned as a `Memory`. There are a number of situations, however, where /// the memory may not be available: /// /// * The caller instance may not have an export named `name` /// * The export named `name` may not be an exported memory /// * There may not be a caller available, for example if `Func` was called /// directly from host code. /// /// It's recommended to take care when calling this API and gracefully /// handling a `None` return value. pub fn get_export(&self, name: &str) -> Option<Extern> { unsafe { if self.caller_vmctx.is_null() { return None; } let instance = InstanceHandle::from_vmctx(self.caller_vmctx); let export = match instance.lookup(name) { Some(Export::Memory(m)) => m, _ => return None, }; let mem = Memory::from_wasmtime_memory(export, self.store, instance); Some(Extern::Memory(mem)) } } } macro_rules! impl_into_func { ($( ($($args:ident)*) )*) => ($( // Implement for functions without a leading `&Caller` parameter, // delegating to the implementation below which does have the leading // `Caller` parameter. impl<F, $($args,)* R> IntoFunc<($($args,)*), R> for F where F: Fn($($args),*) -> R + 'static, $($args: WasmTy,)* R: WasmRet, { #[allow(non_snake_case)] fn into_func(self, store: &Store) -> Func { Func::wrap(store, move |_: Caller<'_>, $($args:$args),*| { self($($args),*) }) } } #[allow(non_snake_case)] impl<F, $($args,)* R> IntoFunc<(Caller<'_>, $($args,)*), R> for F where F: Fn(Caller<'_>, $($args),*) -> R + 'static, $($args: WasmTy,)* R: WasmRet, { fn into_func(self, store: &Store) -> Func { // Note that this shim's ABI must match that expected by // cranelift, since cranelift is generating raw function calls // directly to this function. unsafe extern "C" fn shim<F, $($args,)* R>( vmctx: *mut VMContext, caller_vmctx: *mut VMContext, $($args: $args,)* ) -> R::Abi where F: Fn(Caller<'_>, $($args),*) -> R + 'static, $($args: WasmTy,)* R: WasmRet, { let ret = { let instance = InstanceHandle::from_vmctx(vmctx); let (func, store) = instance.host_state().downcast_ref::<(F, Store)>().expect("state"); panic::catch_unwind(AssertUnwindSafe(|| { func( Caller { store, caller_vmctx }, $($args,)* ) })) }; match ret { Ok(ret) => ret.into_abi(), Err(panic) => wasmtime_runtime::resume_panic(panic), } } unsafe extern "C" fn trampoline<$($args,)* R>( callee_vmctx: *mut VMContext, caller_vmctx: *mut VMContext, ptr: *const VMFunctionBody, args: *mut u128, ) where $($args: WasmTy,)* R: WasmRet, { let ptr = mem::transmute::< *const VMFunctionBody, unsafe extern "C" fn( *mut VMContext, *mut VMContext, $($args,)* ) -> R::Abi, >(ptr); let mut _next = args as *const u128; $(let $args = $args::load(&mut _next);)* let ret = ptr(callee_vmctx, caller_vmctx, $($args),*); R::store(ret, args); } let mut _args = Vec::new(); $($args::push(&mut _args);)* let mut ret = Vec::new(); R::push(&mut ret); let ty = FuncType::new(_args.into(), ret.into()); let store_clone = store.clone(); unsafe { let trampoline = trampoline::<$($args,)* R>; let (instance, export) = crate::trampoline::generate_raw_func_export( &ty, std::slice::from_raw_parts_mut( shim::<F, $($args,)* R> as *mut _, 0, ), trampoline, store, Box::new((self, store_clone)), ) .expect("failed to generate export"); Func { store: store.clone(), ty, instance, export, trampoline, } } } } )*) } impl_into_func! { () (A1) (A1 A2) (A1 A2 A3) (A1 A2 A3 A4) (A1 A2 A3 A4 A5) (A1 A2 A3 A4 A5 A6) (A1 A2 A3 A4 A5 A6 A7) (A1 A2 A3 A4 A5 A6 A7 A8) (A1 A2 A3 A4 A5 A6 A7 A8 A9) (A1 A2 A3 A4 A5 A6 A7 A8 A9 A10) (A1 A2 A3 A4 A5 A6 A7 A8 A9 A10 A11) (A1 A2 A3 A4 A5 A6 A7 A8 A9 A10 A11 A12) (A1 A2 A3 A4 A5 A6 A7 A8 A9 A10 A11 A12 A13) (A1 A2 A3 A4 A5 A6 A7 A8 A9 A10 A11 A12 A13 A14) (A1 A2 A3 A4 A5 A6 A7 A8 A9 A10 A11 A12 A13 A14 A15) }