beamr 0.3.9

A Rust runtime with the BEAM's execution model, targeting Gleam
Documentation 
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

//! Link facility trait — how BIFs manage bidirectional process links.
//!
//! The link facility is an abstraction that allows link management BIFs
//! (link/1, unlink/1) to establish and remove bidirectional links without
//! direct access to the scheduler or process table. The scheduler provides
//! an implementation that uses its internal process management; tests can
//! provide mock implementations.

use std::fmt;

/// Error returned when a link operation fails.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum LinkError {
    /// The target process does not exist.
    NoProc,
    /// The caller process identity is unknown.
    NoCaller,
}

impl fmt::Display for LinkError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::NoProc => f.write_str("target process does not exist"),
            Self::NoCaller => f.write_str("caller process identity unknown"),
        }
    }
}

impl std::error::Error for LinkError {}

/// Trait for managing bidirectional process links from BIFs.
///
/// Implementations are provided by the scheduler (or test mocks) and injected
/// into [`super::ProcessContext`] before BIF execution.
pub trait LinkFacility: Send + Sync {
    /// Establish a bidirectional link between the caller and target.
    ///
    /// If a link already exists between the two PIDs, this is a no-op.
    /// If caller and target are the same PID, this is a no-op.
    /// Returns `Err(LinkError::NoProc)` when the target does not exist.
    fn link(&self, caller_pid: u64, target_pid: u64) -> Result<(), LinkError>;

    /// Remove a bidirectional link between the caller and target.
    ///
    /// If no link exists, this is a no-op returning `Ok(())`.
    fn unlink(&self, caller_pid: u64, target_pid: u64) -> Result<(), LinkError>;

    /// Set the `trap_exit` flag for `caller_pid`, returning the previous value.
    ///
    /// Returns `Err(LinkError::NoCaller)` when the caller PID is not known.
    fn set_trap_exit(&self, caller_pid: u64, value: bool) -> Result<bool, LinkError>;
}

/// Record of a link operation, used by test mocks to verify BIF behavior.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum LinkRecord {
    /// A link was established.
    Link {
        /// PID of the process requesting the link.
        caller_pid: u64,
        /// PID of the process being linked to.
        target_pid: u64,
    },
    /// A link was removed.
    Unlink {
        /// PID of the process requesting the unlink.
        caller_pid: u64,
        /// PID of the process being unlinked from.
        target_pid: u64,
    },
}