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
pub mod config;
pub mod env;
pub mod mailbox;
pub mod message;
pub mod runtimes;
pub mod state;
pub mod wasm;
use std::{collections::HashMap, fmt::Debug, future::Future, hash::Hash, sync::Arc};
use anyhow::{anyhow, Result};
use env::Environment;
use log::{debug, log_enabled, trace, warn, Level};
use smallvec::SmallVec;
use state::ProcessState;
use tokio::{
sync::{
mpsc::{unbounded_channel, UnboundedReceiver, UnboundedSender},
Mutex,
},
task::JoinHandle,
};
use crate::{mailbox::MessageMailbox, message::Message};
#[cfg(feature = "metrics")]
pub fn describe_metrics() {
use metrics::{describe_counter, describe_gauge, describe_histogram, Unit};
describe_counter!(
"lunatic.process.signals.send",
Unit::Count,
"Number of signals sent to processes since startup"
);
describe_counter!(
"lunatic.process.signals.received",
Unit::Count,
"Number of signals received by processes since startup"
);
describe_counter!(
"lunatic.process.messages.send",
Unit::Count,
"Number of messages sent to processes since startup"
);
describe_gauge!(
"lunatic.process.messages.outstanding",
Unit::Count,
"Current number of messages that are ready to be consumed by the process"
);
describe_gauge!(
"lunatic.process.links.alive",
Unit::Count,
"Number of links currently alive"
);
describe_counter!(
"lunatic.process.messages.data.count",
Unit::Count,
"Number of data messages send since startup"
);
describe_histogram!(
"lunatic.process.messages.data.resources.count",
Unit::Count,
"Number of resources used by each individual data message"
);
describe_histogram!(
"lunatic.process.messages.data.size",
Unit::Bytes,
"Number of bytes used by each individual data message"
);
describe_counter!(
"lunatic.process.messages.link_died.count",
Unit::Count,
"Number of LinkDied messages send since startup"
);
describe_gauge!(
"lunatic.process.environment.process.count",
Unit::Count,
"Number of currently registered processes"
);
describe_gauge!(
"lunatic.process.environment.count",
Unit::Count,
"Number of currently active environments"
);
}
/// The `Process` is the main abstraction 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`] are opaque and left to the receiver for interpretation.
pub trait Process: Send + Sync {
fn id(&self) -> u64;
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 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 {
// Messages can contain opaque data.
Message(Message),
// When received, the process should stop immediately.
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 { process_id: u64 },
// 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`) and
// the death reason, the receiving process will turn this signal into a message or the
// process will immediately die as well.
LinkDied(u64, Option<i64>, DeathReason),
Monitor(Arc<dyn Process>),
StopMonitoring { process_id: u64 },
ProcessDied(u64),
}
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(_, p) => write!(f, "Link {}", p.id()),
Self::UnLink { process_id } => write!(f, "UnLink {process_id}"),
Self::LinkDied(_, _, reason) => write!(f, "LinkDied {reason:?}"),
Self::Monitor(p) => write!(f, "Monitor {}", p.id()),
Self::StopMonitoring { process_id } => write!(f, "UnMonitor {process_id}"),
Self::ProcessDied(_) => write!(f, "ProcessDied"),
}
}
}
// The reason of a process' death
#[derive(Clone, Copy, Debug)]
pub enum DeathReason {
// Process finished normaly.
Normal,
Failure,
NoProcess,
}
/// 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 `Kill` signal.
KillSignal,
}
/// A `WasmProcess` represents an instance of a Wasm module that is being executed.
///
/// They can be created with [`spawn_wasm`](crate::wasm::spawn_wasm), and once spawned they will be
/// running in the background and can't be observed directly.
#[derive(Debug, Clone)]
pub struct WasmProcess {
id: u64,
signal_mailbox: UnboundedSender<Signal>,
}
impl WasmProcess {
/// Create a new WasmProcess
pub fn new(id: u64, signal_mailbox: UnboundedSender<Signal>) -> Self {
Self { id, signal_mailbox }
}
}
impl Process for WasmProcess {
fn id(&self) -> u64 {
self.id
}
fn send(&self, signal: Signal) {
#[cfg(all(feature = "metrics", not(feature = "detailed_metrics")))]
let labels = [("process_kind", "wasm")];
#[cfg(all(feature = "metrics", feature = "detailed_metrics"))]
let labels = [
("process_kind", "wasm"),
("process_id", self.id().to_string()),
];
#[cfg(feature = "metrics")]
metrics::increment_counter!("lunatic.process.signals.send", &labels);
// 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.send(signal);
}
}
/// Enum containing a process name if available, otherwise its ID.
enum NameOrID<'a> {
Names(SmallVec<[&'a str; 2]>),
ID(u64),
}
impl<'a> NameOrID<'a> {
/// Returns names, otherwise id if names is empty.
fn or_id(self, id: u64) -> Self {
match self {
NameOrID::Names(ref names) if !names.is_empty() => self,
_ => NameOrID::ID(id),
}
}
}
impl<'a> std::fmt::Display for NameOrID<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
NameOrID::Names(names) => {
for (i, name) in names.iter().enumerate() {
if i > 0 {
write!(f, " / ")?;
}
write!(f, "'{name}'")?;
}
Ok(())
}
NameOrID::ID(id) => write!(f, "{id}"),
}
}
}
impl<'a> FromIterator<&'a str> for NameOrID<'a> {
fn from_iter<T: IntoIterator<Item = &'a str>>(iter: T) -> Self {
let names = SmallVec::from_iter(iter);
NameOrID::Names(names)
}
}
/// Turns a `Future` into a process, enabling signals (e.g. kill).
///
/// This function represents the core execution loop of lunatic processes:
///
/// 1. The process will first check if there are any new signals and handle them.
/// 2. If no signals are available, it will poll the `Future` and advance the execution.
///
/// This steps are repeated until the `Future` returns `Poll::Ready`, indicating the end of the
/// computation.
///
/// The `Future` is in charge to periodically yield back the execution with `Poll::Pending` to give
/// the signal handler a chance to run and process pending signals.
///
/// In case of success, the process state `S` is returned. It's not possible to return the process
/// state in case of failure because of limitations in the Wasmtime API:
/// https://github.com/bytecodealliance/wasmtime/issues/2986
pub(crate) async fn new<F, S, R>(
fut: F,
id: u64,
env: Arc<dyn Environment>,
signal_mailbox: Arc<Mutex<UnboundedReceiver<Signal>>>,
message_mailbox: MessageMailbox,
) -> Result<S>
where
S: ProcessState,
R: Into<ExecutionResult<S>>,
F: Future<Output = R> + 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();
// Processes monitoring this one
let mut monitors = 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 mut signal_mailbox = signal_mailbox.lock().await;
let mut has_sender = true;
#[cfg(all(feature = "metrics", not(feature = "detailed_metrics")))]
let labels: [(String, String); 0] = [];
#[cfg(all(feature = "metrics", feature = "detailed_metrics"))]
let labels = [("process_id", id.to_string())];
let result = loop {
tokio::select! {
biased;
// Handle signals first
signal = signal_mailbox.recv(), if has_sender => {
#[cfg(feature = "metrics")]
metrics::increment_counter!("lunatic.process.signals.received", &labels);
match signal.ok_or(()) {
Ok(Signal::Message(message)) => {
#[cfg(feature = "metrics")]
message.write_metrics();
message_mailbox.push(message);
// process metrics
#[cfg(feature = "metrics")]
metrics::increment_counter!("lunatic.process.messages.send", &labels);
#[cfg(feature = "metrics")]
metrics::gauge!("lunatic.process.messages.outstanding", message_mailbox.len() as f64, &labels);
},
Ok(Signal::DieWhenLinkDies(value)) => die_when_link_dies = value,
// Put process into list of linked processes
Ok(Signal::Link(tag, proc)) => {
links.insert(proc.id(), (proc, tag));
#[cfg(feature = "metrics")]
metrics::gauge!("lunatic.process.links.alive", links.len() as f64, &labels);
},
// Remove process from list
Ok(Signal::UnLink { process_id }) => {
links.remove(&process_id);
#[cfg(feature = "metrics")]
metrics::gauge!("lunatic.process.links.alive", links.len() as f64, &labels);
}
// Exit loop and don't poll anymore the future if Signal::Kill received.
Ok(Signal::Kill) => break Finished::KillSignal,
// Depending if `die_when_link_dies` is set, process will die or turn the
// signal into a message
Ok(Signal::LinkDied(id, tag, reason)) => {
links.remove(&id);
#[cfg(feature = "metrics")]
metrics::gauge!("lunatic.process.links.alive", links.len() as f64, &labels);
match reason {
DeathReason::Failure | DeathReason::NoProcess => {
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.
break Finished::KillSignal
} else {
let message = Message::LinkDied(tag);
#[cfg(feature = "metrics")]
metrics::increment_counter!("lunatic.process.messages.send", &labels);
#[cfg(feature = "metrics")]
metrics::gauge!("lunatic.process.messages.outstanding", message_mailbox.len() as f64, &labels);
message_mailbox.push(message);
}
},
// In case a linked process finishes normally, don't do anything.
DeathReason::Normal => {},
}
},
// Put process into list of monitor processes
Ok(Signal::Monitor(proc)) => {
monitors.insert(proc.id(), proc);
}
// Remove process from monitor list
Ok(Signal::StopMonitoring { process_id }) => {
monitors.remove(&process_id);
}
// Notify process that a monitored process died
Ok(Signal::ProcessDied(id)) => {
message_mailbox.push(Message::ProcessDied(id));
}
Err(_) => {
debug_assert!(has_sender);
has_sender = false;
}
}
}
// Run process
output = &mut fut => { break Finished::Normal(output); }
}
};
env.remove_process(id);
let result = match result {
Finished::Normal(result) => {
let result: ExecutionResult<_> = result.into();
if let Some(failure) = result.failure() {
let registry = result.state().registry().read().await;
let name = registry
.iter()
.filter(|(_, (_, process_id))| process_id == &id)
.map(|(name, _)| name.splitn(4, '/').last().unwrap_or(name.as_str()))
.collect::<NameOrID>()
.or_id(id);
warn!(
"Process {} failed, notifying: {} links {}",
name,
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!("{}", failure);
Err(anyhow!(failure.to_string()))
} else {
Ok(result.into_state())
}
}
Finished::KillSignal => {
warn!(
"Process {} was killed, notifying: {} links",
id,
links.len()
);
Err(anyhow!("Process received Kill signal"))
}
};
let reason = match result {
Ok(_) => DeathReason::Normal,
Err(_) => DeathReason::Failure,
};
// Notify all links that we finished
for (proc, tag) in links.values() {
proc.send(Signal::LinkDied(id, *tag, reason));
}
// Notify all monitoring processes we died
for proc in monitors.values() {
proc.send(Signal::ProcessDied(id));
}
result
}
/// A process spawned from a native Rust closure.
#[derive(Clone, Debug)]
pub struct NativeProcess {
id: u64,
signal_mailbox: UnboundedSender<Signal>,
}
/// Spawns a process from a closure.
pub fn spawn<T, F, K, R>(
env: Arc<dyn Environment>,
func: F,
) -> (JoinHandle<Result<T>>, NativeProcess)
where
T: ProcessState + Send + Sync + 'static,
R: Into<ExecutionResult<T>> + Send + 'static,
K: Future<Output = R> + Send + 'static,
F: FnOnce(NativeProcess, MessageMailbox) -> K,
{
let id = env.get_next_process_id();
let (signal_sender, signal_mailbox) = unbounded_channel::<Signal>();
let message_mailbox = MessageMailbox::default();
let process = NativeProcess {
id,
signal_mailbox: signal_sender,
};
let fut = func(process.clone(), message_mailbox.clone());
let signal_mailbox = Arc::new(Mutex::new(signal_mailbox));
let join = tokio::task::spawn(new(fut, id, env.clone(), signal_mailbox, message_mailbox));
(join, process)
}
impl Process for NativeProcess {
fn id(&self) -> u64 {
self.id
}
fn send(&self, signal: Signal) {
#[cfg(all(feature = "metrics", not(feature = "detailed_metrics")))]
let labels = [("process_kind", "native")];
#[cfg(all(feature = "metrics", feature = "detailed_metrics"))]
let labels = [
("process_kind", "native"),
("process_id", self.id().to_string()),
];
#[cfg(feature = "metrics")]
metrics::increment_counter!("lunatic.process.signals.send", &labels);
// 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.send(signal);
}
}
// Contains the result of a process execution.
//
// Can be also used to extract the state of a process after the execution is done.
pub struct ExecutionResult<T> {
state: T,
result: ResultValue,
}
impl<T> ExecutionResult<T> {
// Returns the failure as `String` if the process failed.
pub fn failure(&self) -> Option<&str> {
match self.result {
ResultValue::Failed(ref failure) => Some(failure),
ResultValue::SpawnError(ref failure) => Some(failure),
_ => None,
}
}
// Returns the process state reference
pub fn state(&self) -> &T {
&self.state
}
// Returns the process state
pub fn into_state(self) -> T {
self.state
}
}
// It's more convinient to return a `Result<T,E>` in a `NativeProcess`.
impl<T> From<Result<T>> for ExecutionResult<T>
where
T: Default,
{
fn from(result: Result<T>) -> Self {
match result {
Ok(t) => ExecutionResult {
state: t,
result: ResultValue::Ok,
},
Err(e) => ExecutionResult {
state: T::default(),
result: ResultValue::Failed(e.to_string()),
},
}
}
}
pub enum ResultValue {
Ok,
Failed(String),
SpawnError(String),
}