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
use std::{collections::HashMap, fmt::Debug, future::Future, hash::Hash, sync::Arc};
use anyhow::Result;
use log::{debug, log_enabled, trace, warn, Level};
use async_std::channel::{unbounded, Receiver, Sender};
use async_std::task::JoinHandle;
use uuid::Uuid;
use crate::{mailbox::MessageMailbox, message::Message};
/// The `Process` is the main abstraction unit in lunatic.
///
/// It usually represents some code that is being executed (Wasm instance or V8 isolate), but it
/// could also be a resource (GPU, UDP connection) that can be interacted with through messages.
///
/// The only way of interacting with them is through signals. These signals can come in different
/// shapes (message, kill, link, ...). Most signals have well defined meanings, but others such as
/// a [`Message`] can be interpreted by the receiver in different ways.
pub trait Process: Send + Sync {
fn id(&self) -> Uuid;
fn send(&self, signal: Signal);
}
impl Debug for dyn Process {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Point").field("id", &self.id()).finish()
}
}
impl PartialEq<dyn Process> for dyn Process {
fn eq(&self, other: &dyn Process) -> bool {
self.id() == other.id()
}
}
impl Eq for dyn Process {}
impl Hash for dyn Process {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
self.id().hash(state);
}
}
/// Signals can be sent to processes to interact with them.
pub enum Signal {
Message(Message),
// When received process should stop.
Kill,
// Change behaviour of what happens if a linked process dies.
DieWhenLinkDies(bool),
// Sent from a process that wants to be linked. In case of a death the tag will be returned
// to the sender in form of a `LinkDied` signal.
Link(Option<i64>, Arc<dyn Process>),
// Request from a process to be unlinked
UnLink(Arc<dyn Process>),
// Sent to linked processes when the link dies. Contains the tag used when the link was
// established. Depending on the value of `die_when_link_dies` (default is `true`) this
// receiving process will turn this signal into a message or the process will immediately
// die as well.
LinkDied(Option<i64>),
}
impl Debug for Signal {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Message(_) => write!(f, "Message"),
Self::Kill => write!(f, "Kill"),
Self::DieWhenLinkDies(_) => write!(f, "DieWhenLinkDies"),
Self::Link(_, _) => write!(f, "Link"),
Self::UnLink(_) => write!(f, "UnLink"),
Self::LinkDied(_) => write!(f, "LinkDied"),
}
}
}
/// The reason of a process finishing
pub enum Finished<T> {
/// This just means that the process finished without external interaction.
/// In case of Wasm this could mean that the entry function returned normally or that it
/// **trapped**.
Normal(T),
/// The process was terminated by an external signal.
Signal(Signal),
}
/// A `WasmProcess` represents an instance of a Wasm module that is being executed.
///
/// They are created inside the `Environment::spawn` method, and once spawned they will be running
/// in the background and can't be observed directly.
#[derive(Debug, Clone)]
pub struct WasmProcess {
id: Uuid,
signal_mailbox: Sender<Signal>,
}
impl WasmProcess {
/// Create a new WasmProcess
pub fn new(id: Uuid, signal_mailbox: Sender<Signal>) -> Self {
Self { id, signal_mailbox }
}
}
impl Process for WasmProcess {
fn id(&self) -> Uuid {
self.id
}
fn send(&self, signal: Signal) {
// If the receiver doesn't exist or is closed, just ignore it and drop the `signal`.
// lunatic can't guarantee that a message was successfully seen by the receiving side even
// if this call succeeds. We deliberately don't expose this API, as it would not make sense
// to relay on it and could signal wrong guarantees to users.
let _ = self.signal_mailbox.try_send(signal);
}
}
// Turns a Future into a process, enabling signals (e.g. kill).
pub(crate) async fn new<F>(
fut: F,
id: Uuid,
signal_mailbox: Receiver<Signal>,
message_mailbox: MessageMailbox,
) where
F: Future<Output = Result<()>> + Send + 'static,
{
trace!("Process {} spawned", id);
tokio::pin!(fut);
// Defines what happens if one of the linked processes dies.
// If the value is set to false, instead of dying too the process will receive a message about
// the linked process' death.
let mut die_when_link_dies = true;
// Process linked to this one
let mut links = HashMap::new();
// TODO: Maybe wrapping this in some kind of `std::panic::catch_unwind` wold be a good idea,
// to protect against panics in host function calls that unwind through Wasm code.
// Currently a panic would just kill the task, but not notify linked processes.
let result = loop {
tokio::select! {
biased;
// Handle signals first
signal = signal_mailbox.recv() => {
match signal {
Ok(Signal::Message(message)) => message_mailbox.push(message),
Ok(Signal::DieWhenLinkDies(value)) => die_when_link_dies = value,
// Put process into list of linked processes
Ok(Signal::Link(tag, proc)) => { links.insert(proc, tag); },
// Remove process from list
Ok(Signal::UnLink(proc)) => { links.remove(&proc); }
// Exit loop and don't poll anymore the future if Signal::Kill received.
Ok(Signal::Kill) => break Finished::Signal(Signal::Kill),
// Depending if `die_when_link_dies` is set, process will die or turn the
// signal into a message
Ok(Signal::LinkDied(tag)) => {
if die_when_link_dies {
// Even this was not a **kill** signal it has the same effect on
// this process and should be propagated as such.
// TODO: Remove sender from our notify list, so we don't send back the
// same notification to an already dead process.
break Finished::Signal(Signal::Kill)
} else {
let message = Message::Signal(tag);
message_mailbox.push(message);
}
},
Err(_) => unreachable!("The process holds the sending side and is not closed")
}
}
// Run process
output = &mut fut => { break Finished::Normal(output); }
}
};
match result {
Finished::Normal(Result::Err(err)) => {
// If the trap is a result of calling `proc_exit(0)` treat it as an no-error finish.
if let Some(trap) = err.downcast_ref::<wasmtime::Trap>() {
if let Some(exit_status) = trap.i32_exit_status() {
if exit_status == 0 {
return;
}
}
};
warn!(
"Process {} trapped, notifying: {} links {}",
id,
links.len(),
// If the log level is WARN instruct user how to display the stacktrace
if !log_enabled!(Level::Debug) {
"\n\t\t\t (Set ENV variable `RUST_LOG=lunatic=debug` to show stacktrace)"
} else {
""
}
);
debug!("{}", err);
// Notify all links that we finished with an error
links.iter().for_each(|(proc, tag)| {
let _ = proc.send(Signal::LinkDied(*tag));
});
}
Finished::Signal(Signal::Kill) => {
warn!(
"Process {} was killed, notifying: {} links",
id,
links.len()
);
// Notify all links that we finished because of a kill signal
links.iter().for_each(|(proc, tag)| {
let _ = proc.send(Signal::LinkDied(*tag));
});
}
_ => {} // Finished normally
}
}
/// A process spawned from a native Rust closure.
#[derive(Clone, Debug)]
pub struct NativeProcess {
id: Uuid,
signal_mailbox: Sender<Signal>,
}
/// Spawns a process from a closure.
///
/// ## Example:
///
/// ```no_run
/// let _proc = lunatic_runtime::spawn(|_this, mailbox| async move {
/// // Wait on a message with the tag `27`.
/// mailbox.pop(Some(&[27])).await;
/// Ok(())
/// });
/// ```
pub fn spawn<F, K>(func: F) -> (JoinHandle<()>, NativeProcess)
where
K: Future<Output = Result<()>> + Send + 'static,
F: FnOnce(NativeProcess, MessageMailbox) -> K,
{
// TODO: Switch to new_v1() for distributed Lunatic to assure uniqueness across nodes.
let id = Uuid::new_v4();
let (signal_sender, signal_mailbox) = unbounded::<Signal>();
let message_mailbox = MessageMailbox::default();
let process = NativeProcess {
id,
signal_mailbox: signal_sender,
};
let fut = func(process.clone(), message_mailbox.clone());
let join = async_std::task::spawn(new(fut, id, signal_mailbox, message_mailbox));
(join, process)
}
impl Process for NativeProcess {
fn id(&self) -> Uuid {
self.id
}
fn send(&self, signal: Signal) {
// If the receiver doesn't exist or is closed, just ignore it and drop the `signal`.
// lunatic can't guarantee that a message was successfully seen by the receiving side even
// if this call succeeds. We deliberately don't expose this API, as it would not make sense
// to relay on it and could signal wrong guarantees to users.
let _ = self.signal_mailbox.try_send(signal);
}
}