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 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
use std::{
collections::HashMap,
ops::Deref,
path::{Path, PathBuf},
sync::Arc,
time::Duration,
};
use futures::future::BoxFuture;
use rand::Rng;
use virtual_fs::{FileSystem, FsError, StaticFile, VirtualFile};
use virtual_net::DynVirtualNetworking;
use wasmer::{
AsStoreMut, AsStoreRef, FunctionEnvMut, Global, Imports, Instance, Memory, MemoryType,
MemoryView, Module, TypedFunction,
};
use wasmer_config::package::PackageSource;
use wasmer_wasix_types::{
types::Signal,
wasi::{Errno, ExitCode, Snapshot0Clockid},
wasix::ThreadStartType,
};
use webc::metadata::annotations::Wasi;
#[cfg(feature = "journal")]
use crate::journal::{DynJournal, JournalEffector, SnapshotTrigger};
use crate::{
bin_factory::{BinFactory, BinaryPackage, BinaryPackageCommand},
capabilities::Capabilities,
fs::{WasiFsRoot, WasiInodes},
import_object_for_all_wasi_versions,
os::task::{
control_plane::ControlPlaneError,
process::{WasiProcess, WasiProcessId},
thread::{WasiMemoryLayout, WasiThread, WasiThreadHandle, WasiThreadId},
},
runtime::{task_manager::InlineWaker, SpawnMemoryType},
syscalls::platform_clock_time_get,
Runtime, VirtualTaskManager, WasiControlPlane, WasiEnvBuilder, WasiError, WasiFunctionEnv,
WasiResult, WasiRuntimeError, WasiStateCreationError, WasiVFork,
};
use wasmer_types::ModuleHash;
pub(crate) use super::handles::*;
use super::{conv_env_vars, WasiState};
/// Various [`TypedFunction`] and [`Global`] handles for an active WASI(X) instance.
///
/// Used to access and modify runtime state.
// TODO: make fields private
#[derive(Debug, Clone)]
pub struct WasiInstanceHandles {
// TODO: the two fields below are instance specific, while all others are module specific.
// Should be split up.
/// Represents a reference to the memory
pub(crate) memory: Memory,
pub(crate) instance: wasmer::Instance,
/// Points to the current location of the memory stack pointer
pub(crate) stack_pointer: Option<Global>,
/// Points to the end of the data section
pub(crate) data_end: Option<Global>,
/// Points to the lower end of the stack
pub(crate) stack_low: Option<Global>,
/// Points to the higher end of the stack
pub(crate) stack_high: Option<Global>,
/// Main function that will be invoked (name = "_start")
pub(crate) start: Option<TypedFunction<(), ()>>,
/// Function thats invoked to initialize the WASM module (name = "_initialize")
// TODO: review allow...
#[allow(dead_code)]
pub(crate) initialize: Option<TypedFunction<(), ()>>,
/// Represents the callback for spawning a thread (name = "wasi_thread_start")
/// (due to limitations with i64 in browsers the parameters are broken into i32 pairs)
/// [this takes a user_data field]
pub(crate) thread_spawn: Option<TypedFunction<(i32, i32), ()>>,
/// Represents the callback for signals (name = "__wasm_signal")
/// Signals are triggered asynchronously at idle times of the process
pub(crate) signal: Option<TypedFunction<i32, ()>>,
/// Flag that indicates if the signal callback has been set by the WASM
/// process - if it has not been set then the runtime behaves differently
/// when a CTRL-C is pressed.
pub(crate) signal_set: bool,
/// Flag that indicates if the stack capture exports are being used by
/// this WASM process which means that it will be using asyncify
pub(crate) has_stack_checkpoint: bool,
/// asyncify_start_unwind(data : i32): call this to start unwinding the
/// stack from the current location. "data" must point to a data
/// structure as described above (with fields containing valid data).
// TODO: review allow...
#[allow(dead_code)]
pub(crate) asyncify_start_unwind: Option<TypedFunction<i32, ()>>,
/// asyncify_stop_unwind(): call this to note that unwinding has
/// concluded. If no other code will run before you start to rewind,
/// this is not strictly necessary, however, if you swap between
/// coroutines, or even just want to run some normal code during a
/// "sleep", then you must call this at the proper time. Otherwise,
/// the code will think it is still unwinding when it should not be,
/// which means it will keep unwinding in a meaningless way.
// TODO: review allow...
#[allow(dead_code)]
pub(crate) asyncify_stop_unwind: Option<TypedFunction<(), ()>>,
/// asyncify_start_rewind(data : i32): call this to start rewinding the
/// stack vack up to the location stored in the provided data. This prepares
/// for the rewind; to start it, you must call the first function in the
/// call stack to be unwound.
// TODO: review allow...
#[allow(dead_code)]
pub(crate) asyncify_start_rewind: Option<TypedFunction<i32, ()>>,
/// asyncify_stop_rewind(): call this to note that rewinding has
/// concluded, and normal execution can resume.
// TODO: review allow...
#[allow(dead_code)]
pub(crate) asyncify_stop_rewind: Option<TypedFunction<(), ()>>,
/// asyncify_get_state(): call this to get the current value of the
/// internal "__asyncify_state" variable as described above.
/// It can be used to distinguish between unwinding/rewinding and normal
/// calls, so that you know when to start an asynchronous operation and
/// when to propagate results back.
#[allow(dead_code)]
pub(crate) asyncify_get_state: Option<TypedFunction<(), i32>>,
}
impl WasiInstanceHandles {
pub fn new(memory: Memory, store: &impl AsStoreRef, instance: Instance) -> Self {
let has_stack_checkpoint = instance
.module()
.imports()
.any(|f| f.name() == "stack_checkpoint");
WasiInstanceHandles {
memory,
stack_pointer: instance.exports.get_global("__stack_pointer").cloned().ok(),
data_end: instance.exports.get_global("__data_end").cloned().ok(),
stack_low: instance.exports.get_global("__stack_low").cloned().ok(),
stack_high: instance.exports.get_global("__stack_high").cloned().ok(),
start: instance.exports.get_typed_function(store, "_start").ok(),
initialize: instance
.exports
.get_typed_function(store, "_initialize")
.ok(),
thread_spawn: instance
.exports
.get_typed_function(store, "wasi_thread_start")
.ok(),
signal: instance
.exports
.get_typed_function(&store, "__wasm_signal")
.ok(),
has_stack_checkpoint,
signal_set: false,
asyncify_start_unwind: instance
.exports
.get_typed_function(store, "asyncify_start_unwind")
.ok(),
asyncify_stop_unwind: instance
.exports
.get_typed_function(store, "asyncify_stop_unwind")
.ok(),
asyncify_start_rewind: instance
.exports
.get_typed_function(store, "asyncify_start_rewind")
.ok(),
asyncify_stop_rewind: instance
.exports
.get_typed_function(store, "asyncify_stop_rewind")
.ok(),
asyncify_get_state: instance
.exports
.get_typed_function(store, "asyncify_get_state")
.ok(),
instance,
}
}
pub fn module(&self) -> &Module {
self.instance.module()
}
pub fn module_clone(&self) -> Module {
self.instance.module().clone()
}
/// Providers safe access to the memory
/// (it must be initialized before it can be used)
pub fn memory_view<'a>(&'a self, store: &'a (impl AsStoreRef + ?Sized)) -> MemoryView<'a> {
self.memory.view(store)
}
/// Providers safe access to the memory
/// (it must be initialized before it can be used)
pub fn memory(&self) -> &Memory {
&self.memory
}
/// Copy the lazy reference so that when it's initialized during the
/// export phase, all the other references get a copy of it
pub fn memory_clone(&self) -> Memory {
self.memory.clone()
}
pub fn instance(&self) -> &Instance {
&self.instance
}
}
/// Data required to construct a [`WasiEnv`].
#[derive(Debug)]
pub struct WasiEnvInit {
pub(crate) state: WasiState,
pub runtime: Arc<dyn Runtime + Send + Sync>,
pub webc_dependencies: Vec<BinaryPackage>,
pub mapped_commands: HashMap<String, PathBuf>,
pub bin_factory: BinFactory,
pub capabilities: Capabilities,
pub control_plane: WasiControlPlane,
pub memory_ty: Option<MemoryType>,
pub process: Option<WasiProcess>,
pub thread: Option<WasiThreadHandle>,
/// Whether to call the `_initialize` function in the WASI module.
/// Will be true for regular new instances, but false for threads.
pub call_initialize: bool,
/// Indicates if the calling environment is capable of deep sleeping
pub can_deep_sleep: bool,
/// Indicates if extra tracing should be output
pub extra_tracing: bool,
/// Additional functionality provided to the WASIX instance, besides the
/// normal WASIX syscalls.
pub additional_imports: Imports,
/// Indicates triggers that will cause a snapshot to be taken
#[cfg(feature = "journal")]
pub snapshot_on: Vec<SnapshotTrigger>,
}
impl WasiEnvInit {
pub fn duplicate(&self) -> Self {
let inodes = WasiInodes::new();
// TODO: preserve preopens?
let fs =
crate::fs::WasiFs::new_with_preopen(&inodes, &[], &[], self.state.fs.root_fs.clone())
.unwrap();
Self {
state: WasiState {
secret: rand::thread_rng().gen::<[u8; 32]>(),
inodes,
fs,
futexs: Default::default(),
clock_offset: std::sync::Mutex::new(
self.state.clock_offset.lock().unwrap().clone(),
),
args: std::sync::Mutex::new(self.state.args.lock().unwrap().clone()),
envs: std::sync::Mutex::new(self.state.envs.lock().unwrap().deref().clone()),
preopen: self.state.preopen.clone(),
},
runtime: self.runtime.clone(),
webc_dependencies: self.webc_dependencies.clone(),
mapped_commands: self.mapped_commands.clone(),
bin_factory: self.bin_factory.clone(),
capabilities: self.capabilities.clone(),
control_plane: self.control_plane.clone(),
memory_ty: None,
process: None,
thread: None,
call_initialize: self.call_initialize,
can_deep_sleep: self.can_deep_sleep,
extra_tracing: false,
#[cfg(feature = "journal")]
snapshot_on: self.snapshot_on.clone(),
additional_imports: self.additional_imports.clone(),
}
}
}
/// The environment provided to the WASI imports.
pub struct WasiEnv {
pub control_plane: WasiControlPlane,
/// Represents the process this environment is attached to
pub process: WasiProcess,
/// Represents the thread this environment is attached to
pub thread: WasiThread,
/// Represents the layout of the memory
pub layout: WasiMemoryLayout,
/// Represents a fork of the process that is currently in play
pub vfork: Option<WasiVFork>,
/// Seed used to rotate around the events returned by `poll_oneoff`
pub poll_seed: u64,
/// Shared state of the WASI system. Manages all the data that the
/// executing WASI program can see.
pub(crate) state: Arc<WasiState>,
/// Binary factory attached to this environment
pub bin_factory: BinFactory,
/// List of the handles that are owned by this context
/// (this can be used to ensure that threads own themselves or others)
pub owned_handles: Vec<WasiThreadHandle>,
/// Implementation of the WASI runtime.
pub runtime: Arc<dyn Runtime + Send + Sync + 'static>,
pub capabilities: Capabilities,
/// Is this environment capable and setup for deep sleeping
pub enable_deep_sleep: bool,
/// Enables the snap shotting functionality
pub enable_journal: bool,
/// Enables an exponential backoff of the process CPU usage when there
/// are no active run tokens (when set holds the maximum amount of
/// time that it will pause the CPU)
pub enable_exponential_cpu_backoff: Option<Duration>,
/// Flag that indicates if the environment is currently replaying the journal
/// (and hence it should not record new events)
pub replaying_journal: bool,
/// Flag that indicates the cleanup of the environment is to be disabled
/// (this is normally used so that the instance can be reused later on)
pub(crate) disable_fs_cleanup: bool,
/// Inner functions and references that are loaded before the environment starts
/// (inner is not safe to send between threads and so it is private and will
/// not be cloned when `WasiEnv` is cloned)
/// TODO: We should move this outside of `WasiEnv` with some refactoring
inner: WasiInstanceHandlesPointer,
}
impl std::fmt::Debug for WasiEnv {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "env(pid={}, tid={})", self.pid().raw(), self.tid().raw())
}
}
impl Clone for WasiEnv {
fn clone(&self) -> Self {
Self {
control_plane: self.control_plane.clone(),
process: self.process.clone(),
poll_seed: self.poll_seed,
thread: self.thread.clone(),
layout: self.layout.clone(),
vfork: self.vfork.clone(),
state: self.state.clone(),
bin_factory: self.bin_factory.clone(),
inner: Default::default(),
owned_handles: self.owned_handles.clone(),
runtime: self.runtime.clone(),
capabilities: self.capabilities.clone(),
enable_deep_sleep: self.enable_deep_sleep,
enable_journal: self.enable_journal,
enable_exponential_cpu_backoff: self.enable_exponential_cpu_backoff,
replaying_journal: self.replaying_journal,
disable_fs_cleanup: self.disable_fs_cleanup,
}
}
}
impl WasiEnv {
/// Construct a new [`WasiEnvBuilder`] that allows customizing an environment.
pub fn builder(program_name: impl Into<String>) -> WasiEnvBuilder {
WasiEnvBuilder::new(program_name)
}
/// Forking the WasiState is used when either fork or vfork is called
pub fn fork(&self) -> Result<(Self, WasiThreadHandle), ControlPlaneError> {
let process = self.control_plane.new_process(self.process.module_hash)?;
let handle = process.new_thread(self.layout.clone(), ThreadStartType::MainThread)?;
let thread = handle.as_thread();
thread.copy_stack_from(&self.thread);
let state = Arc::new(self.state.fork());
let bin_factory = self.bin_factory.clone();
let new_env = Self {
control_plane: self.control_plane.clone(),
process,
thread,
layout: self.layout.clone(),
vfork: None,
poll_seed: 0,
bin_factory,
state,
inner: Default::default(),
owned_handles: Vec::new(),
runtime: self.runtime.clone(),
capabilities: self.capabilities.clone(),
enable_deep_sleep: self.enable_deep_sleep,
enable_journal: self.enable_journal,
enable_exponential_cpu_backoff: self.enable_exponential_cpu_backoff,
replaying_journal: false,
disable_fs_cleanup: self.disable_fs_cleanup,
};
Ok((new_env, handle))
}
pub fn pid(&self) -> WasiProcessId {
self.process.pid()
}
pub fn tid(&self) -> WasiThreadId {
self.thread.tid()
}
/// Returns true if this WASM process will need and try to use
/// asyncify while its running which normally means.
pub fn will_use_asyncify(&self) -> bool {
self.enable_deep_sleep || unsafe { self.inner().has_stack_checkpoint }
}
/// Re-initializes this environment so that it can be executed again
pub fn reinit(&mut self) -> Result<(), WasiStateCreationError> {
// If the cleanup logic is enabled then we need to rebuild the
// file descriptors which would have been destroyed when the
// main thread exited
if !self.disable_fs_cleanup {
// First we clear any open files as the descriptors would
// otherwise clash
if let Ok(mut map) = self.state.fs.fd_map.write() {
map.clear();
}
self.state.fs.preopen_fds.write().unwrap().clear();
*self.state.fs.current_dir.lock().unwrap() = "/".to_string();
// We need to rebuild the basic file descriptors
self.state.fs.create_stdin(&self.state.inodes);
self.state.fs.create_stdout(&self.state.inodes);
self.state.fs.create_stderr(&self.state.inodes);
self.state
.fs
.create_rootfd()
.map_err(WasiStateCreationError::WasiFsSetupError)?;
self.state
.fs
.create_preopens(&self.state.inodes, true)
.map_err(WasiStateCreationError::WasiFsSetupError)?;
}
// The process and thread state need to be reset
self.process = WasiProcess::new(
self.process.pid,
self.process.module_hash,
self.process.compute.clone(),
);
self.thread = WasiThread::new(
self.thread.pid(),
self.thread.tid(),
self.thread.is_main(),
self.process.finished.clone(),
self.process.compute.must_upgrade().register_task()?,
self.thread.memory_layout().clone(),
self.thread.thread_start_type(),
);
Ok(())
}
/// Returns true if this module is capable of deep sleep
/// (needs asyncify to unwind and rewin)
///
/// # Safety
///
/// This function should only be called from within a syscall
/// as it accessed objects that are a thread local (functions)
pub unsafe fn capable_of_deep_sleep(&self) -> bool {
if !self.control_plane.config().enable_asynchronous_threading {
return false;
}
let inner = self.inner();
inner.asyncify_get_state.is_some()
&& inner.asyncify_start_rewind.is_some()
&& inner.asyncify_start_unwind.is_some()
}
/// Returns true if this thread can go into a deep sleep
pub fn layout(&self) -> &WasiMemoryLayout {
&self.layout
}
#[allow(clippy::result_large_err)]
pub(crate) fn from_init(
init: WasiEnvInit,
module_hash: ModuleHash,
) -> Result<Self, WasiRuntimeError> {
let process = if let Some(p) = init.process {
p
} else {
init.control_plane.new_process(module_hash)?
};
#[cfg(feature = "journal")]
{
process.inner.0.lock().unwrap().snapshot_on = init.snapshot_on.into_iter().collect();
}
let layout = WasiMemoryLayout::default();
let thread = if let Some(t) = init.thread {
t
} else {
process.new_thread(layout.clone(), ThreadStartType::MainThread)?
};
let mut env = Self {
control_plane: init.control_plane,
process,
thread: thread.as_thread(),
layout,
vfork: None,
poll_seed: 0,
state: Arc::new(init.state),
inner: Default::default(),
owned_handles: Vec::new(),
#[cfg(feature = "journal")]
enable_journal: init.runtime.active_journal().is_some(),
#[cfg(not(feature = "journal"))]
enable_journal: false,
replaying_journal: false,
enable_deep_sleep: init.capabilities.threading.enable_asynchronous_threading,
enable_exponential_cpu_backoff: init
.capabilities
.threading
.enable_exponential_cpu_backoff,
runtime: init.runtime,
bin_factory: init.bin_factory,
capabilities: init.capabilities,
disable_fs_cleanup: false,
};
env.owned_handles.push(thread);
// TODO: should not be here - should be callers responsibility!
for pkg in &init.webc_dependencies {
env.use_package(pkg)?;
}
#[cfg(feature = "sys")]
env.map_commands(init.mapped_commands.clone())?;
Ok(env)
}
// FIXME: use custom error type
#[allow(clippy::result_large_err)]
pub(crate) fn instantiate(
mut init: WasiEnvInit,
module: Module,
module_hash: ModuleHash,
store: &mut impl AsStoreMut,
) -> Result<(Instance, WasiFunctionEnv), WasiRuntimeError> {
let call_initialize = init.call_initialize;
let spawn_type = init.memory_ty.take();
if init.extra_tracing {
for import in module.imports() {
tracing::trace!("import {}.{}", import.module(), import.name());
}
}
let additional_imports = init.additional_imports.clone();
let env = Self::from_init(init, module_hash)?;
let pid = env.process.pid();
let mut store = store.as_store_mut();
let tasks = env.runtime.task_manager().clone();
let mut func_env = WasiFunctionEnv::new(&mut store, env);
// Determine if shared memory needs to be created and imported
let shared_memory = module.imports().memories().next().map(|a| *a.ty());
// Determine if we are going to create memory and import it or just rely on self creation of memory
let spawn_type = if let Some(t) = spawn_type {
SpawnMemoryType::CreateMemoryOfType(t)
} else {
match shared_memory {
Some(ty) => SpawnMemoryType::CreateMemoryOfType(ty),
None => SpawnMemoryType::CreateMemory,
}
};
let memory = tasks.build_memory(&mut store, spawn_type)?;
// Let's instantiate the module with the imports.
let (mut import_object, instance_init_callback) =
import_object_for_all_wasi_versions(&module, &mut store, &func_env.env);
for ((namespace, name), value) in &additional_imports {
// Note: We don't want to let downstream users override WASIX
// syscalls
if !import_object.exists(&namespace, &name) {
import_object.define(&namespace, &name, value);
}
}
let imported_memory = if let Some(memory) = memory {
import_object.define("env", "memory", memory.clone());
Some(memory)
} else {
None
};
// Construct the instance.
let instance = match Instance::new(&mut store, &module, &import_object) {
Ok(a) => a,
Err(err) => {
tracing::error!(
%pid,
error = &err as &dyn std::error::Error,
"Instantiation failed",
);
func_env
.data(&store)
.blocking_on_exit(Some(Errno::Noexec.into()));
return Err(err.into());
}
};
// Run initializers.
instance_init_callback(&instance, &store).unwrap();
// Initialize the WASI environment
if let Err(err) =
func_env.initialize_with_memory(&mut store, instance.clone(), imported_memory, true)
{
tracing::error!(
%pid,
error = &err as &dyn std::error::Error,
"Initialization failed",
);
func_env
.data(&store)
.blocking_on_exit(Some(Errno::Noexec.into()));
return Err(err.into());
}
// If this module exports an _initialize function, run that first.
if call_initialize {
if let Ok(initialize) = instance.exports.get_function("_initialize") {
if let Err(err) = crate::run_wasi_func_start(initialize, &mut store) {
func_env
.data(&store)
.blocking_on_exit(Some(Errno::Noexec.into()));
return Err(err);
}
}
}
Ok((instance, func_env))
}
/// Returns a copy of the current runtime implementation for this environment
pub fn runtime(&self) -> &(dyn Runtime + Send + Sync) {
self.runtime.deref()
}
/// Returns a copy of the current tasks implementation for this environment
pub fn tasks(&self) -> &Arc<dyn VirtualTaskManager> {
self.runtime.task_manager()
}
pub fn fs_root(&self) -> &WasiFsRoot {
&self.state.fs.root_fs
}
/// Overrides the runtime implementation for this environment
pub fn set_runtime<R>(&mut self, runtime: R)
where
R: Runtime + Send + Sync + 'static,
{
self.runtime = Arc::new(runtime);
}
/// Returns the number of active threads
pub fn active_threads(&self) -> u32 {
self.process.active_threads()
}
/// Porcesses any signals that are batched up or any forced exit codes
pub fn process_signals_and_exit(ctx: &mut FunctionEnvMut<'_, Self>) -> WasiResult<bool> {
// If a signal handler has never been set then we need to handle signals
// differently
let env = ctx.data();
let inner = env
.try_inner()
.ok_or_else(|| WasiError::Exit(Errno::Fault.into()))?;
if !inner.signal_set {
let signals = env.thread.pop_signals();
if !signals.is_empty() {
for sig in signals {
if sig == Signal::Sigint
|| sig == Signal::Sigquit
|| sig == Signal::Sigkill
|| sig == Signal::Sigabrt
{
let exit_code = env.thread.set_or_get_exit_code_for_signal(sig);
return Err(WasiError::Exit(exit_code));
} else {
tracing::trace!(pid=%env.pid(), ?sig, "Signal ignored");
}
}
return Ok(Ok(true));
}
}
// Check for forced exit
if let Some(forced_exit) = env.should_exit() {
return Err(WasiError::Exit(forced_exit));
}
Self::process_signals(ctx)
}
/// Porcesses any signals that are batched up
pub(crate) fn process_signals(ctx: &mut FunctionEnvMut<'_, Self>) -> WasiResult<bool> {
// If a signal handler has never been set then we need to handle signals
// differently
let env = ctx.data();
let inner = env
.try_inner()
.ok_or_else(|| WasiError::Exit(Errno::Fault.into()))?;
if !inner.signal_set {
return Ok(Ok(false));
}
// Check for any signals that we need to trigger
// (but only if a signal handler is registered)
let ret = if inner.signal.as_ref().is_some() {
let signals = env.thread.pop_signals();
Self::process_signals_internal(ctx, signals)?
} else {
false
};
Ok(Ok(ret))
}
pub(crate) fn process_signals_internal(
ctx: &mut FunctionEnvMut<'_, Self>,
mut signals: Vec<Signal>,
) -> Result<bool, WasiError> {
let env = ctx.data();
let inner = env
.try_inner()
.ok_or_else(|| WasiError::Exit(Errno::Fault.into()))?;
if let Some(handler) = inner.signal.clone() {
// We might also have signals that trigger on timers
let mut now = 0;
{
let mut has_signal_interval = false;
let inner = env.process.inner.0.lock().unwrap();
if !inner.signal_intervals.is_empty() {
now = platform_clock_time_get(Snapshot0Clockid::Monotonic, 1_000_000).unwrap()
as u128;
for signal in inner.signal_intervals.values() {
let elapsed = now - signal.last_signal;
if elapsed >= signal.interval.as_nanos() {
has_signal_interval = true;
break;
}
}
}
if has_signal_interval {
let mut inner = env.process.inner.0.lock().unwrap();
for signal in inner.signal_intervals.values_mut() {
let elapsed = now - signal.last_signal;
if elapsed >= signal.interval.as_nanos() {
signal.last_signal = now;
signals.push(signal.signal);
}
}
}
}
for signal in signals {
tracing::trace!(
pid=%ctx.data().pid(),
?signal,
"processing signal via handler",
);
if let Err(err) = handler.call(ctx, signal as i32) {
match err.downcast::<WasiError>() {
Ok(wasi_err) => {
tracing::warn!(
pid=%ctx.data().pid(),
wasi_err=&wasi_err as &dyn std::error::Error,
"signal handler wasi error",
);
return Err(wasi_err);
}
Err(runtime_err) => {
// anything other than a kill command should report
// the error, killed things may not gracefully close properly
if signal != Signal::Sigkill {
tracing::warn!(
pid=%ctx.data().pid(),
runtime_err=&runtime_err as &dyn std::error::Error,
"signal handler runtime error",
);
}
return Err(WasiError::Exit(Errno::Intr.into()));
}
}
}
tracing::trace!(
pid=%ctx.data().pid(),
"signal processed",
);
}
Ok(true)
} else {
tracing::trace!("no signal handler");
Ok(false)
}
}
/// Returns an exit code if the thread or process has been forced to exit
pub fn should_exit(&self) -> Option<ExitCode> {
// Check for forced exit
if let Some(forced_exit) = self.thread.try_join() {
return Some(forced_exit.unwrap_or_else(|err| {
tracing::debug!(
error = &*err as &dyn std::error::Error,
"exit runtime error",
);
Errno::Child.into()
}));
}
if let Some(forced_exit) = self.process.try_join() {
return Some(forced_exit.unwrap_or_else(|err| {
tracing::debug!(
error = &*err as &dyn std::error::Error,
"exit runtime error",
);
Errno::Child.into()
}));
}
None
}
/// Accesses the virtual networking implementation
pub fn net(&self) -> &DynVirtualNetworking {
self.runtime.networking()
}
/// Providers safe access to the initialized part of WasiEnv
/// (it must be initialized before it can be used)
/// This has been marked as unsafe as it will panic if its executed
/// on the wrong thread or before the inner is set
pub(crate) unsafe fn inner(&self) -> WasiInstanceGuard<'_> {
self.inner.get().expect(
"You must initialize the WasiEnv before using it and can not pass it between threads",
)
}
/// Providers safe access to the initialized part of WasiEnv
pub(crate) fn try_inner(&self) -> Option<WasiInstanceGuard<'_>> {
self.inner.get()
}
/// Providers safe access to the initialized part of WasiEnv
/// (it must be initialized before it can be used)
pub(crate) fn try_inner_mut(&mut self) -> Option<WasiInstanceGuardMut<'_>> {
self.inner.get_mut()
}
/// Sets the inner object (this should only be called when
/// creating the instance and eventually should be moved out
/// of the WasiEnv)
#[doc(hidden)]
pub(crate) fn set_inner(&mut self, handles: WasiInstanceHandles) {
self.inner.set(handles)
}
/// Swaps this inner with the WasiEnvironment of another, this
/// is used by the vfork so that the inner handles can be restored
/// after the vfork finishes.
#[doc(hidden)]
pub(crate) fn swap_inner(&mut self, other: &mut Self) {
std::mem::swap(&mut self.inner, &mut other.inner);
}
/// Tries to clone the instance from this environment
pub fn try_clone_instance(&self) -> Option<Instance> {
self.inner.get().map(|i| i.instance.clone())
}
/// Providers safe access to the memory
/// (it must be initialized before it can be used)
pub(crate) fn try_memory(&self) -> Option<WasiInstanceGuardMemory<'_>> {
self.try_inner().map(|i| i.memory())
}
/// Providers safe access to the memory
/// (it must be initialized before it can be used)
/// This has been marked as unsafe as it will panic if its executed
/// on the wrong thread or before the inner is set
pub(crate) unsafe fn memory(&self) -> WasiInstanceGuardMemory<'_> {
self.try_memory().expect(
"You must initialize the WasiEnv before using it and can not pass it between threads",
)
}
/// Providers safe access to the memory
/// (it must be initialized before it can be used)
pub(crate) fn try_memory_view<'a>(
&self,
store: &'a (impl AsStoreRef + ?Sized),
) -> Option<MemoryView<'a>> {
self.try_memory().map(|m| m.view(store))
}
/// Providers safe access to the memory
/// (it must be initialized before it can be used)
/// This has been marked as unsafe as it will panic if its executed
/// on the wrong thread or before the inner is set
pub(crate) unsafe fn memory_view<'a>(
&self,
store: &'a (impl AsStoreRef + ?Sized),
) -> MemoryView<'a> {
self.try_memory_view(store).expect(
"You must initialize the WasiEnv before using it and can not pass it between threads",
)
}
/// Copy the lazy reference so that when it's initialized during the
/// export phase, all the other references get a copy of it
#[allow(dead_code)]
pub(crate) fn try_memory_clone(&self) -> Option<Memory> {
self.try_inner().map(|i| i.memory_clone())
}
/// Get the WASI state
pub(crate) fn state(&self) -> &WasiState {
&self.state
}
/// Get the `VirtualFile` object at stdout
pub fn stdout(&self) -> Result<Option<Box<dyn VirtualFile + Send + Sync + 'static>>, FsError> {
self.state.stdout()
}
/// Get the `VirtualFile` object at stderr
pub fn stderr(&self) -> Result<Option<Box<dyn VirtualFile + Send + Sync + 'static>>, FsError> {
self.state.stderr()
}
/// Get the `VirtualFile` object at stdin
pub fn stdin(&self) -> Result<Option<Box<dyn VirtualFile + Send + Sync + 'static>>, FsError> {
self.state.stdin()
}
/// Returns true if the process should perform snapshots or not
pub fn should_journal(&self) -> bool {
self.enable_journal && !self.replaying_journal
}
/// Returns true if the environment has an active journal
#[cfg(feature = "journal")]
pub fn has_active_journal(&self) -> bool {
self.runtime().active_journal().is_some()
}
/// Returns the active journal or fails with an error
#[cfg(feature = "journal")]
pub fn active_journal(&self) -> Result<&DynJournal, Errno> {
self.runtime().active_journal().ok_or_else(|| {
tracing::debug!("failed to save thread exit as there is not active journal");
Errno::Fault
})
}
/// Returns true if a particular snapshot trigger is enabled
#[cfg(feature = "journal")]
pub fn has_snapshot_trigger(&self, trigger: SnapshotTrigger) -> bool {
let guard = self.process.inner.0.lock().unwrap();
guard.snapshot_on.contains(&trigger)
}
/// Returns true if a particular snapshot trigger is enabled
#[cfg(feature = "journal")]
pub fn pop_snapshot_trigger(&mut self, trigger: SnapshotTrigger) -> bool {
let mut guard = self.process.inner.0.lock().unwrap();
if trigger.only_once() {
guard.snapshot_on.remove(&trigger)
} else {
guard.snapshot_on.contains(&trigger)
}
}
/// Internal helper function to get a standard device handle.
/// Expects one of `__WASI_STDIN_FILENO`, `__WASI_STDOUT_FILENO`, `__WASI_STDERR_FILENO`.
pub fn std_dev_get(
&self,
fd: crate::syscalls::WasiFd,
) -> Result<Option<Box<dyn VirtualFile + Send + Sync + 'static>>, FsError> {
self.state.std_dev_get(fd)
}
/// Unsafe:
///
/// This will access the memory of the WASM process and create a view into it which is
/// inherently unsafe as it could corrupt the memory. Also accessing the memory is not
/// thread safe.
pub(crate) unsafe fn get_memory_and_wasi_state<'a>(
&'a self,
store: &'a impl AsStoreRef,
_mem_index: u32,
) -> (MemoryView<'a>, &WasiState) {
let memory = self.memory_view(store);
let state = self.state.deref();
(memory, state)
}
/// Unsafe:
///
/// This will access the memory of the WASM process and create a view into it which is
/// inherently unsafe as it could corrupt the memory. Also accessing the memory is not
/// thread safe.
pub(crate) unsafe fn get_memory_and_wasi_state_and_inodes<'a>(
&'a self,
store: &'a impl AsStoreRef,
_mem_index: u32,
) -> (MemoryView<'a>, &WasiState, &WasiInodes) {
let memory = self.memory_view(store);
let state = self.state.deref();
let inodes = &state.inodes;
(memory, state, inodes)
}
pub(crate) fn get_wasi_state_and_inodes(&self) -> (&WasiState, &WasiInodes) {
let state = self.state.deref();
let inodes = &state.inodes;
(state, inodes)
}
pub fn use_package(&self, pkg: &BinaryPackage) -> Result<(), WasiStateCreationError> {
InlineWaker::block_on(self.use_package_async(pkg))
}
/// Make all the commands in a [`BinaryPackage`] available to the WASI
/// instance.
///
/// The [`BinaryPackageCommand::atom()`][cmd-atom] will be saved to
/// `/bin/command`.
///
/// This will also merge the command's filesystem
/// ([`BinaryPackage::webc_fs`][pkg-fs]) into the current filesystem.
///
/// [cmd-atom]: crate::bin_factory::BinaryPackageCommand::atom()
/// [pkg-fs]: crate::bin_factory::BinaryPackage::webc_fs
pub async fn use_package_async(
&self,
pkg: &BinaryPackage,
) -> Result<(), WasiStateCreationError> {
tracing::trace!(package=%pkg.id, "merging package dependency into wasi environment");
let root_fs = &self.state.fs.root_fs;
// We first need to merge the filesystem in the package into the
// main file system, if it has not been merged already.
if let Err(e) = self.state.fs.conditional_union(pkg).await {
tracing::warn!(
error = &e as &dyn std::error::Error,
"Unable to merge the package's filesystem into the main one",
);
}
// Next, make sure all commands will be available
if !pkg.commands.is_empty() {
let _ = root_fs.create_dir(Path::new("/bin"));
for command in &pkg.commands {
let path = format!("/bin/{}", command.name());
let path = Path::new(path.as_str());
// FIXME(Michael-F-Bryan): This is pretty sketchy.
// We should be using some sort of reference-counted
// pointer to some bytes that are either on the heap
// or from a memory-mapped file. However, that's not
// possible here because things like memfs and
// WasiEnv are expecting a Cow<'static, [u8]>. It's
// too hard to refactor those at the moment, and we
// were pulling the same trick before by storing an
// "ownership" object in the BinaryPackageCommand,
// so as long as packages aren't removed from the
// module cache it should be fine.
// See https://github.com/wasmerio/wasmer/issues/3875
let atom: &'static [u8] = unsafe { std::mem::transmute(command.atom()) };
match root_fs {
WasiFsRoot::Sandbox(root_fs) => {
// As a short-cut, when we are using a TmpFileSystem
// we can (unsafely) add the file to the filesystem
// without any copying.
if let Err(err) = root_fs
.new_open_options_ext()
.insert_ro_file(path, atom.into())
{
tracing::debug!(
"failed to add package [{}] command [{}] - {}",
pkg.id,
command.name(),
err
);
continue;
}
}
WasiFsRoot::Backing(fs) => {
let mut f = fs.new_open_options().create(true).write(true).open(path)?;
if let Err(e) = f.copy_reference(Box::new(StaticFile::new(atom))).await {
tracing::warn!(
error = &e as &dyn std::error::Error,
"Unable to copy file reference",
);
}
}
}
let mut package = pkg.clone();
package.entrypoint_cmd = Some(command.name().to_string());
self.bin_factory
.set_binary(path.as_os_str().to_string_lossy().as_ref(), package);
tracing::debug!(
package=%pkg.id,
command_name=command.name(),
path=%path.display(),
"Injected a command into the filesystem",
);
}
}
Ok(())
}
/// Given a list of packages, load them from the registry and make them
/// available.
pub fn uses<I>(&self, uses: I) -> Result<(), WasiStateCreationError>
where
I: IntoIterator<Item = String>,
{
let rt = self.runtime();
for package_name in uses {
let specifier = package_name.parse::<PackageSource>().map_err(|e| {
WasiStateCreationError::WasiIncludePackageError(format!(
"package_name={package_name}, {}",
e
))
})?;
let pkg = InlineWaker::block_on(BinaryPackage::from_registry(&specifier, rt)).map_err(
|e| {
WasiStateCreationError::WasiIncludePackageError(format!(
"package_name={package_name}, {}",
e
))
},
)?;
self.use_package(&pkg)?;
}
Ok(())
}
#[cfg(feature = "sys")]
pub fn map_commands(
&self,
map_commands: std::collections::HashMap<String, std::path::PathBuf>,
) -> Result<(), WasiStateCreationError> {
// Load all the mapped atoms
#[allow(unused_imports)]
use std::path::Path;
#[allow(unused_imports)]
use virtual_fs::FileSystem;
#[cfg(feature = "sys")]
for (command, target) in map_commands.iter() {
// Read the file
let file = std::fs::read(target).map_err(|err| {
WasiStateCreationError::WasiInheritError(format!(
"failed to read local binary [{}] - {}",
target.as_os_str().to_string_lossy(),
err
))
})?;
let file: std::borrow::Cow<'static, [u8]> = file.into();
if let WasiFsRoot::Sandbox(root_fs) = &self.state.fs.root_fs {
let _ = root_fs.create_dir(Path::new("/bin"));
let path = format!("/bin/{}", command);
let path = Path::new(path.as_str());
if let Err(err) = root_fs.new_open_options_ext().insert_ro_file(path, file) {
tracing::debug!("failed to add atom command [{}] - {}", command, err);
continue;
}
} else {
tracing::debug!("failed to add atom command [{}] to the root file system as it is not sandboxed", command);
continue;
}
}
Ok(())
}
/// Cleans up all the open files (if this is the main thread)
#[allow(clippy::await_holding_lock)]
pub fn blocking_on_exit(&self, process_exit_code: Option<ExitCode>) {
let cleanup = self.on_exit(process_exit_code);
InlineWaker::block_on(cleanup);
}
/// Cleans up all the open files (if this is the main thread)
#[allow(clippy::await_holding_lock)]
pub fn on_exit(&self, process_exit_code: Option<ExitCode>) -> BoxFuture<'static, ()> {
const CLEANUP_TIMEOUT: Duration = Duration::from_secs(10);
// If snap-shooting is enabled then we should record an event that the thread has exited.
#[cfg(feature = "journal")]
if self.should_journal() && self.has_active_journal() {
if let Err(err) = JournalEffector::save_thread_exit(self, self.tid(), process_exit_code)
{
tracing::warn!("failed to save snapshot event for thread exit - {}", err);
}
if self.thread.is_main() {
if let Err(err) = JournalEffector::save_process_exit(self, process_exit_code) {
tracing::warn!("failed to save snapshot event for process exit - {}", err);
}
}
}
// If the process wants to exit, also close all files and terminate it
if let Some(process_exit_code) = process_exit_code {
let process = self.process.clone();
let disable_fs_cleanup = self.disable_fs_cleanup;
let pid = self.pid();
let timeout = self.tasks().sleep_now(CLEANUP_TIMEOUT);
let state = self.state.clone();
Box::pin(async move {
if !disable_fs_cleanup {
tracing::trace!(pid = %pid, "cleaning up open file handles");
// Perform the clean operation using the asynchronous runtime
tokio::select! {
_ = timeout => {
tracing::debug!(
"WasiEnv::cleanup has timed out after {CLEANUP_TIMEOUT:?}"
);
},
_ = state.fs.close_all() => { }
}
// Now send a signal that the thread is terminated
process.signal_process(Signal::Sigquit);
}
// Terminate the process
process.terminate(process_exit_code);
})
} else {
Box::pin(async {})
}
}
pub fn prepare_spawn(&self, cmd: &BinaryPackageCommand) {
if let Ok(Some(Wasi {
main_args,
env: env_vars,
exec_name,
..
})) = cmd.metadata().wasi()
{
if let Some(env_vars) = env_vars {
let env_vars = env_vars
.into_iter()
.map(|env_var| {
let (k, v) = env_var.split_once('=').unwrap();
(k.to_string(), v.as_bytes().to_vec())
})
.collect::<Vec<_>>();
let env_vars = conv_env_vars(env_vars);
self.state
.envs
.lock()
.unwrap()
.extend_from_slice(env_vars.as_slice());
}
if let Some(args) = main_args {
self.state
.args
.lock()
.unwrap()
.extend_from_slice(args.as_slice());
}
if let Some(exec_name) = exec_name {
self.state.args.lock().unwrap()[0] = exec_name;
}
}
}
}