Compare commits
13
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f90bee63f7 | ||
|
|
557c1030a7 | ||
|
|
66a0dd54df | ||
|
|
8206864a43 | ||
|
|
ab597c332d | ||
|
|
279903e56e | ||
|
|
65fde92628 | ||
|
|
2183084ec8 | ||
|
|
f35bab0379 | ||
|
|
31084edcfa | ||
|
|
a46c4cd20c | ||
|
|
6ead1fe9f8 | ||
|
|
d54e2b99fc |
+1
-1
@@ -615,7 +615,7 @@ fn run_router(
|
||||
/// (empty, signed, whitespace-padded, non-numeric, overflowing) is a
|
||||
/// property we do not understand and must not guess at. Leading zeroes
|
||||
/// are accepted — they are unambiguous and parse to the same value.
|
||||
fn parse_object_serial(raw: &str) -> Option<u64> {
|
||||
pub(crate) fn parse_object_serial(raw: &str) -> Option<u64> {
|
||||
if raw.is_empty() || !raw.bytes().all(|b| b.is_ascii_digit()) {
|
||||
return None;
|
||||
}
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
pub mod audio;
|
||||
mod capture;
|
||||
mod observer;
|
||||
mod pipeline;
|
||||
mod quality;
|
||||
mod serve;
|
||||
pub mod taint;
|
||||
mod wayland;
|
||||
mod x11;
|
||||
|
||||
|
||||
@@ -0,0 +1,601 @@
|
||||
//! PipeWire I/O adapter for the pure registry observer.
|
||||
//!
|
||||
//! This module owns a read-only PipeWire main-loop thread, translates registry
|
||||
//! callbacks into [`RegEvent`]s, and publishes the latest [`Projection`] for
|
||||
//! consumers running outside the PipeWire thread.
|
||||
|
||||
use super::classify::DeviceClaim;
|
||||
use super::{LinkEndpoints, NodeObservation, Projection, RegEvent, RegistryModel};
|
||||
use crate::host::audio::parse_object_serial;
|
||||
use crate::host::taint::snapshot::{
|
||||
ClientSnapshot, GlobalId, MediaRole, NodeProps, PortDirection, PortSnapshot, Serial,
|
||||
};
|
||||
use anyhow::{Context, Result};
|
||||
use pipewire::{self as pw, types::ObjectType};
|
||||
use std::cell::{Cell, RefCell};
|
||||
use std::collections::{BTreeMap, VecDeque};
|
||||
use std::rc::Rc;
|
||||
use std::sync::{Arc, Mutex};
|
||||
use std::thread::JoinHandle;
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
const READINESS_TIMEOUT_MILLIS: u64 = 2_000;
|
||||
const TICK_INTERVAL: Duration = Duration::from_millis(250);
|
||||
|
||||
/// Tokio-side access to the observer's most recent coherent projection.
|
||||
pub struct RegistryObserverHandle {
|
||||
latest: Arc<Mutex<Option<Projection>>>,
|
||||
shutdown_tx: pw::channel::Sender<()>,
|
||||
thread: Option<JoinHandle<()>>,
|
||||
}
|
||||
|
||||
impl RegistryObserverHandle {
|
||||
/// Spawn the read-only PipeWire registry observer.
|
||||
pub fn spawn() -> Result<Self> {
|
||||
let latest = Arc::new(Mutex::new(None));
|
||||
let latest_for_thread = Arc::clone(&latest);
|
||||
let (shutdown_tx, shutdown_rx) = pw::channel::channel::<()>();
|
||||
let thread = std::thread::Builder::new()
|
||||
.name("pixelpass-pw-observer".to_string())
|
||||
.spawn(move || {
|
||||
if let Err(e) = run_observer(latest_for_thread, shutdown_rx) {
|
||||
tracing::warn!(
|
||||
"registry observer: libpipewire thread exited with error: {e:#}"
|
||||
);
|
||||
}
|
||||
})
|
||||
.context("failed to spawn libpipewire registry observer thread")?;
|
||||
|
||||
Ok(Self {
|
||||
latest,
|
||||
shutdown_tx,
|
||||
thread: Some(thread),
|
||||
})
|
||||
}
|
||||
|
||||
/// Return a clone of the latest projection, or `None` before the first
|
||||
/// registry event has been applied.
|
||||
pub fn latest(&self) -> Option<Projection> {
|
||||
self.latest
|
||||
.lock()
|
||||
.unwrap_or_else(|poisoned| poisoned.into_inner())
|
||||
.clone()
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for RegistryObserverHandle {
|
||||
fn drop(&mut self) {
|
||||
let _ = self.shutdown_tx.send(());
|
||||
if let Some(thread) = self.thread.take()
|
||||
&& let Err(e) = thread.join()
|
||||
{
|
||||
tracing::warn!("registry observer: pw thread join failed: {e:?}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
struct BoundLink {
|
||||
_proxy: pw::link::Link,
|
||||
_listener: pw::link::LinkListener,
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct LiveGlobal {
|
||||
bound_link: Option<BoundLink>,
|
||||
}
|
||||
|
||||
struct ObserverState {
|
||||
model: RegistryModel,
|
||||
latest: Arc<Mutex<Option<Projection>>>,
|
||||
last_candidate: Option<u32>,
|
||||
live_globals: BTreeMap<GlobalId, VecDeque<LiveGlobal>>,
|
||||
}
|
||||
|
||||
impl ObserverState {
|
||||
fn new(latest: Arc<Mutex<Option<Projection>>>) -> Self {
|
||||
Self {
|
||||
model: RegistryModel::new(0, READINESS_TIMEOUT_MILLIS),
|
||||
latest,
|
||||
last_candidate: None,
|
||||
live_globals: BTreeMap::new(),
|
||||
}
|
||||
}
|
||||
|
||||
fn apply(&mut self, event: RegEvent) {
|
||||
self.model.apply(event);
|
||||
|
||||
let candidate = self.model.pulse_pid_candidate();
|
||||
if candidate != self.last_candidate {
|
||||
self.last_candidate = candidate;
|
||||
if let Some(pid) = candidate {
|
||||
let comm = std::fs::read_to_string(format!("/proc/{pid}/comm"))
|
||||
.ok()
|
||||
.map(|comm| comm.trim_end_matches(['\r', '\n']).to_string());
|
||||
self.model.apply(RegEvent::ProcCommProbed { pid, comm });
|
||||
}
|
||||
}
|
||||
|
||||
self.publish();
|
||||
}
|
||||
|
||||
fn publish(&self) {
|
||||
*self
|
||||
.latest
|
||||
.lock()
|
||||
.unwrap_or_else(|poisoned| poisoned.into_inner()) = Some(self.model.project());
|
||||
}
|
||||
|
||||
/// Record the global's id and apply its add event as one step, so the
|
||||
/// bound-link FIFO stays provably lockstep with the model's own `live_ids`
|
||||
/// index. Recording only on *applied* adds (never on unknown object types
|
||||
/// or globals dropped for a missing serial) is what keeps the two id
|
||||
/// queues the same length per id — otherwise a phantom slot ahead of a
|
||||
/// bound Link would be popped on removal, leaking that Link's proxy.
|
||||
fn add(&mut self, id: GlobalId, event: RegEvent) {
|
||||
self.live_globals
|
||||
.entry(id)
|
||||
.or_default()
|
||||
.push_back(LiveGlobal::default());
|
||||
self.apply(event);
|
||||
}
|
||||
|
||||
fn attach_bound_link(&mut self, id: GlobalId, bound_link: BoundLink) {
|
||||
let Some(global) = self.live_globals.get_mut(&id).and_then(VecDeque::back_mut) else {
|
||||
tracing::warn!(
|
||||
global_id = id.0,
|
||||
"registry observer: link bind completed without a live global slot"
|
||||
);
|
||||
return;
|
||||
};
|
||||
global.bound_link = Some(bound_link);
|
||||
}
|
||||
|
||||
fn remove_global(&mut self, id: GlobalId) -> Option<BoundLink> {
|
||||
let (bound_link, empty) = {
|
||||
let globals = self.live_globals.get_mut(&id)?;
|
||||
let bound_link = globals.pop_front().and_then(|global| global.bound_link);
|
||||
(bound_link, globals.is_empty())
|
||||
};
|
||||
if empty {
|
||||
self.live_globals.remove(&id);
|
||||
}
|
||||
bound_link
|
||||
}
|
||||
}
|
||||
|
||||
fn run_observer(
|
||||
latest: Arc<Mutex<Option<Projection>>>,
|
||||
shutdown_rx: pw::channel::Receiver<()>,
|
||||
) -> Result<()> {
|
||||
let started_at = Instant::now();
|
||||
let main_loop =
|
||||
pw::main_loop::MainLoopRc::new(None).context("pw main loop construction failed")?;
|
||||
let context =
|
||||
pw::context::ContextRc::new(&main_loop, None).context("pw context construction failed")?;
|
||||
let core = context
|
||||
.connect_rc(None)
|
||||
.context("pw core connect failed (is the daemon running?)")?;
|
||||
let registry = core.get_registry_rc().context("pw get_registry failed")?;
|
||||
let state = Rc::new(RefCell::new(ObserverState::new(latest)));
|
||||
|
||||
let main_loop_for_shutdown = main_loop.clone();
|
||||
let _shutdown_receiver = shutdown_rx.attach(main_loop.loop_(), move |()| {
|
||||
main_loop_for_shutdown.quit();
|
||||
});
|
||||
|
||||
let pending_sync = Rc::new(Cell::new(None));
|
||||
let pending_sync_for_done = Rc::clone(&pending_sync);
|
||||
let state_for_done = Rc::clone(&state);
|
||||
let _core_listener = core
|
||||
.add_listener_local()
|
||||
.done(move |id, seq| {
|
||||
if id == pw::core::PW_ID_CORE && pending_sync_for_done.get() == Some(seq) {
|
||||
pending_sync_for_done.set(None);
|
||||
state_for_done.borrow_mut().apply(RegEvent::ServerSynced);
|
||||
}
|
||||
})
|
||||
.error(|id, seq, res, message| {
|
||||
tracing::warn!(
|
||||
id,
|
||||
seq,
|
||||
result = res,
|
||||
%message,
|
||||
"registry observer: PipeWire core error"
|
||||
);
|
||||
})
|
||||
.register();
|
||||
|
||||
let registry_weak = registry.downgrade();
|
||||
let state_for_global = Rc::clone(&state);
|
||||
let state_for_remove = Rc::clone(&state);
|
||||
let _registry_listener = registry
|
||||
.add_listener_local()
|
||||
.global(move |obj| {
|
||||
let id = GlobalId(obj.id);
|
||||
|
||||
match obj.type_ {
|
||||
ObjectType::Node => {
|
||||
let Some(props) = obj.props.as_ref() else {
|
||||
tracing::warn!(
|
||||
node_id = obj.id,
|
||||
"registry observer: Node has no properties; dropping"
|
||||
);
|
||||
return;
|
||||
};
|
||||
let Some(serial) = parse_serial(obj.id, "Node", props.get("object.serial"))
|
||||
else {
|
||||
return;
|
||||
};
|
||||
let node_props = NodeProps {
|
||||
peerspeak_owned: truthy(props.get("peerspeak.owned")),
|
||||
pulse_module_id: props
|
||||
.get("pulse.module.id")
|
||||
.and_then(|value| value.parse::<u64>().ok()),
|
||||
link_group: props.get("node.link-group").map(str::to_owned),
|
||||
client_id: props
|
||||
.get("client.id")
|
||||
.and_then(|value| value.parse::<u32>().ok())
|
||||
.map(GlobalId),
|
||||
process_id: props
|
||||
.get("application.process.id")
|
||||
.and_then(|value| value.parse::<u32>().ok()),
|
||||
passthrough: truthy(props.get("node.passthrough")),
|
||||
session_device: false,
|
||||
};
|
||||
let observation = NodeObservation {
|
||||
serial,
|
||||
id,
|
||||
name: props.get("node.name").map(str::to_owned),
|
||||
role: MediaRole::parse(props.get("media.class")),
|
||||
props: node_props,
|
||||
device_claim: DeviceClaim {
|
||||
device_id: props
|
||||
.get("device.id")
|
||||
.and_then(|value| value.parse::<u32>().ok())
|
||||
.map(GlobalId),
|
||||
device_api: props.get("device.api").map(str::to_owned),
|
||||
factory_name: props.get("factory.name").map(str::to_owned),
|
||||
alsa_driver_name: props.get("alsa.driver_name").map(str::to_owned),
|
||||
},
|
||||
};
|
||||
state_for_global
|
||||
.borrow_mut()
|
||||
.add(id, RegEvent::NodeAdded(observation));
|
||||
}
|
||||
ObjectType::Port => {
|
||||
let Some(props) = obj.props.as_ref() else {
|
||||
tracing::warn!(
|
||||
port_id = obj.id,
|
||||
"registry observer: Port has no properties; dropping"
|
||||
);
|
||||
return;
|
||||
};
|
||||
let Some(serial) = parse_serial(obj.id, "Port", props.get("object.serial"))
|
||||
else {
|
||||
return;
|
||||
};
|
||||
let Some(node) = props
|
||||
.get("node.id")
|
||||
.and_then(|value| value.parse::<u32>().ok())
|
||||
.map(GlobalId)
|
||||
else {
|
||||
tracing::warn!(
|
||||
port_id = obj.id,
|
||||
node_id = props.get("node.id").unwrap_or("<absent>"),
|
||||
"registry observer: Port has no usable node.id; dropping"
|
||||
);
|
||||
return;
|
||||
};
|
||||
let direction = match props.get("port.direction") {
|
||||
Some("in") => PortDirection::In,
|
||||
Some("out") => PortDirection::Out,
|
||||
direction => {
|
||||
tracing::warn!(
|
||||
port_id = obj.id,
|
||||
direction = direction.unwrap_or("<absent>"),
|
||||
"registry observer: Port has no usable direction; dropping"
|
||||
);
|
||||
return;
|
||||
}
|
||||
};
|
||||
state_for_global.borrow_mut().add(
|
||||
id,
|
||||
RegEvent::PortAdded(PortSnapshot {
|
||||
serial,
|
||||
id,
|
||||
node,
|
||||
direction,
|
||||
exclusive: truthy(props.get("port.exclusive")),
|
||||
monitor: truthy(props.get("port.monitor")),
|
||||
}),
|
||||
);
|
||||
}
|
||||
ObjectType::Client => {
|
||||
let Some(props) = obj.props.as_ref() else {
|
||||
tracing::warn!(
|
||||
client_id = obj.id,
|
||||
"registry observer: Client has no properties; dropping"
|
||||
);
|
||||
return;
|
||||
};
|
||||
let Some(serial) = parse_serial(obj.id, "Client", props.get("object.serial"))
|
||||
else {
|
||||
return;
|
||||
};
|
||||
state_for_global.borrow_mut().add(
|
||||
id,
|
||||
RegEvent::ClientAdded(ClientSnapshot {
|
||||
serial,
|
||||
id,
|
||||
sec_pid: props
|
||||
.get("pipewire.sec.pid")
|
||||
.and_then(|value| value.parse::<u32>().ok()),
|
||||
}),
|
||||
);
|
||||
}
|
||||
ObjectType::Device => {
|
||||
state_for_global
|
||||
.borrow_mut()
|
||||
.add(id, RegEvent::DeviceAdded { id });
|
||||
}
|
||||
ObjectType::Link => {
|
||||
let Some(props) = obj.props.as_ref() else {
|
||||
tracing::warn!(
|
||||
link_id = obj.id,
|
||||
"registry observer: Link has no properties; dropping"
|
||||
);
|
||||
return;
|
||||
};
|
||||
let Some(serial) = parse_serial(obj.id, "Link", props.get("object.serial"))
|
||||
else {
|
||||
return;
|
||||
};
|
||||
let endpoints = link_endpoints_from_props(props);
|
||||
state_for_global.borrow_mut().add(
|
||||
id,
|
||||
RegEvent::LinkAdded {
|
||||
serial,
|
||||
id,
|
||||
endpoints,
|
||||
},
|
||||
);
|
||||
if endpoints.is_some() {
|
||||
return;
|
||||
}
|
||||
|
||||
let Some(registry) = registry_weak.upgrade() else {
|
||||
return;
|
||||
};
|
||||
let link: pw::link::Link = match registry.bind(obj) {
|
||||
Ok(link) => link,
|
||||
Err(e) => {
|
||||
tracing::warn!(
|
||||
link_id = obj.id,
|
||||
"registry observer: failed to bind Link for endpoints: {e}"
|
||||
);
|
||||
return;
|
||||
}
|
||||
};
|
||||
let resolved = Rc::new(Cell::new(false));
|
||||
let resolved_for_info = Rc::clone(&resolved);
|
||||
let state_for_info = Rc::downgrade(&state_for_global);
|
||||
let listener = link
|
||||
.add_listener_local()
|
||||
.info(move |info| {
|
||||
if resolved_for_info.replace(true) {
|
||||
return;
|
||||
}
|
||||
let endpoints = LinkEndpoints {
|
||||
output_node: GlobalId(info.output_node_id()),
|
||||
input_node: GlobalId(info.input_node_id()),
|
||||
output_port: optional_global_id(info.output_port_id()),
|
||||
input_port: optional_global_id(info.input_port_id()),
|
||||
};
|
||||
if let Some(state) = state_for_info.upgrade() {
|
||||
state
|
||||
.borrow_mut()
|
||||
.apply(RegEvent::LinkEndpointsResolved { serial, endpoints });
|
||||
}
|
||||
})
|
||||
.register();
|
||||
state_for_global.borrow_mut().attach_bound_link(
|
||||
id,
|
||||
BoundLink {
|
||||
_proxy: link,
|
||||
_listener: listener,
|
||||
},
|
||||
);
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
})
|
||||
.global_remove(move |id| {
|
||||
let id = GlobalId(id);
|
||||
let bound_link = state_for_remove.borrow_mut().remove_global(id);
|
||||
state_for_remove
|
||||
.borrow_mut()
|
||||
.apply(RegEvent::Removed { id });
|
||||
drop(bound_link);
|
||||
})
|
||||
.register();
|
||||
|
||||
pending_sync.set(Some(
|
||||
core.sync(0)
|
||||
.context("registry observer: initial core.sync failed")?,
|
||||
));
|
||||
|
||||
let state_for_tick = Rc::clone(&state);
|
||||
let timer = main_loop.loop_().add_timer(move |_| {
|
||||
let now = u64::try_from(started_at.elapsed().as_millis()).unwrap_or(u64::MAX);
|
||||
state_for_tick.borrow_mut().apply(RegEvent::Tick { now });
|
||||
});
|
||||
timer
|
||||
.update_timer(Some(TICK_INTERVAL), Some(TICK_INTERVAL))
|
||||
.into_result()
|
||||
.context("registry observer: failed to arm readiness timer")?;
|
||||
|
||||
tracing::info!("registry observer: pw thread running");
|
||||
main_loop.run();
|
||||
tracing::info!("registry observer: pw thread exiting");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn parse_serial(id: u32, kind: &str, raw: Option<&str>) -> Option<Serial> {
|
||||
match raw.and_then(parse_object_serial) {
|
||||
Some(serial) => Some(Serial(serial)),
|
||||
None => {
|
||||
tracing::warn!(
|
||||
global_id = id,
|
||||
object_type = kind,
|
||||
serial = raw.unwrap_or("<absent>"),
|
||||
"registry observer: global has no usable object.serial; dropping"
|
||||
);
|
||||
None
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn truthy(value: Option<&str>) -> bool {
|
||||
value.is_some_and(|value| value != "false" && value != "0")
|
||||
}
|
||||
|
||||
fn link_endpoints_from_props(props: &pw::spa::utils::dict::DictRef) -> Option<LinkEndpoints> {
|
||||
let output_node = props.get("link.output.node")?.parse::<u32>().ok()?;
|
||||
let input_node = props.get("link.input.node")?.parse::<u32>().ok()?;
|
||||
Some(LinkEndpoints {
|
||||
output_node: GlobalId(output_node),
|
||||
input_node: GlobalId(input_node),
|
||||
output_port: props
|
||||
.get("link.output.port")
|
||||
.and_then(|value| value.parse::<u32>().ok())
|
||||
.map(GlobalId),
|
||||
input_port: props
|
||||
.get("link.input.port")
|
||||
.and_then(|value| value.parse::<u32>().ok())
|
||||
.map(GlobalId),
|
||||
})
|
||||
}
|
||||
|
||||
fn optional_global_id(id: u32) -> Option<GlobalId> {
|
||||
(id != pw::constants::ID_ANY).then_some(GlobalId(id))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::process::Command;
|
||||
|
||||
struct PactlModule {
|
||||
id: Option<u32>,
|
||||
}
|
||||
|
||||
impl PactlModule {
|
||||
fn load(name: &str, args: &[String]) -> Self {
|
||||
let output = Command::new("pactl")
|
||||
.arg("load-module")
|
||||
.arg(name)
|
||||
.args(args)
|
||||
.output()
|
||||
.expect("pactl must be installed for the live observer test");
|
||||
assert!(
|
||||
output.status.success(),
|
||||
"pactl load-module {name} failed: {}",
|
||||
String::from_utf8_lossy(&output.stderr).trim()
|
||||
);
|
||||
let id = String::from_utf8(output.stdout)
|
||||
.expect("pactl module id must be UTF-8")
|
||||
.trim()
|
||||
.parse::<u32>()
|
||||
.expect("pactl module id must be a u32");
|
||||
Self { id: Some(id) }
|
||||
}
|
||||
|
||||
fn unload(mut self) {
|
||||
let id = self.id.take().expect("module must still be loaded");
|
||||
let output = Command::new("pactl")
|
||||
.arg("unload-module")
|
||||
.arg(id.to_string())
|
||||
.output()
|
||||
.expect("pactl must be installed for the live observer test");
|
||||
assert!(
|
||||
output.status.success(),
|
||||
"pactl unload-module {id} failed: {}",
|
||||
String::from_utf8_lossy(&output.stderr).trim()
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for PactlModule {
|
||||
fn drop(&mut self) {
|
||||
if let Some(id) = self.id.take() {
|
||||
let _ = Command::new("pactl")
|
||||
.arg("unload-module")
|
||||
.arg(id.to_string())
|
||||
.output();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn wait_for(
|
||||
observer: &RegistryObserverHandle,
|
||||
predicate: impl Fn(&Projection) -> bool,
|
||||
) -> Projection {
|
||||
let deadline = Instant::now() + Duration::from_secs(10);
|
||||
while Instant::now() < deadline {
|
||||
if let Some(projection) = observer.latest()
|
||||
&& predicate(&projection)
|
||||
{
|
||||
return projection;
|
||||
}
|
||||
std::thread::sleep(Duration::from_millis(50));
|
||||
}
|
||||
panic!("timed out waiting for the registry projection");
|
||||
}
|
||||
|
||||
fn has_node(projection: &Projection, name: &str) -> bool {
|
||||
projection
|
||||
.snapshot
|
||||
.nodes()
|
||||
.any(|node| node.name.as_deref() == Some(name))
|
||||
}
|
||||
|
||||
#[test]
|
||||
#[ignore = "needs live pipewire"]
|
||||
fn live_topology_diff_tracks_null_sink_and_loopback() {
|
||||
pw::init();
|
||||
let observer = RegistryObserverHandle::spawn().expect("observer thread must spawn");
|
||||
let baseline = wait_for(&observer, |projection| projection.graph_ready);
|
||||
let baseline_links = baseline.snapshot.links().count();
|
||||
|
||||
let unique = format!("pixelpass_observer_test_{}", std::process::id());
|
||||
let capture_name = format!("{unique}_capture");
|
||||
let playback_name = format!("{unique}_playback");
|
||||
let null_sink = PactlModule::load("module-null-sink", &[format!("sink_name={unique}")]);
|
||||
let with_sink = wait_for(&observer, |projection| has_node(projection, &unique));
|
||||
let sink_links = with_sink.snapshot.links().count();
|
||||
|
||||
let loopback = PactlModule::load(
|
||||
"module-loopback",
|
||||
&[
|
||||
format!("source={unique}.monitor"),
|
||||
format!("sink={unique}"),
|
||||
format!("source_output_properties=node.name={capture_name}"),
|
||||
format!("sink_input_properties=node.name={playback_name}"),
|
||||
],
|
||||
);
|
||||
wait_for(&observer, |projection| {
|
||||
has_node(projection, &capture_name)
|
||||
&& has_node(projection, &playback_name)
|
||||
&& projection.snapshot.links().count() > sink_links
|
||||
});
|
||||
|
||||
loopback.unload();
|
||||
null_sink.unload();
|
||||
wait_for(&observer, |projection| {
|
||||
!has_node(projection, &unique)
|
||||
&& !has_node(projection, &capture_name)
|
||||
&& !has_node(projection, &playback_name)
|
||||
&& projection.snapshot.links().count() <= baseline_links
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,161 @@
|
||||
//! The `session_device` classifier — pure, no PipeWire.
|
||||
//!
|
||||
//! `NodeProps::session_device` (see [`super::super::taint::snapshot`]) is a
|
||||
//! **positive high-confidence** claim that a node is a passive hardware
|
||||
//! terminal: a real sound card's sink or source that terminates audio rather
|
||||
//! than forwarding it. Setting it *removes* two protections at once — the
|
||||
//! node's coarse owner keys and its ability to trip the fail-closed backstop
|
||||
//! — so a false positive is a **leak**, and the whole classifier is shaped so
|
||||
//! that anything less than a positive identification resolves to `false`.
|
||||
//!
|
||||
//! The observer (phase 3) owes this classification; the adapter must never
|
||||
//! stuff a raw property through. Two facts from the design (v3.4 §6.1.1,
|
||||
//! Codex rounds 2–4) drive the shape here:
|
||||
//!
|
||||
//! - `device.id` / `device.api` describe *which* Device a node belongs to and
|
||||
//! *how* that Device is reached — **neither promises the node passively
|
||||
//! terminates audio.** A filter chain associated with a card satisfies
|
||||
//! both. So the discriminator is `factory.name` on an **allowlist** of
|
||||
//! real hardware-PCM factories, never a substring or a denylist: an unknown
|
||||
//! factory is not a device.
|
||||
//! - The backing Device must actually have been observed. A node that claims
|
||||
//! a `device.id` we have not yet resolved is **withheld**, not admitted with
|
||||
//! a provisional `false` — a provisional `false` during the not-ready
|
||||
//! window fuses sink and mic on the shared session client and that fusion
|
||||
//! can persist as sticky over-exclusion (round-3 finding 3).
|
||||
|
||||
use crate::host::taint::snapshot::GlobalId;
|
||||
|
||||
/// Factory names that positively identify a passive hardware-PCM terminal.
|
||||
///
|
||||
/// **An allowlist, deliberately.** Membership *removes* protections, so the
|
||||
/// safe error direction is to leave a genuine-but-unlisted device off the
|
||||
/// list (it merely keeps its owner keys — over-exclusion, no echo). Adding a
|
||||
/// backend here is a security-relevant change and wants the same measurement
|
||||
/// the ALSA entries got (snapshot.rs `session_device` contract: the target
|
||||
/// box's five ALSA nodes carry `factory.name=api.alsa.pcm.{sink,source}`; the
|
||||
/// three `support.null-audio-sink` nodes carry neither).
|
||||
///
|
||||
/// `support.null-audio-sink`, `*.loopback`, and any filter factory are
|
||||
/// intentionally **absent**: those forward audio, which is exactly the shape
|
||||
/// this feature must be able to exclude.
|
||||
///
|
||||
/// ⚠️ **ALSA only, and only these two, because they are the only factories
|
||||
/// measured on the target box.** BlueZ was previously listed here as
|
||||
/// `api.bluez5.pcm.{sink,source}` — those are invented; the real BlueZ
|
||||
/// terminals are `api.bluez5.media.{sink,source}` with profile aliases
|
||||
/// (Codex phase-3 review, finding 5). Rather than allowlist an unmeasured
|
||||
/// guess, BlueZ is left off entirely: a real Bluetooth sink then keeps its
|
||||
/// owner keys (over-exclusion — safe). Add BlueZ back only with a *measured*
|
||||
/// factory name and a fixture.
|
||||
const HARDWARE_PCM_FACTORIES: &[&str] = &[
|
||||
// ALSA — measured on the target box.
|
||||
"api.alsa.pcm.sink",
|
||||
"api.alsa.pcm.source",
|
||||
];
|
||||
|
||||
/// ALSA drivers that expose a hardware-PCM `factory.name` but are **not**
|
||||
/// passive terminals — audio written in reappears on their capture side
|
||||
/// through a path the PipeWire Link graph cannot see, so classifying them
|
||||
/// `session_device` (which drops owner keys and the fail-closed backstop)
|
||||
/// would let tainted audio loop back untainted (Codex phase-3 review,
|
||||
/// finding 2). `factory.name` alone cannot distinguish these from a real
|
||||
/// card — `snd_aloop` presents as `api.alsa.pcm.{sink,source}` exactly like
|
||||
/// `snd_hda_intel` — so a real ALSA terminal must present an `alsa.driver_name`
|
||||
/// that is **present and not on this denylist**; a missing driver fails closed
|
||||
/// (see [`classify`]). `snd_dummy` is intentionally absent: it is virtual but
|
||||
/// does not couple playback to capture, so it is not a loopback hazard.
|
||||
const NON_TERMINAL_ALSA_DRIVERS: &[&str] = &["snd_aloop"];
|
||||
|
||||
/// The three node properties the classifier reads, exactly as the adapter
|
||||
/// parsed them off the Node global. Kept separate from
|
||||
/// [`super::super::taint::snapshot::NodeProps`] because these feed the
|
||||
/// *decision* whose output is the `session_device` field — they are inputs,
|
||||
/// not part of the graph the engine reasons over.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq)]
|
||||
pub struct DeviceClaim {
|
||||
/// `device.id` — the Device this node belongs to, if any. Absent on
|
||||
/// `Stream/*` nodes, which is exactly why their absence means "not a
|
||||
/// device", not "unknown".
|
||||
pub device_id: Option<GlobalId>,
|
||||
/// `device.api` — the access API of that Device (e.g. `alsa`, `bluez5`).
|
||||
/// Its mere presence is **not** sufficient (a card-associated filter has
|
||||
/// it too); required only as a corroborating signal alongside the factory
|
||||
/// allowlist.
|
||||
pub device_api: Option<String>,
|
||||
/// `factory.name` — the discriminator. Only an allowlisted hardware-PCM
|
||||
/// factory earns `session_device`.
|
||||
pub factory_name: Option<String>,
|
||||
/// `alsa.driver_name` — the kernel driver behind an ALSA node (e.g.
|
||||
/// `snd_hda_intel`, `snd_usb_audio`, `snd_aloop`). Needed because the
|
||||
/// factory allowlist cannot tell a real card from a loopback driver that
|
||||
/// shares the same factory. `session_device` requires this to be
|
||||
/// **present and not** on [`NON_TERMINAL_ALSA_DRIVERS`]; a driver on the
|
||||
/// denylist, or an absent value, both fail closed (see [`classify`]).
|
||||
/// May be absent on non-ALSA backends or on version pairings that do not
|
||||
/// copy `alsa.*` onto the node.
|
||||
pub alsa_driver_name: Option<String>,
|
||||
}
|
||||
|
||||
/// The outcome of classifying one node's device claim.
|
||||
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
|
||||
pub enum Classification {
|
||||
/// No `device.id` — a `Stream/*` node. Admit with `session_device=false`.
|
||||
NotADevice,
|
||||
/// A `device.id` is claimed but the backing Device has not been resolved
|
||||
/// yet. **Withhold the node and keep the readiness epoch not-ready**;
|
||||
/// re-classify when the Device is observed.
|
||||
Withhold { device_id: GlobalId },
|
||||
/// Positively a passive hardware terminal. Admit with
|
||||
/// `session_device=true`.
|
||||
SessionDevice,
|
||||
/// Backed by a *resolved* Device but not a hardware-PCM terminal — a
|
||||
/// filter or virtual node on a card, an unknown factory, or a Device with
|
||||
/// no `device.api`. Admit with `session_device=false` (fail closed).
|
||||
NotSessionDevice,
|
||||
}
|
||||
|
||||
/// Classify a node's device claim.
|
||||
///
|
||||
/// `device_resolved` is whether [`DeviceClaim::device_id`] has been observed
|
||||
/// as a Device global; it is only consulted when a `device_id` is present.
|
||||
/// Pure: the model supplies `device_resolved` from its resolved-Device set,
|
||||
/// and the I/O of *binding* the Device lives in the adapter.
|
||||
pub fn classify(claim: &DeviceClaim, device_resolved: bool) -> Classification {
|
||||
let Some(device_id) = claim.device_id else {
|
||||
// No backing Device: a stream. Not withheld, not a device.
|
||||
return Classification::NotADevice;
|
||||
};
|
||||
if !device_resolved {
|
||||
// Backed by a Device we have not seen — the one case that blocks
|
||||
// readiness. A provisional answer here is the leak the contract
|
||||
// forbids.
|
||||
return Classification::Withhold { device_id };
|
||||
}
|
||||
let on_factory_allowlist = claim
|
||||
.factory_name
|
||||
.as_deref()
|
||||
.is_some_and(|f| HARDWARE_PCM_FACTORIES.contains(&f));
|
||||
// A **present, non-denied** ALSA driver is required — absence fails closed
|
||||
// (Codex phase-3 re-review). `alsa.driver_name` is not copied onto the
|
||||
// node on every PipeWire/WirePlumber version pairing (PipeWire ≥1.2.6
|
||||
// stopped overwriting node props with card props; WirePlumber only began
|
||||
// copying `alsa.*` onto nodes in 0.5.13), so a *missing* value must not be
|
||||
// read as "not a loopback" — that is exactly the hole an `snd_aloop` node
|
||||
// without the property would slip through. A real card whose node lacks
|
||||
// the driver is instead over-excluded (keeps its owner keys — safe);
|
||||
// recovering `session_device` for it needs reading the driver from the
|
||||
// backing Device global, which is owed to a later round.
|
||||
let driver_ok = claim
|
||||
.alsa_driver_name
|
||||
.as_deref()
|
||||
.is_some_and(|d| !NON_TERMINAL_ALSA_DRIVERS.contains(&d));
|
||||
let is_hardware_pcm = claim.device_api.is_some() && on_factory_allowlist && driver_ok;
|
||||
if is_hardware_pcm {
|
||||
Classification::SessionDevice
|
||||
} else {
|
||||
// Resolved, but not positively a terminal: fail closed to false so
|
||||
// the node keeps its owner keys and its backstop.
|
||||
Classification::NotSessionDevice
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,512 @@
|
||||
//! The registry observer's **pure core** (impl plan §4, phase 3).
|
||||
//!
|
||||
//! This is my half of the phase-3 split: a reducer that folds a stream of
|
||||
//! typed [`RegEvent`]s into a live model of the PipeWire graph and projects
|
||||
//! the [`GraphSnapshot`] + context the taint engine (phase 2) consumes. **No
|
||||
//! PipeWire types appear here** — the I/O adapter (Codex's half) translates
|
||||
//! live registry callbacks, Link/Device binds, `/proc` reads, and the
|
||||
//! `core.sync`/`done` round-trip into these events and feeds them in. Every
|
||||
//! test in this module builds the event stream by hand.
|
||||
//!
|
||||
//! Three things this core is shaped to get right, each an exit-gate row:
|
||||
//!
|
||||
//! - **Removal by recycled id.** `global_remove` names only a 32-bit global
|
||||
//! id, and those recycle. The model keeps an insertion-ordered index per id
|
||||
//! so a removal accounts for the *oldest* generation first, and the
|
||||
//! snapshot projection treats any id still claimed by two live objects as
|
||||
//! [`IdLookup::Ambiguous`] — fail closed (v3.4 §6.1.3).
|
||||
//! - **The readiness epoch.** `graph_ready` is false until the initial graph
|
||||
//! is fully observed: the server has synced **and** no binds/withheld nodes
|
||||
//! remain outstanding. A bounded timeout makes it fail closed. It gates
|
||||
//! sticky *retirement* only; withholding after completion is per-object.
|
||||
//! - **Withholding on unresolved devices.** A node claiming a `device.id`
|
||||
//! whose Device we have not observed is held out of the snapshot entirely
|
||||
//! rather than admitted with a provisional `session_device` (see
|
||||
//! [`classify`]).
|
||||
//!
|
||||
//! **Two accepted limitations (Codex phase-3 review, findings 3 and 4), both
|
||||
//! low-reachability, owed to a later hardening round:**
|
||||
//!
|
||||
//! - *A Link dropped for a missing `object.serial`/props is unrepresented.*
|
||||
//! The adapter drops such a global before it reaches [`RegistryModel`], so
|
||||
//! readiness can reach `Complete` while permanently omitting that Link — an
|
||||
//! invisible edge that could hide tainted ancestry. **Not reachable in
|
||||
//! practice:** PipeWire's native protocol defines `object.serial` as the
|
||||
//! unique identity every global carries, so a Link without one requires a
|
||||
//! protocol/server failure, not ordinary churn. (The live gate is
|
||||
//! consistent with this but does not *prove* it — it only counts Links the
|
||||
//! strict parser already admitted.) A full fix needs a pure
|
||||
//! "required-observation-failed" token that holds readiness false; deferred
|
||||
//! rather than built for a case that does not occur.
|
||||
//! - *Removal generation ordering assumes no removal is silently lost.* On a
|
||||
//! recycled id with two live claimants, [`Self::on_removed`] retires the
|
||||
//! oldest generation first; if the *first* generation's removal was never
|
||||
//! delivered, a later removal is misattributed. PipeWire's registry does not
|
||||
//! silently drop `global_remove`, so this needs callback loss to trigger.
|
||||
//! The snapshot treats the two-claimant window as [`IdLookup::Ambiguous`]
|
||||
//! (fail closed) meanwhile.
|
||||
|
||||
#![allow(dead_code)] // Wired by the phase-3 adapter (Codex's half) and consumed by later phases.
|
||||
|
||||
pub mod adapter;
|
||||
pub mod classify;
|
||||
pub mod pulse_pid;
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
||||
use crate::host::taint::snapshot::{
|
||||
ClientSnapshot, GlobalId, GraphSnapshot, LinkSnapshot, MediaRole, NodeProps, NodeSnapshot,
|
||||
PortSnapshot, Serial,
|
||||
};
|
||||
use classify::{Classification, DeviceClaim};
|
||||
use std::collections::{BTreeMap, VecDeque};
|
||||
|
||||
/// A monotonic millisecond clock value, supplied by the adapter via
|
||||
/// [`RegEvent::Tick`]. Kept as a bare integer rather than
|
||||
/// [`std::time::Instant`] so the readiness timeout is deterministic in tests.
|
||||
pub type Millis = u64;
|
||||
|
||||
/// A Node as observed off the registry, before `session_device` has been
|
||||
/// decided. The adapter fills [`NodeProps`] with everything it can parse and
|
||||
/// leaves `session_device` at its `false` default; the model overwrites it
|
||||
/// from the [`classify`] result once the backing Device (if any) is resolved.
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct NodeObservation {
|
||||
pub serial: Serial,
|
||||
pub id: GlobalId,
|
||||
pub name: Option<String>,
|
||||
pub role: MediaRole,
|
||||
pub props: NodeProps,
|
||||
pub device_claim: DeviceClaim,
|
||||
}
|
||||
|
||||
/// The four endpoint references a Link carries. Node endpoints are required —
|
||||
/// a Link with unknown nodes is useless — so this whole struct is what the
|
||||
/// adapter must resolve (from the global's props if present, else by binding
|
||||
/// `LinkInfoRef`, the correctness path) before a Link enters the snapshot.
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub struct LinkEndpoints {
|
||||
pub output_node: GlobalId,
|
||||
pub input_node: GlobalId,
|
||||
pub output_port: Option<GlobalId>,
|
||||
pub input_port: Option<GlobalId>,
|
||||
}
|
||||
|
||||
/// A typed observation of the live graph. The adapter produces these; the
|
||||
/// model consumes them in [`RegistryModel::apply`].
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub enum RegEvent {
|
||||
/// A Node global appeared. Admitted immediately unless it claims an
|
||||
/// unresolved Device (then withheld — see [`classify`]).
|
||||
NodeAdded(NodeObservation),
|
||||
/// A Port global appeared.
|
||||
PortAdded(PortSnapshot),
|
||||
/// A Client global appeared. Feeds pulse-PID derivation via `sec_pid`.
|
||||
ClientAdded(ClientSnapshot),
|
||||
/// A Device global appeared. Resolves any nodes withheld on its id.
|
||||
DeviceAdded { id: GlobalId },
|
||||
/// A Link global appeared. `endpoints` is `Some` when the global carried
|
||||
/// them (the optimisation) and `None` when the adapter must bind to learn
|
||||
/// them (the correctness path) — the latter is an outstanding obligation
|
||||
/// until a matching [`RegEvent::LinkEndpointsResolved`] arrives.
|
||||
LinkAdded {
|
||||
serial: Serial,
|
||||
id: GlobalId,
|
||||
endpoints: Option<LinkEndpoints>,
|
||||
},
|
||||
/// The bind-`LinkInfoRef` fallback resolved a Link's endpoints.
|
||||
LinkEndpointsResolved {
|
||||
serial: Serial,
|
||||
endpoints: LinkEndpoints,
|
||||
},
|
||||
/// The adapter read `/proc/<pid>/comm` (`None` = the read failed / the
|
||||
/// process is gone). Validates the pulse-PID candidate.
|
||||
ProcCommProbed { pid: u32, comm: Option<String> },
|
||||
/// Any global was removed. Only its 32-bit id is known.
|
||||
Removed { id: GlobalId },
|
||||
/// A `core.sync()` issued after the initial enumeration completed its
|
||||
/// round-trip (`done`). One half of readiness; the other is that no
|
||||
/// binds/withheld nodes are still outstanding.
|
||||
ServerSynced,
|
||||
/// A monotonic clock sample. Drives the readiness timeout only.
|
||||
Tick { now: Millis },
|
||||
}
|
||||
|
||||
/// Which slot in the id index a live object occupies. `global_remove` gives
|
||||
/// only the id, so the index remembers what each id currently holds. A Node
|
||||
/// slot's serial may live in either the admitted or the withheld map.
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
enum Slot {
|
||||
Node(Serial),
|
||||
Port(Serial),
|
||||
Link(Serial),
|
||||
Client(Serial),
|
||||
Device,
|
||||
}
|
||||
|
||||
/// The readiness epoch. A one-time transition out of [`Readiness::Waiting`];
|
||||
/// both terminal states are sticky (a completed graph is not un-completed by
|
||||
/// later per-object withholding, and a timed-out observer stays fail-closed
|
||||
/// for its lifetime).
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub enum Readiness {
|
||||
/// The initial enumeration is still in flight.
|
||||
Waiting,
|
||||
/// The initial enumeration finished at least once (server synced with no
|
||||
/// obligations then outstanding). **Sticky** — later per-object
|
||||
/// withholding does not revert it. Note this is *not* the same as
|
||||
/// [`RegistryModel::graph_ready`], which additionally requires no *current*
|
||||
/// obligation (Codex finding 1); `Complete` only records that the epoch
|
||||
/// was reached.
|
||||
Complete,
|
||||
/// The bounded deadline passed with obligations outstanding.
|
||||
/// `graph_ready` stays false — fail closed.
|
||||
TimedOut,
|
||||
}
|
||||
|
||||
/// The pure handoff to the taint engine: a coherent [`GraphSnapshot`] plus the
|
||||
/// two context fields phase 3 owns. The caller merges these into
|
||||
/// [`crate::host::taint::ExclusionCtx`] alongside `aec_module_id` (phase 4)
|
||||
/// and `pixelpass_owned` (pixelpass's own tracking).
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct Projection {
|
||||
pub snapshot: GraphSnapshot,
|
||||
pub pipewire_pulse_pid: Option<u32>,
|
||||
pub graph_ready: bool,
|
||||
}
|
||||
|
||||
/// The live model. Folds [`RegEvent`]s; project with [`RegistryModel::project`].
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct RegistryModel {
|
||||
// Admitted objects, keyed by their never-recycled serial.
|
||||
nodes: BTreeMap<Serial, NodeSnapshot>,
|
||||
ports: BTreeMap<Serial, PortSnapshot>,
|
||||
links: BTreeMap<Serial, LinkSnapshot>,
|
||||
clients: BTreeMap<Serial, ClientSnapshot>,
|
||||
|
||||
/// Nodes held out of the snapshot pending their Device's resolution.
|
||||
withheld: BTreeMap<Serial, NodeObservation>,
|
||||
/// Links whose endpoints the adapter is still binding; the id is kept so
|
||||
/// removal and resolution can find them.
|
||||
pending_links: BTreeMap<Serial, GlobalId>,
|
||||
|
||||
/// Live Device global ids, ref-counted so a recycled id is only
|
||||
/// considered resolved while a Device actually holds it.
|
||||
resolved_devices: BTreeMap<GlobalId, usize>,
|
||||
|
||||
/// Insertion-ordered holders of each live global id. `global_remove`
|
||||
/// accounts for the oldest generation first (v3.4 §6.1.3).
|
||||
live_ids: BTreeMap<GlobalId, VecDeque<Slot>>,
|
||||
|
||||
/// `/proc/<pid>/comm` reads keyed by pid, for pulse-PID validation.
|
||||
probed_comm: BTreeMap<u32, Option<String>>,
|
||||
|
||||
server_synced: bool,
|
||||
readiness: Readiness,
|
||||
deadline: Millis,
|
||||
last_now: Millis,
|
||||
}
|
||||
|
||||
impl RegistryModel {
|
||||
/// `now` seeds the clock; `timeout` is the readiness budget. The deadline
|
||||
/// is `now + timeout`; a [`RegEvent::Tick`] at or past it while still
|
||||
/// [`Readiness::Waiting`] fails the epoch closed.
|
||||
pub fn new(now: Millis, timeout: Millis) -> Self {
|
||||
Self {
|
||||
nodes: BTreeMap::new(),
|
||||
ports: BTreeMap::new(),
|
||||
links: BTreeMap::new(),
|
||||
clients: BTreeMap::new(),
|
||||
withheld: BTreeMap::new(),
|
||||
pending_links: BTreeMap::new(),
|
||||
resolved_devices: BTreeMap::new(),
|
||||
live_ids: BTreeMap::new(),
|
||||
probed_comm: BTreeMap::new(),
|
||||
server_synced: false,
|
||||
readiness: Readiness::Waiting,
|
||||
deadline: now.saturating_add(timeout),
|
||||
last_now: now,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn readiness(&self) -> Readiness {
|
||||
self.readiness
|
||||
}
|
||||
|
||||
/// Whether the graph is trustworthy enough to make eligibility and sticky
|
||||
/// **retirement** decisions right now.
|
||||
///
|
||||
/// This is **dynamic**, not the sticky [`Readiness::Complete`] flag: it is
|
||||
/// true only when the initial enumeration has completed **and** there are
|
||||
/// no current obligations outstanding (a node withheld on an unresolved
|
||||
/// Device, or a Link still being bound). The distinction is the fix for
|
||||
/// Codex phase-3 review finding 1: a Link whose endpoints are still
|
||||
/// resolving is an **invisible edge** — it is absent from the snapshot,
|
||||
/// not merely dangling — so a decision made while one exists can miss real
|
||||
/// tainted ancestry and wrongly report a candidate eligible. Unresolved
|
||||
/// ancestry ⇒ fail closed is the governing invariant (v3.4 §6.1), and an
|
||||
/// unresolved Link is unresolved ancestry, so `graph_ready` must drop back
|
||||
/// to false whenever one is pending — even after the initial epoch.
|
||||
///
|
||||
/// [`Readiness::Complete`] stays sticky (it records that the initial
|
||||
/// enumeration happened, for logging and to distinguish "not started" from
|
||||
/// "momentarily churning"); `graph_ready` layers the dynamic obligation
|
||||
/// check on top. Downstream (phase 6) may debounce the brief blips a
|
||||
/// normal Link bind causes; the observer's job is to report the truth.
|
||||
pub fn graph_ready(&self) -> bool {
|
||||
matches!(self.readiness, Readiness::Complete) && !self.obligations_outstanding()
|
||||
}
|
||||
|
||||
/// The pulse-PID candidate the adapter should be probing (`None` = no
|
||||
/// repeated `sec_pid`, nothing to probe). Exposed so the adapter re-probes
|
||||
/// only when the candidate changes.
|
||||
pub fn pulse_pid_candidate(&self) -> Option<u32> {
|
||||
let clients: Vec<ClientSnapshot> = self.clients.values().cloned().collect();
|
||||
pulse_pid::candidate(&clients)
|
||||
}
|
||||
|
||||
/// Fold one observation into the model.
|
||||
pub fn apply(&mut self, event: RegEvent) {
|
||||
match event {
|
||||
RegEvent::NodeAdded(obs) => self.on_node_added(obs),
|
||||
RegEvent::PortAdded(port) => {
|
||||
self.push_id(port.id, Slot::Port(port.serial));
|
||||
self.ports.insert(port.serial, port);
|
||||
}
|
||||
RegEvent::ClientAdded(client) => {
|
||||
self.push_id(client.id, Slot::Client(client.serial));
|
||||
self.clients.insert(client.serial, client);
|
||||
// A new client can change the pulse candidate; the adapter
|
||||
// learns that via `pulse_pid_candidate`. No readiness effect.
|
||||
}
|
||||
RegEvent::DeviceAdded { id } => self.on_device_added(id),
|
||||
RegEvent::LinkAdded {
|
||||
serial,
|
||||
id,
|
||||
endpoints,
|
||||
} => self.on_link_added(serial, id, endpoints),
|
||||
RegEvent::LinkEndpointsResolved { serial, endpoints } => {
|
||||
self.on_link_resolved(serial, endpoints)
|
||||
}
|
||||
RegEvent::ProcCommProbed { pid, comm } => {
|
||||
self.probed_comm.insert(pid, comm);
|
||||
}
|
||||
RegEvent::Removed { id } => self.on_removed(id),
|
||||
RegEvent::ServerSynced => {
|
||||
self.server_synced = true;
|
||||
self.maybe_complete();
|
||||
}
|
||||
RegEvent::Tick { now } => {
|
||||
self.last_now = now;
|
||||
self.maybe_timeout(now);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn on_node_added(&mut self, obs: NodeObservation) {
|
||||
self.push_id(obs.id, Slot::Node(obs.serial));
|
||||
let resolved = obs
|
||||
.device_claim
|
||||
.device_id
|
||||
.is_some_and(|id| self.device_resolved(id));
|
||||
match classify::classify(&obs.device_claim, resolved) {
|
||||
Classification::Withhold { .. } => {
|
||||
self.withheld.insert(obs.serial, obs);
|
||||
}
|
||||
Classification::SessionDevice => self.admit_node(obs, true),
|
||||
Classification::NotADevice | Classification::NotSessionDevice => {
|
||||
self.admit_node(obs, false)
|
||||
}
|
||||
}
|
||||
// Withholding a node adds an obligation; admitting one can never
|
||||
// complete readiness on its own, but re-check is cheap and keeps the
|
||||
// invariant local.
|
||||
self.maybe_complete();
|
||||
}
|
||||
|
||||
fn admit_node(&mut self, obs: NodeObservation, session_device: bool) {
|
||||
let mut props = obs.props;
|
||||
props.session_device = session_device;
|
||||
self.nodes.insert(
|
||||
obs.serial,
|
||||
NodeSnapshot {
|
||||
serial: obs.serial,
|
||||
id: obs.id,
|
||||
name: obs.name,
|
||||
role: obs.role,
|
||||
props,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
fn on_device_added(&mut self, id: GlobalId) {
|
||||
self.push_id(id, Slot::Device);
|
||||
*self.resolved_devices.entry(id).or_insert(0) += 1;
|
||||
// Admit every node that was withheld waiting on exactly this Device.
|
||||
let ready: Vec<Serial> = self
|
||||
.withheld
|
||||
.iter()
|
||||
.filter(|(_, obs)| obs.device_claim.device_id == Some(id))
|
||||
.map(|(&serial, _)| serial)
|
||||
.collect();
|
||||
for serial in ready {
|
||||
if let Some(obs) = self.withheld.remove(&serial) {
|
||||
// Resolved now, so classify yields a terminal answer, never
|
||||
// Withhold again.
|
||||
let session_device = matches!(
|
||||
classify::classify(&obs.device_claim, true),
|
||||
Classification::SessionDevice
|
||||
);
|
||||
self.admit_node(obs, session_device);
|
||||
}
|
||||
}
|
||||
self.maybe_complete();
|
||||
}
|
||||
|
||||
fn on_link_added(&mut self, serial: Serial, id: GlobalId, endpoints: Option<LinkEndpoints>) {
|
||||
self.push_id(id, Slot::Link(serial));
|
||||
match endpoints {
|
||||
Some(e) => {
|
||||
self.links.insert(serial, link_snapshot(serial, id, e));
|
||||
}
|
||||
None => {
|
||||
// Correctness path: withhold the Link until the bind fallback
|
||||
// resolves it. Counts as an outstanding obligation.
|
||||
self.pending_links.insert(serial, id);
|
||||
}
|
||||
}
|
||||
self.maybe_complete();
|
||||
}
|
||||
|
||||
fn on_link_resolved(&mut self, serial: Serial, endpoints: LinkEndpoints) {
|
||||
// `remove` also guards against a stale resolution for a Link already
|
||||
// gone: unknown serial ⇒ ignore.
|
||||
if let Some(id) = self.pending_links.remove(&serial) {
|
||||
self.links
|
||||
.insert(serial, link_snapshot(serial, id, endpoints));
|
||||
self.maybe_complete();
|
||||
}
|
||||
}
|
||||
|
||||
fn on_removed(&mut self, id: GlobalId) {
|
||||
let Some(queue) = self.live_ids.get_mut(&id) else {
|
||||
tracing::warn!(global_id = id.0, "observer: remove for an id we never saw");
|
||||
return;
|
||||
};
|
||||
// Oldest generation first — the id may be shared during a
|
||||
// missed-removal window.
|
||||
let slot = queue.pop_front();
|
||||
if queue.is_empty() {
|
||||
self.live_ids.remove(&id);
|
||||
}
|
||||
match slot {
|
||||
Some(Slot::Node(serial)) => {
|
||||
if self.nodes.remove(&serial).is_none() {
|
||||
// Was still withheld — drop the obligation.
|
||||
self.withheld.remove(&serial);
|
||||
}
|
||||
}
|
||||
Some(Slot::Port(serial)) => {
|
||||
self.ports.remove(&serial);
|
||||
}
|
||||
Some(Slot::Link(serial)) => {
|
||||
self.links.remove(&serial);
|
||||
self.pending_links.remove(&serial);
|
||||
}
|
||||
Some(Slot::Client(serial)) => {
|
||||
self.clients.remove(&serial);
|
||||
}
|
||||
Some(Slot::Device) => {
|
||||
if let Some(count) = self.resolved_devices.get_mut(&id) {
|
||||
*count -= 1;
|
||||
if *count == 0 {
|
||||
self.resolved_devices.remove(&id);
|
||||
}
|
||||
}
|
||||
}
|
||||
None => {
|
||||
tracing::warn!(global_id = id.0, "observer: empty id slot on remove");
|
||||
}
|
||||
}
|
||||
// A removal can drain the last obligation (a withheld node or pending
|
||||
// link vanished before it resolved).
|
||||
self.maybe_complete();
|
||||
}
|
||||
|
||||
fn push_id(&mut self, id: GlobalId, slot: Slot) {
|
||||
self.live_ids.entry(id).or_default().push_back(slot);
|
||||
}
|
||||
|
||||
fn device_resolved(&self, id: GlobalId) -> bool {
|
||||
self.resolved_devices.get(&id).is_some_and(|&n| n > 0)
|
||||
}
|
||||
|
||||
/// Every obligation that must clear before the initial graph is trusted:
|
||||
/// no node withheld on an unresolved Device, no Link awaiting its bind.
|
||||
fn obligations_outstanding(&self) -> bool {
|
||||
!self.withheld.is_empty() || !self.pending_links.is_empty()
|
||||
}
|
||||
|
||||
/// Completion needs no clock — only the sync flag and an empty obligation
|
||||
/// set — so it may fire on any mutating event. Sticky once reached.
|
||||
fn maybe_complete(&mut self) {
|
||||
if self.readiness != Readiness::Waiting {
|
||||
return;
|
||||
}
|
||||
if self.server_synced && !self.obligations_outstanding() {
|
||||
self.readiness = Readiness::Complete;
|
||||
tracing::info!("observer: readiness epoch reached (synced + no obligations)");
|
||||
}
|
||||
}
|
||||
|
||||
/// Only the timeout consults the clock.
|
||||
fn maybe_timeout(&mut self, now: Millis) {
|
||||
if self.readiness != Readiness::Waiting {
|
||||
return;
|
||||
}
|
||||
if now >= self.deadline {
|
||||
self.readiness = Readiness::TimedOut;
|
||||
tracing::warn!(
|
||||
withheld = self.withheld.len(),
|
||||
pending_links = self.pending_links.len(),
|
||||
"observer: readiness epoch timed out with obligations outstanding — fail closed"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// pipewire-pulse's PID from the current clients, validated against the
|
||||
/// probed `comm`. `None` whenever anything is ambiguous or unconfirmed —
|
||||
/// the safe answer (key 4 unusable).
|
||||
fn pulse_pid(&self) -> Option<u32> {
|
||||
let candidate = self.pulse_pid_candidate()?;
|
||||
let comm = self.probed_comm.get(&candidate).and_then(|c| c.as_deref());
|
||||
pulse_pid::validate(candidate, comm)
|
||||
}
|
||||
|
||||
/// Project the current state into the taint engine's inputs.
|
||||
pub fn project(&self) -> Projection {
|
||||
let snapshot = GraphSnapshot::new(
|
||||
self.nodes.values().cloned().collect(),
|
||||
self.ports.values().cloned().collect(),
|
||||
self.links.values().cloned().collect(),
|
||||
self.clients.values().cloned().collect(),
|
||||
);
|
||||
Projection {
|
||||
snapshot,
|
||||
pipewire_pulse_pid: self.pulse_pid(),
|
||||
graph_ready: self.graph_ready(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn link_snapshot(serial: Serial, id: GlobalId, e: LinkEndpoints) -> LinkSnapshot {
|
||||
LinkSnapshot {
|
||||
serial,
|
||||
id,
|
||||
output_node: e.output_node,
|
||||
input_node: e.input_node,
|
||||
output_port: e.output_port,
|
||||
input_port: e.input_port,
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,89 @@
|
||||
//! Deriving pipewire-pulse's own PID — pure, no PipeWire and no `/proc` I/O.
|
||||
//!
|
||||
//! The owner bridge's key 4 is `application.process.id`. For a stream created
|
||||
//! by a **Pulse-emulated** client that PID is *pipewire-pulse's own*, shared
|
||||
//! verbatim across every unrelated Pulse app, so bridging on it would fuse
|
||||
//! every Pulse module into one tainted owner (design v3.4 §5.2 correction 5,
|
||||
//! §6.1.2). The engine therefore needs to know that one PID so it can refuse
|
||||
//! to bridge on it — and **every** way of deriving it can fail, in which case
|
||||
//! the safe answer is `None`: key 4 becomes unusable (coarser, never wrong).
|
||||
//!
|
||||
//! The derivation is split into two pure stages so the I/O — reading
|
||||
//! `/proc/<pid>/comm` — stays in the adapter:
|
||||
//!
|
||||
//! 1. [`candidate`] finds the PID that *looks* like pulse from the graph
|
||||
//! alone: the `pipewire.sec.pid` value shared across multiple Clients.
|
||||
//! Native PipeWire clients carry their own distinct PID; only the
|
||||
//! Pulse shim repeats one value, so a repeated value is the signal.
|
||||
//! 2. [`validate`] confirms that candidate against the `comm` the adapter
|
||||
//! read from `/proc`. This is what closes **PID reuse**: a recycled PID
|
||||
//! that coincidentally repeats in the graph is rejected because
|
||||
//! `/proc/<pid>/comm` now names a different process.
|
||||
//!
|
||||
//! Any failure at either stage — no repeated value, two repeated values,
|
||||
//! the property missing, `/proc` gone, a `comm` mismatch — yields `None`.
|
||||
|
||||
use crate::host::taint::snapshot::ClientSnapshot;
|
||||
use std::collections::BTreeMap;
|
||||
|
||||
/// The kernel `comm` of the pipewire-pulse process. `comm` is truncated to
|
||||
/// 15 bytes by the kernel; `pipewire-pulse` is 14 bytes, so it is exact —
|
||||
/// and exact is the only safe match, since a prefix match would accept a
|
||||
/// recycled PID belonging to e.g. `pipewire-pulseX`.
|
||||
const PULSE_COMM: &str = "pipewire-pulse";
|
||||
|
||||
/// Stage 1: the PID that looks like pipewire-pulse from the client graph.
|
||||
///
|
||||
/// Returns `Some(pid)` only when **exactly one** `pipewire.sec.pid` value is
|
||||
/// shared by two or more clients. Rationale, matched to the failure matrix:
|
||||
///
|
||||
/// - **consistent** — one value repeats, the rest (native clients) are
|
||||
/// distinct ⇒ that value.
|
||||
/// - **inconsistent** — two or more values each repeat ⇒ we cannot tell which
|
||||
/// is pulse ⇒ `None`.
|
||||
/// - **missing property** — the Pulse clients carry no `sec_pid` ⇒ nothing
|
||||
/// repeats ⇒ `None`.
|
||||
///
|
||||
/// A count threshold of two is deliberate: a single client carrying a PID is
|
||||
/// indistinguishable from a lone native app, and pulse always mints many.
|
||||
pub fn candidate(clients: &[ClientSnapshot]) -> Option<u32> {
|
||||
let mut counts: BTreeMap<u32, usize> = BTreeMap::new();
|
||||
for client in clients {
|
||||
if let Some(pid) = client.sec_pid {
|
||||
*counts.entry(pid).or_insert(0) += 1;
|
||||
}
|
||||
}
|
||||
|
||||
// Every PID seen on 2+ clients is a pulse candidate. If there is exactly
|
||||
// one such PID we trust it; zero or several ⇒ fail closed.
|
||||
let mut repeated = counts.iter().filter(|&(_, &n)| n >= 2).map(|(&pid, _)| pid);
|
||||
let first = repeated.next()?;
|
||||
if repeated.next().is_some() {
|
||||
// Ambiguous: more than one value repeats.
|
||||
return None;
|
||||
}
|
||||
Some(first)
|
||||
}
|
||||
|
||||
/// Stage 2: confirm the candidate against the `comm` read from
|
||||
/// `/proc/<candidate>/comm`.
|
||||
///
|
||||
/// `comm` is `None` when the adapter's read failed — the `/proc` entry is
|
||||
/// gone (the process exited between derivation and probe) — which is itself a
|
||||
/// reason to fail closed. A present-but-different `comm` is the **PID reuse**
|
||||
/// guard: the number is live but now belongs to someone else.
|
||||
pub fn validate(candidate: u32, comm: Option<&str>) -> Option<u32> {
|
||||
match comm {
|
||||
Some(PULSE_COMM) => Some(candidate),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
/// The two stages composed, for callers that already hold the probed `comm`.
|
||||
/// The model keeps them separate (it recomputes the candidate as clients
|
||||
/// churn, and only re-probes when the candidate *changes*), so this is a
|
||||
/// convenience for tests and for the fully-resolved path.
|
||||
pub fn derive(clients: &[ClientSnapshot], comm_of: impl Fn(u32) -> Option<String>) -> Option<u32> {
|
||||
let candidate = candidate(clients)?;
|
||||
validate(candidate, comm_of(candidate).as_deref())
|
||||
}
|
||||
@@ -0,0 +1,717 @@
|
||||
//! Pure exit-gate coverage for the phase-3 observer core.
|
||||
//!
|
||||
//! Five of the six exit-gate rows live here (the sixth — a live create/destroy
|
||||
//! topology diff — needs the daemon and belongs to the adapter). Each test
|
||||
//! builds the [`RegEvent`] stream by hand; nothing links PipeWire.
|
||||
//!
|
||||
//! Carrying the phase-0a lesson: the id/pid/serial tests use **interior**
|
||||
//! values, not just 1 and a huge number, so a middle-of-range mistake cannot
|
||||
//! hide.
|
||||
|
||||
use super::classify::{Classification, DeviceClaim, classify};
|
||||
use super::pulse_pid;
|
||||
use super::*;
|
||||
use crate::host::taint::snapshot::{
|
||||
ClientSnapshot, GlobalId, IdLookup, MediaRole, NodeProps, PortDirection, PortSnapshot, Serial,
|
||||
};
|
||||
|
||||
// ---- builders -------------------------------------------------------------
|
||||
|
||||
fn ser(n: u64) -> Serial {
|
||||
Serial(n)
|
||||
}
|
||||
fn gid(n: u32) -> GlobalId {
|
||||
GlobalId(n)
|
||||
}
|
||||
fn model() -> RegistryModel {
|
||||
// now=0, a 5 s readiness budget.
|
||||
RegistryModel::new(0, 5000)
|
||||
}
|
||||
|
||||
fn no_device() -> DeviceClaim {
|
||||
DeviceClaim::default()
|
||||
}
|
||||
|
||||
fn hw_claim(device_id: u32, api: &str, factory: &str) -> DeviceClaim {
|
||||
DeviceClaim {
|
||||
device_id: Some(gid(device_id)),
|
||||
device_api: Some(api.to_string()),
|
||||
factory_name: Some(factory.to_string()),
|
||||
alsa_driver_name: Some("snd_hda_intel".to_string()),
|
||||
}
|
||||
}
|
||||
|
||||
/// A `Stream/Output/Audio` node with no backing Device — admitted at once.
|
||||
fn stream_out(serial: u64, id: u32) -> RegEvent {
|
||||
RegEvent::NodeAdded(NodeObservation {
|
||||
serial: ser(serial),
|
||||
id: gid(id),
|
||||
name: Some(format!("stream-{id}")),
|
||||
role: MediaRole::StreamOutput,
|
||||
props: NodeProps::default(),
|
||||
device_claim: no_device(),
|
||||
})
|
||||
}
|
||||
|
||||
/// A node backed by a Device (withheld until that Device resolves).
|
||||
fn device_node(serial: u64, id: u32, role: MediaRole, claim: DeviceClaim) -> RegEvent {
|
||||
RegEvent::NodeAdded(NodeObservation {
|
||||
serial: ser(serial),
|
||||
id: gid(id),
|
||||
name: Some(format!("dev-node-{id}")),
|
||||
role,
|
||||
props: NodeProps::default(),
|
||||
device_claim: claim,
|
||||
})
|
||||
}
|
||||
|
||||
fn client(serial: u64, id: u32, sec_pid: Option<u32>) -> RegEvent {
|
||||
RegEvent::ClientAdded(ClientSnapshot {
|
||||
serial: ser(serial),
|
||||
id: gid(id),
|
||||
sec_pid,
|
||||
})
|
||||
}
|
||||
|
||||
fn port(serial: u64, id: u32, node_id: u32, dir: PortDirection) -> RegEvent {
|
||||
RegEvent::PortAdded(PortSnapshot {
|
||||
serial: ser(serial),
|
||||
id: gid(id),
|
||||
node: gid(node_id),
|
||||
direction: dir,
|
||||
exclusive: false,
|
||||
monitor: false,
|
||||
})
|
||||
}
|
||||
|
||||
fn endpoints(out_node: u32, in_node: u32) -> LinkEndpoints {
|
||||
LinkEndpoints {
|
||||
output_node: gid(out_node),
|
||||
input_node: gid(in_node),
|
||||
output_port: None,
|
||||
input_port: None,
|
||||
}
|
||||
}
|
||||
|
||||
// ==========================================================================
|
||||
// classify() — session_device
|
||||
// ==========================================================================
|
||||
|
||||
#[test]
|
||||
fn classify_no_device_is_not_a_device() {
|
||||
assert_eq!(classify(&no_device(), false), Classification::NotADevice);
|
||||
// `device_resolved` is irrelevant with no device_id.
|
||||
assert_eq!(classify(&no_device(), true), Classification::NotADevice);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classify_unresolved_device_withholds() {
|
||||
let claim = hw_claim(42, "alsa", "api.alsa.pcm.sink");
|
||||
assert_eq!(
|
||||
classify(&claim, false),
|
||||
Classification::Withhold { device_id: gid(42) }
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classify_resolved_hardware_pcm_is_session_device() {
|
||||
// Only the measured ALSA factories are allowlisted (finding 5: the BlueZ
|
||||
// entries were invented and were removed).
|
||||
for factory in ["api.alsa.pcm.sink", "api.alsa.pcm.source"] {
|
||||
assert_eq!(
|
||||
classify(&hw_claim(7, "alsa", factory), true),
|
||||
Classification::SessionDevice,
|
||||
"factory {factory} should be a session device"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classify_invented_bluez_factories_are_not_session_devices() {
|
||||
// Finding 5: `api.bluez5.pcm.*` is not a real factory name; whatever it is,
|
||||
// it is not on the measured allowlist, so it fails closed to false
|
||||
// (over-exclusion, safe) rather than being trusted.
|
||||
for factory in ["api.bluez5.pcm.sink", "api.bluez5.pcm.source"] {
|
||||
let claim = DeviceClaim {
|
||||
device_id: Some(gid(7)),
|
||||
device_api: Some("bluez5".to_string()),
|
||||
factory_name: Some(factory.to_string()),
|
||||
alsa_driver_name: None,
|
||||
};
|
||||
assert_eq!(classify(&claim, true), Classification::NotSessionDevice);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classify_alsa_without_driver_name_fails_closed() {
|
||||
// Codex re-review: a missing `alsa.driver_name` must NOT grant
|
||||
// session_device — an snd_aloop node whose driver prop was not copied onto
|
||||
// the node would otherwise slip through. Absence fails closed.
|
||||
for factory in ["api.alsa.pcm.sink", "api.alsa.pcm.source"] {
|
||||
let claim = DeviceClaim {
|
||||
device_id: Some(gid(7)),
|
||||
device_api: Some("alsa".to_string()),
|
||||
factory_name: Some(factory.to_string()),
|
||||
alsa_driver_name: None,
|
||||
};
|
||||
assert_eq!(
|
||||
classify(&claim, true),
|
||||
Classification::NotSessionDevice,
|
||||
"absent driver on {factory} must fail closed"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classify_snd_aloop_is_not_a_session_device() {
|
||||
// Finding 2: an ALSA loopback presents with an allowlisted factory and
|
||||
// device.api=alsa exactly like a real card, but forwards audio through a
|
||||
// kernel hop the Link graph cannot see. It must NOT earn session_device.
|
||||
for factory in ["api.alsa.pcm.sink", "api.alsa.pcm.source"] {
|
||||
let claim = DeviceClaim {
|
||||
device_id: Some(gid(7)),
|
||||
device_api: Some("alsa".to_string()),
|
||||
factory_name: Some(factory.to_string()),
|
||||
alsa_driver_name: Some("snd_aloop".to_string()),
|
||||
};
|
||||
assert_eq!(
|
||||
classify(&claim, true),
|
||||
Classification::NotSessionDevice,
|
||||
"snd_aloop {factory} must fail closed"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classify_resolved_but_not_hardware_pcm_fails_closed() {
|
||||
// A null sink, a loopback, and an unknown factory are all forwarders, not
|
||||
// terminals: resolved, but session_device stays false.
|
||||
for factory in ["support.null-audio-sink", "api.alsa.pcm.loopback", "wat"] {
|
||||
assert_eq!(
|
||||
classify(&hw_claim(7, "alsa", factory), true),
|
||||
Classification::NotSessionDevice,
|
||||
"factory {factory} must not be a session device"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classify_missing_device_api_fails_closed() {
|
||||
// Even with an allowlisted factory, no device.api ⇒ not positively a
|
||||
// real-backend terminal.
|
||||
let claim = DeviceClaim {
|
||||
device_id: Some(gid(7)),
|
||||
device_api: None,
|
||||
factory_name: Some("api.alsa.pcm.sink".to_string()),
|
||||
alsa_driver_name: Some("snd_hda_intel".to_string()),
|
||||
};
|
||||
assert_eq!(classify(&claim, true), Classification::NotSessionDevice);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn classify_allowlist_is_exact_not_substring() {
|
||||
// A factory that merely *contains* an allowlisted name must not pass.
|
||||
let claim = hw_claim(7, "alsa", "api.alsa.pcm.sink.evil");
|
||||
assert_eq!(classify(&claim, true), Classification::NotSessionDevice);
|
||||
}
|
||||
|
||||
// ==========================================================================
|
||||
// pulse_pid — the six-case derivation matrix
|
||||
// ==========================================================================
|
||||
|
||||
fn clients_with(pids: &[Option<u32>]) -> Vec<ClientSnapshot> {
|
||||
pids.iter()
|
||||
.enumerate()
|
||||
.map(|(i, &sec_pid)| ClientSnapshot {
|
||||
serial: ser(1000 + i as u64),
|
||||
id: gid(200 + i as u32),
|
||||
sec_pid,
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_candidate_consistent_repeated_value() {
|
||||
// interior pid values, not 1 / u32::MAX.
|
||||
let cs = clients_with(&[Some(4137), Some(4137), Some(9001), Some(12034)]);
|
||||
assert_eq!(pulse_pid::candidate(&cs), Some(4137));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_candidate_inconsistent_two_repeats_is_none() {
|
||||
let cs = clients_with(&[Some(4137), Some(4137), Some(9001), Some(9001)]);
|
||||
assert_eq!(pulse_pid::candidate(&cs), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_candidate_missing_property_is_none() {
|
||||
let cs = clients_with(&[None, None, None]);
|
||||
assert_eq!(pulse_pid::candidate(&cs), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_candidate_single_occurrence_is_none() {
|
||||
// A lone native client carrying its own pid is indistinguishable from a
|
||||
// one-client pulse; the >=2 threshold rejects it.
|
||||
let cs = clients_with(&[Some(4137), Some(9001), Some(12034)]);
|
||||
assert_eq!(pulse_pid::candidate(&cs), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_validate_matches_pulse_comm() {
|
||||
assert_eq!(
|
||||
pulse_pid::validate(4137, Some("pipewire-pulse")),
|
||||
Some(4137)
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_validate_proc_missing_is_none() {
|
||||
// case 4: /proc entry gone.
|
||||
assert_eq!(pulse_pid::validate(4137, None), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_validate_comm_mismatch_is_none() {
|
||||
// case 5: a different process holds the number.
|
||||
assert_eq!(pulse_pid::validate(4137, Some("firefox")), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_validate_reuse_named_other_process_is_none() {
|
||||
// case 6: PID reuse — the number is live but /proc names someone else.
|
||||
assert_eq!(pulse_pid::validate(4137, Some("Xwayland")), None);
|
||||
// and a truncation-adjacent near-miss must not pass an exact match.
|
||||
assert_eq!(pulse_pid::validate(4137, Some("pipewire-pulseX")), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pid_derive_end_to_end_valid() {
|
||||
let cs = clients_with(&[Some(4137), Some(4137), Some(9001)]);
|
||||
let got = pulse_pid::derive(&cs, |pid| {
|
||||
(pid == 4137).then(|| "pipewire-pulse".to_string())
|
||||
});
|
||||
assert_eq!(got, Some(4137));
|
||||
}
|
||||
|
||||
// ==========================================================================
|
||||
// model — pulse pid through project()
|
||||
// ==========================================================================
|
||||
|
||||
/// Drive the model to Complete so `project` reflects a trusted graph, without
|
||||
/// caring about the specific objects.
|
||||
fn drive_ready(m: &mut RegistryModel) {
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_pulse_pid_valid_through_projection() {
|
||||
let mut m = model();
|
||||
m.apply(client(1, 200, Some(4137)));
|
||||
m.apply(client(2, 201, Some(4137)));
|
||||
m.apply(client(3, 202, Some(9001)));
|
||||
assert_eq!(m.pulse_pid_candidate(), Some(4137));
|
||||
m.apply(RegEvent::ProcCommProbed {
|
||||
pid: 4137,
|
||||
comm: Some("pipewire-pulse".to_string()),
|
||||
});
|
||||
assert_eq!(m.project().pipewire_pulse_pid, Some(4137));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_pulse_pid_none_until_probed() {
|
||||
let mut m = model();
|
||||
m.apply(client(1, 200, Some(4137)));
|
||||
m.apply(client(2, 201, Some(4137)));
|
||||
// candidate exists, but no /proc confirmation yet ⇒ fail closed.
|
||||
assert_eq!(m.project().pipewire_pulse_pid, None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_pulse_pid_none_on_comm_mismatch() {
|
||||
let mut m = model();
|
||||
m.apply(client(1, 200, Some(4137)));
|
||||
m.apply(client(2, 201, Some(4137)));
|
||||
m.apply(RegEvent::ProcCommProbed {
|
||||
pid: 4137,
|
||||
comm: Some("firefox".to_string()),
|
||||
});
|
||||
assert_eq!(m.project().pipewire_pulse_pid, None);
|
||||
}
|
||||
|
||||
// ==========================================================================
|
||||
// model — add / remove of all four object types
|
||||
// ==========================================================================
|
||||
|
||||
#[test]
|
||||
fn model_adds_all_four_object_types() {
|
||||
let mut m = model();
|
||||
m.apply(stream_out(100, 50));
|
||||
m.apply(port(101, 60, 50, PortDirection::Out));
|
||||
m.apply(client(102, 70, Some(4137)));
|
||||
m.apply(RegEvent::LinkAdded {
|
||||
serial: ser(103),
|
||||
id: gid(80),
|
||||
endpoints: Some(endpoints(50, 55)),
|
||||
});
|
||||
let snap = m.project().snapshot;
|
||||
assert_eq!(snap.nodes().count(), 1);
|
||||
assert_eq!(snap.ports().count(), 1);
|
||||
assert_eq!(snap.clients().count(), 1);
|
||||
assert_eq!(snap.links().count(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_removes_all_four_object_types() {
|
||||
let mut m = model();
|
||||
m.apply(stream_out(100, 50));
|
||||
m.apply(port(101, 60, 50, PortDirection::Out));
|
||||
m.apply(client(102, 70, Some(4137)));
|
||||
m.apply(RegEvent::LinkAdded {
|
||||
serial: ser(103),
|
||||
id: gid(80),
|
||||
endpoints: Some(endpoints(50, 55)),
|
||||
});
|
||||
|
||||
m.apply(RegEvent::Removed { id: gid(50) });
|
||||
m.apply(RegEvent::Removed { id: gid(60) });
|
||||
m.apply(RegEvent::Removed { id: gid(70) });
|
||||
m.apply(RegEvent::Removed { id: gid(80) });
|
||||
|
||||
let snap = m.project().snapshot;
|
||||
assert_eq!(snap.nodes().count(), 0);
|
||||
assert_eq!(snap.ports().count(), 0);
|
||||
assert_eq!(snap.clients().count(), 0);
|
||||
assert_eq!(snap.links().count(), 0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_remove_of_unknown_id_is_harmless() {
|
||||
let mut m = model();
|
||||
m.apply(stream_out(100, 50));
|
||||
m.apply(RegEvent::Removed { id: gid(999) });
|
||||
assert_eq!(m.project().snapshot.nodes().count(), 1);
|
||||
}
|
||||
|
||||
// ==========================================================================
|
||||
// model — recycled global id, oldest generation first (fail closed)
|
||||
// ==========================================================================
|
||||
|
||||
#[test]
|
||||
fn model_recycled_id_is_ambiguous_until_removal_accounted() {
|
||||
let mut m = model();
|
||||
// A missed removal: two live nodes claim id 50 (serials 100 then 200).
|
||||
m.apply(stream_out(100, 50));
|
||||
m.apply(stream_out(200, 50));
|
||||
|
||||
// The snapshot fails closed: id 50 is ambiguous.
|
||||
let snap = m.project().snapshot;
|
||||
assert_eq!(snap.node_by_id(gid(50)), Some(IdLookup::Ambiguous));
|
||||
assert_eq!(snap.nodes().count(), 2);
|
||||
|
||||
// One removal accounts for the OLDEST generation (serial 100); the newer
|
||||
// node survives and the id is unambiguous again.
|
||||
m.apply(RegEvent::Removed { id: gid(50) });
|
||||
let snap = m.project().snapshot;
|
||||
assert_eq!(snap.node_by_id(gid(50)), Some(IdLookup::Unique(ser(200))));
|
||||
assert!(snap.node(ser(200)).is_some());
|
||||
assert!(snap.node(ser(100)).is_none());
|
||||
}
|
||||
|
||||
// ==========================================================================
|
||||
// model — Link endpoint resolution (bind fallback path)
|
||||
// ==========================================================================
|
||||
|
||||
#[test]
|
||||
fn model_link_with_endpoints_appears_immediately() {
|
||||
let mut m = model();
|
||||
m.apply(RegEvent::LinkAdded {
|
||||
serial: ser(103),
|
||||
id: gid(80),
|
||||
endpoints: Some(endpoints(50, 55)),
|
||||
});
|
||||
assert_eq!(m.project().snapshot.links().count(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_link_without_endpoints_is_withheld_until_resolved() {
|
||||
let mut m = model();
|
||||
// The correctness path: the global carried no endpoint props.
|
||||
m.apply(RegEvent::LinkAdded {
|
||||
serial: ser(103),
|
||||
id: gid(80),
|
||||
endpoints: None,
|
||||
});
|
||||
// Not in the snapshot yet, and it blocks readiness.
|
||||
assert_eq!(m.project().snapshot.links().count(), 0);
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
assert!(!m.graph_ready(), "pending link must hold readiness");
|
||||
|
||||
// The bind fallback resolves it.
|
||||
m.apply(RegEvent::LinkEndpointsResolved {
|
||||
serial: ser(103),
|
||||
endpoints: endpoints(50, 55),
|
||||
});
|
||||
let snap = m.project().snapshot;
|
||||
assert_eq!(snap.links().count(), 1);
|
||||
let link = snap.links().next().unwrap();
|
||||
assert_eq!(link.output_node, gid(50));
|
||||
assert_eq!(link.input_node, gid(55));
|
||||
assert!(
|
||||
m.graph_ready(),
|
||||
"resolving the last obligation completes readiness"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_stale_link_resolution_is_ignored() {
|
||||
let mut m = model();
|
||||
m.apply(RegEvent::LinkAdded {
|
||||
serial: ser(103),
|
||||
id: gid(80),
|
||||
endpoints: None,
|
||||
});
|
||||
// Link removed before the bind returned.
|
||||
m.apply(RegEvent::Removed { id: gid(80) });
|
||||
// A late resolution for the gone link must not resurrect it.
|
||||
m.apply(RegEvent::LinkEndpointsResolved {
|
||||
serial: ser(103),
|
||||
endpoints: endpoints(50, 55),
|
||||
});
|
||||
assert_eq!(m.project().snapshot.links().count(), 0);
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
assert!(
|
||||
m.graph_ready(),
|
||||
"the obligation cleared when the link was removed"
|
||||
);
|
||||
}
|
||||
|
||||
// ==========================================================================
|
||||
// model — readiness epoch
|
||||
// ==========================================================================
|
||||
|
||||
#[test]
|
||||
fn model_readiness_waits_for_sync() {
|
||||
let mut m = model();
|
||||
m.apply(stream_out(100, 50));
|
||||
assert_eq!(m.readiness(), Readiness::Waiting);
|
||||
assert!(!m.project().graph_ready);
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
assert_eq!(m.readiness(), Readiness::Complete);
|
||||
assert!(m.project().graph_ready);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_readiness_does_not_release_with_obligation_outstanding() {
|
||||
let mut m = model();
|
||||
// A node withheld on an unresolved device is an outstanding obligation.
|
||||
m.apply(device_node(
|
||||
100,
|
||||
50,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "api.alsa.pcm.sink"),
|
||||
));
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
// Synced, but the withheld node keeps the epoch shut.
|
||||
assert_eq!(m.readiness(), Readiness::Waiting);
|
||||
assert!(!m.graph_ready());
|
||||
|
||||
// Resolving the device admits the node and completes readiness.
|
||||
m.apply(RegEvent::DeviceAdded { id: gid(42) });
|
||||
assert_eq!(m.readiness(), Readiness::Complete);
|
||||
assert!(m.graph_ready());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_readiness_times_out_fail_closed() {
|
||||
let mut m = model();
|
||||
m.apply(device_node(
|
||||
100,
|
||||
50,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "api.alsa.pcm.sink"),
|
||||
));
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
assert_eq!(m.readiness(), Readiness::Waiting);
|
||||
|
||||
// The device never resolves; the deadline passes.
|
||||
m.apply(RegEvent::Tick { now: 5000 });
|
||||
assert_eq!(m.readiness(), Readiness::TimedOut);
|
||||
assert!(!m.graph_ready(), "timeout fails closed");
|
||||
|
||||
// Finding 6: TimedOut must be sticky. Resolving the obligation, syncing
|
||||
// again, and ticking further must NOT flip it to Complete — a timed-out
|
||||
// observer stays fail-closed for its lifetime.
|
||||
m.apply(RegEvent::DeviceAdded { id: gid(42) });
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
m.apply(RegEvent::Tick { now: 6000 });
|
||||
assert_eq!(m.readiness(), Readiness::TimedOut, "timeout is sticky");
|
||||
assert!(!m.graph_ready());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_tick_before_deadline_does_not_time_out() {
|
||||
let mut m = model();
|
||||
m.apply(device_node(
|
||||
100,
|
||||
50,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "api.alsa.pcm.sink"),
|
||||
));
|
||||
m.apply(RegEvent::Tick { now: 4999 });
|
||||
assert_eq!(m.readiness(), Readiness::Waiting);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_complete_epoch_is_sticky_but_graph_ready_is_dynamic() {
|
||||
let mut m = model();
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
assert_eq!(m.readiness(), Readiness::Complete);
|
||||
assert!(m.graph_ready());
|
||||
// A node withheld AFTER completion does not revert the sticky EPOCH...
|
||||
m.apply(device_node(
|
||||
100,
|
||||
50,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "api.alsa.pcm.sink"),
|
||||
));
|
||||
assert_eq!(m.readiness(), Readiness::Complete, "epoch stays sticky");
|
||||
// ...but graph_ready DOES drop while the obligation is outstanding
|
||||
// (Codex finding 1: unresolved ancestry ⇒ fail closed, even post-epoch).
|
||||
assert!(
|
||||
!m.graph_ready(),
|
||||
"an outstanding obligation makes decisions unsafe"
|
||||
);
|
||||
// A late timeout Tick is inert once Complete.
|
||||
m.apply(RegEvent::Tick { now: 100_000 });
|
||||
assert_eq!(m.readiness(), Readiness::Complete);
|
||||
// Resolving the obligation restores graph_ready.
|
||||
m.apply(RegEvent::DeviceAdded { id: gid(42) });
|
||||
assert!(m.graph_ready());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_pending_link_drops_graph_ready_after_completion() {
|
||||
// Codex finding 1, the leak that mattered: a real Link added post-epoch
|
||||
// whose endpoints are still binding is an INVISIBLE edge (absent from the
|
||||
// snapshot, not dangling). graph_ready must go false until it resolves,
|
||||
// or a candidate can be reported eligible while tainted ancestry it cannot
|
||||
// see already carries call audio.
|
||||
let mut m = model();
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
assert!(m.graph_ready());
|
||||
|
||||
m.apply(RegEvent::LinkAdded {
|
||||
serial: ser(300),
|
||||
id: gid(90),
|
||||
endpoints: None,
|
||||
});
|
||||
assert!(!m.graph_ready(), "an unresolved link must gate decisions");
|
||||
// The snapshot genuinely omits it, which is exactly why graph_ready must
|
||||
// compensate.
|
||||
assert_eq!(m.project().snapshot.links().count(), 0);
|
||||
assert!(!m.project().graph_ready);
|
||||
|
||||
m.apply(RegEvent::LinkEndpointsResolved {
|
||||
serial: ser(300),
|
||||
endpoints: endpoints(50, 55),
|
||||
});
|
||||
assert!(m.graph_ready(), "resolved ⇒ decisions safe again");
|
||||
assert_eq!(m.project().snapshot.links().count(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_withheld_node_removed_clears_obligation() {
|
||||
let mut m = model();
|
||||
m.apply(device_node(
|
||||
100,
|
||||
50,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "api.alsa.pcm.sink"),
|
||||
));
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
assert_eq!(m.readiness(), Readiness::Waiting);
|
||||
// The withheld node disappears before its device ever showed up.
|
||||
m.apply(RegEvent::Removed { id: gid(50) });
|
||||
assert_eq!(m.readiness(), Readiness::Complete);
|
||||
}
|
||||
|
||||
// ==========================================================================
|
||||
// model — device withholding & session_device flag
|
||||
// ==========================================================================
|
||||
|
||||
#[test]
|
||||
fn model_device_first_admits_node_immediately() {
|
||||
let mut m = model();
|
||||
// Device enumerated before the node that references it.
|
||||
m.apply(RegEvent::DeviceAdded { id: gid(42) });
|
||||
m.apply(device_node(
|
||||
100,
|
||||
50,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "api.alsa.pcm.sink"),
|
||||
));
|
||||
let snap = m.project().snapshot;
|
||||
let node = snap.node(ser(100)).expect("node admitted immediately");
|
||||
assert!(
|
||||
node.props.session_device,
|
||||
"hardware sink is a session device"
|
||||
);
|
||||
// No obligation ⇒ a sync completes readiness.
|
||||
m.apply(RegEvent::ServerSynced);
|
||||
assert!(m.graph_ready());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_withheld_node_admitted_with_correct_session_device() {
|
||||
let mut m = model();
|
||||
// A real hardware sink and a card-associated filter share client/device
|
||||
// ancestry but classify differently once the device resolves.
|
||||
m.apply(device_node(
|
||||
100,
|
||||
50,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "api.alsa.pcm.sink"),
|
||||
));
|
||||
m.apply(device_node(
|
||||
200,
|
||||
51,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "support.null-audio-sink"),
|
||||
));
|
||||
// Both withheld until the device resolves.
|
||||
assert_eq!(m.project().snapshot.nodes().count(), 0);
|
||||
m.apply(RegEvent::DeviceAdded { id: gid(42) });
|
||||
|
||||
let snap = m.project().snapshot;
|
||||
assert_eq!(
|
||||
snap.nodes().count(),
|
||||
2,
|
||||
"both admitted once the device resolved"
|
||||
);
|
||||
assert!(
|
||||
snap.node(ser(100)).unwrap().props.session_device,
|
||||
"the real hardware sink is a session device"
|
||||
);
|
||||
assert!(
|
||||
!snap.node(ser(200)).unwrap().props.session_device,
|
||||
"the null sink sharing the same device is not"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn model_withheld_filter_admitted_as_not_session_device() {
|
||||
let mut m = model();
|
||||
m.apply(device_node(
|
||||
200,
|
||||
51,
|
||||
MediaRole::Sink,
|
||||
hw_claim(42, "alsa", "support.null-audio-sink"),
|
||||
));
|
||||
m.apply(RegEvent::DeviceAdded { id: gid(42) });
|
||||
let snap = m.project().snapshot;
|
||||
assert!(
|
||||
!snap.node(ser(200)).unwrap().props.session_device,
|
||||
"a null sink on a card is not a session device"
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,338 @@
|
||||
//! Synthetic graph builders for the taint-engine tests.
|
||||
//!
|
||||
//! Serials are handed out monotonically and never reused, exactly as
|
||||
//! PipeWire does; global ids are handed out separately and **may be reused
|
||||
//! on purpose**, which is what the recycling tests need.
|
||||
|
||||
use std::collections::BTreeMap;
|
||||
|
||||
use super::snapshot::{
|
||||
ClientSnapshot, GlobalId, GraphSnapshot, LinkSnapshot, MediaRole, NodeProps, NodeSnapshot,
|
||||
PortDirection, PortSnapshot, Serial,
|
||||
};
|
||||
|
||||
/// pipewire-pulse's PID, as measured on the target machine.
|
||||
pub const PULSE_PID: u32 = 2541;
|
||||
/// WirePlumber's PID — one process owning every device node on the box.
|
||||
pub const SESSION_PID: u32 = 900;
|
||||
|
||||
/// A node's identity in a fixture: what tests pass around.
|
||||
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
|
||||
pub struct NodeRef {
|
||||
pub serial: Serial,
|
||||
pub id: GlobalId,
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
pub struct Graph {
|
||||
next_serial: u64,
|
||||
next_id: u32,
|
||||
nodes: Vec<NodeSnapshot>,
|
||||
ports: Vec<PortSnapshot>,
|
||||
links: Vec<LinkSnapshot>,
|
||||
clients: Vec<ClientSnapshot>,
|
||||
/// One client connection per process / per module, which is what the
|
||||
/// live graph looks like. Tests that need the *split*-client shape
|
||||
/// (GStreamer opens one per stream) pass clients explicitly instead.
|
||||
client_by_app: BTreeMap<u32, GlobalId>,
|
||||
client_by_module: BTreeMap<u64, GlobalId>,
|
||||
session_client: Option<GlobalId>,
|
||||
}
|
||||
|
||||
impl Graph {
|
||||
pub fn new() -> Self {
|
||||
Self {
|
||||
// Start past u32::MAX so every fixture also exercises the phase
|
||||
// 0a widening: a serial that a u32 model would have truncated.
|
||||
next_serial: u64::from(u32::MAX) + 1,
|
||||
next_id: 1,
|
||||
..Self::default()
|
||||
}
|
||||
}
|
||||
|
||||
fn serial(&mut self) -> Serial {
|
||||
self.next_serial += 1;
|
||||
Serial(self.next_serial)
|
||||
}
|
||||
|
||||
fn id(&mut self) -> GlobalId {
|
||||
self.next_id += 1;
|
||||
GlobalId(self.next_id)
|
||||
}
|
||||
|
||||
/// A client object. `sec_pid` is `pipewire.sec.pid` — pipewire-pulse's
|
||||
/// PID for Pulse-emulated clients.
|
||||
pub fn client(&mut self, sec_pid: Option<u32>) -> GlobalId {
|
||||
let serial = self.serial();
|
||||
let id = self.id();
|
||||
self.clients.push(ClientSnapshot {
|
||||
serial,
|
||||
id,
|
||||
sec_pid,
|
||||
});
|
||||
id
|
||||
}
|
||||
|
||||
/// The client connection an ordinary process holds — one per PID,
|
||||
/// created on demand.
|
||||
pub fn client_of_app(&mut self, pid: u32) -> GlobalId {
|
||||
if let Some(id) = self.client_by_app.get(&pid) {
|
||||
return *id;
|
||||
}
|
||||
let id = self.client(Some(PULSE_PID));
|
||||
self.client_by_app.insert(pid, id);
|
||||
id
|
||||
}
|
||||
|
||||
/// An ordinary application stream: its own client, its own PID.
|
||||
pub fn app_node(&mut self, name: &str, role: MediaRole, pid: u32) -> NodeRef {
|
||||
let client = self.client_of_app(pid);
|
||||
self.node(name, role, app(client, pid))
|
||||
}
|
||||
|
||||
/// The client a pactl module holds. Measured: each module gets its own
|
||||
/// (`sink-sunshine-*` were clients 83/86/92), which is why one tainted
|
||||
/// module does not fuse with the next.
|
||||
pub fn client_of_module(&mut self, module: u64) -> GlobalId {
|
||||
match self.client_by_module.get(&module) {
|
||||
Some(id) => *id,
|
||||
None => {
|
||||
let id = self.client(Some(PULSE_PID));
|
||||
self.client_by_module.insert(module, id);
|
||||
id
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A leg of a pactl-loaded module: one client per module, and the
|
||||
/// node's `application.process.id` is **pipewire-pulse's own**, because
|
||||
/// pipewire-pulse genuinely is the client.
|
||||
pub fn module_node(&mut self, name: &str, role: MediaRole, module: u64) -> NodeRef {
|
||||
let client = self.client_of_module(module);
|
||||
self.node(name, role, pulse_module(client, module, PULSE_PID))
|
||||
}
|
||||
|
||||
/// A leg joined to its siblings by `node.link-group` — loopback,
|
||||
/// filter-chain, echo-cancel.
|
||||
pub fn group_node(&mut self, name: &str, role: MediaRole, group: &str, pid: u32) -> NodeRef {
|
||||
let client = self.client_of_app(pid);
|
||||
self.node(name, role, link_group(group, client, pid))
|
||||
}
|
||||
|
||||
/// A device node as the session manager creates it: no strong key,
|
||||
/// WirePlumber's client and PID — shared with every other device — and
|
||||
/// a `device.id`, which is what marks it as session-manager-exported.
|
||||
pub fn device_node(&mut self, name: &str, role: MediaRole) -> NodeRef {
|
||||
let session = match self.session_client {
|
||||
Some(id) => id,
|
||||
None => {
|
||||
let id = self.client(None);
|
||||
self.session_client = Some(id);
|
||||
id
|
||||
}
|
||||
};
|
||||
self.node(name, role, device(session, SESSION_PID))
|
||||
}
|
||||
|
||||
/// A node that *belongs to* a Device but is not a passive device node —
|
||||
/// a filter associated with a card. Phase 3 must not classify this as a
|
||||
/// session device, or it loses both its coarse owner keys and its
|
||||
/// ability to trip the fail-closed backstop.
|
||||
pub fn device_associated_filter(&mut self, name: &str, role: MediaRole, pid: u32) -> NodeRef {
|
||||
let client = self.client_of_app(pid);
|
||||
self.node(name, role, app(client, pid))
|
||||
}
|
||||
|
||||
/// A **virtual** sink an application created natively: an `Audio/Sink`
|
||||
/// with no `device.id` and no strong key, sharing one client with the
|
||||
/// stream that re-emits what it receives. Coarse keys must still bridge
|
||||
/// these two, or the whole call leaks through the re-emitting leg.
|
||||
pub fn native_virtual_node(&mut self, name: &str, role: MediaRole, pid: u32) -> NodeRef {
|
||||
let client = self.client_of_app(pid);
|
||||
self.node(name, role, app(client, pid))
|
||||
}
|
||||
|
||||
pub fn peerspeak_node(&mut self, name: &str, pid: u32) -> NodeRef {
|
||||
let client = self.client_of_app(pid);
|
||||
self.node(name, MediaRole::StreamOutput, peerspeak_owned(client, pid))
|
||||
}
|
||||
|
||||
pub fn node(&mut self, name: &str, role: MediaRole, props: NodeProps) -> NodeRef {
|
||||
let id = self.id();
|
||||
self.node_with_id(name, role, id, props)
|
||||
}
|
||||
|
||||
/// Force a global id — for reproducing id recycling after teardown.
|
||||
pub fn node_with_id(
|
||||
&mut self,
|
||||
name: &str,
|
||||
role: MediaRole,
|
||||
id: GlobalId,
|
||||
props: NodeProps,
|
||||
) -> NodeRef {
|
||||
let serial = self.serial();
|
||||
self.nodes.push(NodeSnapshot {
|
||||
serial,
|
||||
id,
|
||||
name: Some(name.to_string()),
|
||||
role,
|
||||
props,
|
||||
});
|
||||
NodeRef { serial, id }
|
||||
}
|
||||
|
||||
pub fn port(&mut self, node: NodeRef, direction: PortDirection, exclusive: bool) {
|
||||
let serial = self.serial();
|
||||
let id = self.id();
|
||||
self.ports.push(PortSnapshot {
|
||||
serial,
|
||||
id,
|
||||
node: node.id,
|
||||
direction,
|
||||
exclusive,
|
||||
monitor: false,
|
||||
});
|
||||
}
|
||||
|
||||
/// A signal edge: audio flows `from → to`.
|
||||
pub fn link(&mut self, from: NodeRef, to: NodeRef) {
|
||||
self.link_ids(from.id, to.id);
|
||||
}
|
||||
|
||||
/// A link naming raw ids, so a test can dangle an endpoint.
|
||||
pub fn link_ids(&mut self, from: GlobalId, to: GlobalId) {
|
||||
let serial = self.serial();
|
||||
let id = self.id();
|
||||
self.links.push(LinkSnapshot {
|
||||
serial,
|
||||
id,
|
||||
output_node: from,
|
||||
input_node: to,
|
||||
output_port: None,
|
||||
input_port: None,
|
||||
});
|
||||
}
|
||||
|
||||
/// An id that belongs to nothing — for unresolved-endpoint tests.
|
||||
pub fn dangling_id(&mut self) -> GlobalId {
|
||||
self.id()
|
||||
}
|
||||
|
||||
pub fn build(&self) -> GraphSnapshot {
|
||||
self.build_without(&[])
|
||||
}
|
||||
|
||||
/// A later snapshot in which some nodes have gone away, along with
|
||||
/// their ports and every link touching them. Surviving objects keep
|
||||
/// their serials, which is what makes sticky-taint sequences testable.
|
||||
pub fn build_without(&self, dropped: &[NodeRef]) -> GraphSnapshot {
|
||||
let gone_serials: Vec<Serial> = dropped.iter().map(|n| n.serial).collect();
|
||||
let nodes: Vec<NodeSnapshot> = self
|
||||
.nodes
|
||||
.iter()
|
||||
.filter(|n| !gone_serials.contains(&n.serial))
|
||||
.cloned()
|
||||
.collect();
|
||||
// Filter by what was *dropped*, not by what is live: a link to an id
|
||||
// that never had a node is a dangling endpoint, and dropping those
|
||||
// here would quietly disarm every unresolved-ancestry test.
|
||||
let gone_ids: Vec<GlobalId> = dropped.iter().map(|n| n.id).collect();
|
||||
GraphSnapshot::new(
|
||||
nodes,
|
||||
self.ports
|
||||
.iter()
|
||||
.filter(|p| !gone_ids.contains(&p.node))
|
||||
.cloned()
|
||||
.collect(),
|
||||
self.links
|
||||
.iter()
|
||||
.filter(|l| !gone_ids.contains(&l.output_node) && !gone_ids.contains(&l.input_node))
|
||||
.cloned()
|
||||
.collect(),
|
||||
self.clients.clone(),
|
||||
)
|
||||
}
|
||||
|
||||
/// Drop clients too — full owner teardown.
|
||||
///
|
||||
/// Invalidates the per-app/per-module caches as well: leaving them
|
||||
/// stale made a later `client_of_app` hand back the *removed* client's
|
||||
/// id, so a test that meant "a brand-new client after teardown" was
|
||||
/// really building a node pointing at a client object that no longer
|
||||
/// existed (Codex round 1, finding 8).
|
||||
pub fn drop_clients(&mut self, ids: &[GlobalId]) {
|
||||
self.clients.retain(|c| !ids.contains(&c.id));
|
||||
self.client_by_app.retain(|_, id| !ids.contains(id));
|
||||
self.client_by_module.retain(|_, id| !ids.contains(id));
|
||||
if self.session_client.is_some_and(|id| ids.contains(&id)) {
|
||||
self.session_client = None;
|
||||
}
|
||||
}
|
||||
|
||||
/// A client that reuses a global id a dead client had — the recycling
|
||||
/// case, with a fresh serial.
|
||||
pub fn client_with_id(&mut self, id: GlobalId, sec_pid: Option<u32>) -> GlobalId {
|
||||
let serial = self.serial();
|
||||
self.clients.push(ClientSnapshot {
|
||||
serial,
|
||||
id,
|
||||
sec_pid,
|
||||
});
|
||||
id
|
||||
}
|
||||
}
|
||||
|
||||
/// An ordinary application stream: real PID, one client connection.
|
||||
pub fn app(client: GlobalId, pid: u32) -> NodeProps {
|
||||
NodeProps {
|
||||
client_id: Some(client),
|
||||
process_id: Some(pid),
|
||||
..NodeProps::default()
|
||||
}
|
||||
}
|
||||
|
||||
/// A pactl-module-created stream: the daemon is the client, so the node's
|
||||
/// `application.process.id` is pipewire-pulse's own.
|
||||
pub fn pulse_module(client: GlobalId, module: u64, pulse_pid: u32) -> NodeProps {
|
||||
NodeProps {
|
||||
pulse_module_id: Some(module),
|
||||
client_id: Some(client),
|
||||
process_id: Some(pulse_pid),
|
||||
..NodeProps::default()
|
||||
}
|
||||
}
|
||||
|
||||
/// A PipeWire-module leg joined to its siblings by `node.link-group`
|
||||
/// (loopback, filter-chain, echo-cancel).
|
||||
pub fn link_group(group: &str, client: GlobalId, pid: u32) -> NodeProps {
|
||||
NodeProps {
|
||||
link_group: Some(group.to_string()),
|
||||
client_id: Some(client),
|
||||
process_id: Some(pid),
|
||||
..NodeProps::default()
|
||||
}
|
||||
}
|
||||
|
||||
/// A device node as the session manager creates it: no strong key, and the
|
||||
/// session manager's own client and PID — shared with every other device.
|
||||
///
|
||||
/// Measured 2026-07-21: real ALSA device nodes carry the shared
|
||||
/// `client.id` but **no** `application.process.id` at all. Giving them one
|
||||
/// here is deliberately *more* pessimistic than reality — it hands the
|
||||
/// engine a second coarse key it could fuse devices on, so a test that
|
||||
/// passes here also passes against the real props.
|
||||
pub fn device(session_client: GlobalId, session_pid: u32) -> NodeProps {
|
||||
NodeProps {
|
||||
client_id: Some(session_client),
|
||||
process_id: Some(session_pid),
|
||||
session_device: true,
|
||||
..NodeProps::default()
|
||||
}
|
||||
}
|
||||
|
||||
pub fn peerspeak_owned(client: GlobalId, pid: u32) -> NodeProps {
|
||||
NodeProps {
|
||||
peerspeak_owned: true,
|
||||
..app(client, pid)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,956 @@
|
||||
//! The taint engine — decides which `Stream/Output/Audio` nodes may be
|
||||
//! fanned out into the screen-share capture without echoing peerspeak's own
|
||||
//! audio back at the viewer.
|
||||
//!
|
||||
//! Implements design v3.4 §6.1–§6.1.3 (`peerspeak/docs/
|
||||
//! screenshare-audio-exclusion-plan.md`), phase 2 of the implementation
|
||||
//! plan. **Pure**: no PipeWire types appear in any signature, nothing here
|
||||
//! touches the daemon, and every test builds its own graph.
|
||||
//!
|
||||
//! ## The one-sentence predicate
|
||||
//!
|
||||
//! > A node is eligible only if **no** signal path reaches it from a
|
||||
//! > peerspeak-owned node, the live AEC identity, or any pixelpass-owned
|
||||
//! > object. **Unresolvable ancestry is not eligible.**
|
||||
//!
|
||||
//! That last sentence is the invariant the whole design rests on: every
|
||||
//! other failure mode in here degrades into over-exclusion (one app's audio
|
||||
//! silently missing from the share) rather than into echo.
|
||||
//!
|
||||
//! ## Why a graph walk and not a property check
|
||||
//!
|
||||
//! Exclusion does not propagate downstream by itself. Any node that
|
||||
//! re-emits audio it received is a fresh, *untagged* `Stream/Output/Audio`
|
||||
//! carrying the mix — including the one peerspeak playback stream that was
|
||||
//! correctly excluded one hop earlier. EasyEffects, `module-loopback`,
|
||||
//! combine-sinks, tunnel/RTP sinks and virtual-sink forwarders all have this
|
||||
//! shape, and at least one such topology has been observed live on the
|
||||
//! target machine.
|
||||
//!
|
||||
//! Taint therefore flows over **three** edge types:
|
||||
//!
|
||||
//! 1. **Link edges** — `link.output.node → link.input.node`.
|
||||
//! 2. **Sink → monitor** — free at node granularity: the monitor connection
|
||||
//! *is* a real Link whose output node is the sink node itself (measured).
|
||||
//! A port-granular walk would need a synthetic edge; a node-granular one
|
||||
//! does not.
|
||||
//! 3. **Owner bridges** — the intra-process hop the graph cannot see. See
|
||||
//! [`owner`]; this is the hard one.
|
||||
//!
|
||||
//! ## Stickiness
|
||||
//!
|
||||
//! Taint is **sticky per owner** for the duration of the share, because a
|
||||
//! topological recompute forgets *buffered* audio: an app can read a tainted
|
||||
//! monitor into a 5-second ring buffer, then have its input leg vanish, and
|
||||
//! a purely topological engine would relink its output while it is still
|
||||
//! emitting peerspeak's audio out of that buffer. No graph event marks the
|
||||
//! moment a buffer drains.
|
||||
//!
|
||||
//! Stickiness is keyed on [`Serial`] — never on a node id, `client.id`,
|
||||
//! module index or `link-group` string, **all of which recycle on this
|
||||
//! stack**. An entry is cleared only once every member object has
|
||||
//! disappeared; a key that reappears after full teardown is a new owner and
|
||||
//! starts clean.
|
||||
//!
|
||||
//! ## ⚠️ KNOWN OPEN GAP — buffered audio across a full PipeWire teardown of
|
||||
//! ## a still-live process (Codex phase-2 rounds 5–6) — DESIGN DECISION OWED
|
||||
//!
|
||||
//! **This is an in-threat-model echo gap, not an outside-the-model one — an
|
||||
//! earlier version of this note wrongly scoped it to keyless streams.**
|
||||
//!
|
||||
//! The scenario, entirely with a real PID-bearing app (a recorder, a DAW,
|
||||
//! a GStreamer pipeline): it reads the call into an application buffer,
|
||||
//! **fully** tears down its PipeWire Node *and* Client while keeping that
|
||||
//! buffer, then — still the same live process — opens a fresh Client and a
|
||||
//! `Stream/Output/Audio` and replays. Every old serial is gone, so
|
||||
//! [`seed_sticky`] refuses to apply the remembered PID fingerprint (the
|
||||
//! fingerprint is lifetime-scoped to a live serial member, because bare keys
|
||||
//! recycle); no reader is live in the new epoch, so the backstop does not
|
||||
//! fire; the replayed leg is eligible.
|
||||
//!
|
||||
//! It is real and reachable by non-adversarial software. It also sits
|
||||
//! exactly on the design's stated boundary (v3.4 §6.1.3: "a key that
|
||||
//! reappears after full teardown is a new owner and starts clean"), so
|
||||
//! closing it is a **design change**, not a local bug fix:
|
||||
//!
|
||||
//! - **Option A — accept as a documented v1 limitation.** Contrived in
|
||||
//! practice (most apps hold their PipeWire connection open for their
|
||||
//! lifetime; the round-2 fix already covers the common
|
||||
//! idle-a-client-and-open-another case), never a *silent* correctness
|
||||
//! regression since it is written down, and phase 5's dry run would show
|
||||
//! it. But it is a known echo path, which sits badly against the feature's
|
||||
//! fail-closed ethos.
|
||||
//! - **Option B — process-generation lifetime.** Key the fingerprint's
|
||||
//! lifetime on the owning **process** being alive — PID + `/proc` start
|
||||
//! time (or a pidfd) to defeat PID reuse — instead of on a live PipeWire
|
||||
//! object. Phase 3 supplies process liveness; §6.1.3's node/client-only
|
||||
//! lifetime definition is revised. Closes the PID-bearing case; the truly
|
||||
//! keyless sub-case (no PID at all) genuinely *is* outside the threat
|
||||
//! model and stays a documented limit.
|
||||
//!
|
||||
//! The choice is the designer's (it revises the security surface). Until it
|
||||
//! is made, `a_fingerprint_does_not_outlive_its_owner` encodes Option A's
|
||||
//! behaviour — flip it if B is chosen. Owed to the design doc as round 8.
|
||||
|
||||
// Phase 2 lands the engine behind its own test surface and nothing else:
|
||||
// the registry observer that will feed it is phase 3, so in a non-test
|
||||
// build every item here is legitimately unreachable for now.
|
||||
#![allow(dead_code)]
|
||||
|
||||
pub mod owner;
|
||||
pub mod snapshot;
|
||||
|
||||
#[cfg(test)]
|
||||
mod fixture;
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
||||
use std::collections::{BTreeMap, BTreeSet, VecDeque};
|
||||
|
||||
use owner::{OwnerComponents, OwnerKey};
|
||||
use snapshot::{GraphSnapshot, IdLookup, MediaRole, NodeSnapshot, Serial};
|
||||
|
||||
/// The `node.name` prefix of a pixelpass capture sink. Any host's sink
|
||||
/// counts, not just ours — fanning out a stream that is downstream of
|
||||
/// *another* pixelpass host's capture sink builds a cycle (v3.4 §6.2).
|
||||
pub const CAPTURE_SINK_PREFIX: &str = "pixelpass_capture_";
|
||||
|
||||
/// `node.link-group` prefix that marks *some* echo canceller. Hazard
|
||||
/// detection only — it does **not** identify peerspeak's instance, which is
|
||||
/// what `pulse.module.id` is for (v3.4 §5.2 correction 4).
|
||||
pub const ECHO_CANCEL_GROUP_PREFIX: &str = "echo-cancel-";
|
||||
|
||||
/// Why a node is tainted or excluded. Stable machine-readable codes: this
|
||||
/// value is the phase 5 audit output, the phase 6 status event, and the
|
||||
/// eventual answer to "why isn't this app being shared?".
|
||||
#[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
|
||||
pub enum Reason {
|
||||
/// Carries the `peerspeak.owned` tag (v3.4 §5.1).
|
||||
PeerspeakOwned,
|
||||
/// `pulse.module.id` equals the live AEC module index — exact equality
|
||||
/// only. "Has any `pulse.module.id`" is explicitly rejected as a rule:
|
||||
/// tunnel/RTP/loopback modules may be the only carrier of audio the
|
||||
/// user legitimately wants shared (v3.4 §5.2 correction 2).
|
||||
AecIdentity,
|
||||
/// A pixelpass-owned object, ours or another host's capture sink.
|
||||
PixelpassOwned,
|
||||
/// An `echo-cancel-*` group that is **not** our validated identity.
|
||||
/// Decision D3: warn and exclude rather than fan out.
|
||||
ForeignEchoCancel,
|
||||
/// Reached by a signal path from a tainted node (link or monitor edge).
|
||||
TaintedUpstream,
|
||||
/// Reached across an owner bridge; the key that did it, when the
|
||||
/// tainted member shares one directly rather than transitively.
|
||||
TaintedOwnerBridge { key: Option<OwnerKey> },
|
||||
/// A link endpoint, or a node's own id, could not be resolved in this
|
||||
/// snapshot. Fail closed (v3.4 §6.1.4).
|
||||
UnresolvedAncestry,
|
||||
/// A tainted capture stream whose owner cannot be bounded by any usable
|
||||
/// key, so its sibling output legs cannot be identified. Fail closed
|
||||
/// (v3.4 §6.1.1, final paragraph).
|
||||
UnresolvedOwner,
|
||||
/// The observer has not reached a complete, coherent view of the graph
|
||||
/// yet. No decision made from a partial graph is a decision.
|
||||
GraphNotReady,
|
||||
/// A `port.exclusive` port — fan-out will be refused (v3.4 §6.2). Local
|
||||
/// to the node; does not propagate.
|
||||
PortExclusive,
|
||||
/// An encoded/passthrough stream — a second link would corrupt it.
|
||||
/// Local to the node; does not propagate.
|
||||
Passthrough,
|
||||
}
|
||||
|
||||
impl Reason {
|
||||
pub fn code(self) -> &'static str {
|
||||
match self {
|
||||
Self::PeerspeakOwned => "peerspeak-owned",
|
||||
Self::AecIdentity => "aec-identity",
|
||||
Self::PixelpassOwned => "pixelpass-owned",
|
||||
Self::ForeignEchoCancel => "foreign-echo-cancel",
|
||||
Self::TaintedUpstream => "tainted-upstream",
|
||||
Self::TaintedOwnerBridge { .. } => "tainted-owner-bridge",
|
||||
Self::UnresolvedAncestry => "unresolved-ancestry",
|
||||
Self::UnresolvedOwner => "unresolved-owner",
|
||||
Self::GraphNotReady => "graph-not-ready",
|
||||
Self::PortExclusive => "port-exclusive",
|
||||
Self::Passthrough => "passthrough",
|
||||
}
|
||||
}
|
||||
|
||||
/// Lower wins. A node can acquire taint several ways in one recompute
|
||||
/// and the reported reason must not depend on traversal order, or the
|
||||
/// audit output is unstable and the fixture tests are flaky. Explicit
|
||||
/// priority, not BFS arrival order.
|
||||
fn priority(self) -> u8 {
|
||||
match self {
|
||||
Self::PeerspeakOwned => 0,
|
||||
Self::AecIdentity => 1,
|
||||
Self::PixelpassOwned => 2,
|
||||
Self::ForeignEchoCancel => 3,
|
||||
Self::TaintedUpstream => 4,
|
||||
Self::TaintedOwnerBridge { .. } => 5,
|
||||
Self::UnresolvedAncestry => 6,
|
||||
Self::UnresolvedOwner => 7,
|
||||
// Non-propagating; never competes with the taint reasons above
|
||||
// because it is only consulted for untainted candidates.
|
||||
Self::GraphNotReady => 8,
|
||||
Self::PortExclusive => 9,
|
||||
Self::Passthrough => 10,
|
||||
}
|
||||
}
|
||||
|
||||
/// Does this reason spread to downstream nodes and owner siblings?
|
||||
fn propagates(self) -> bool {
|
||||
self.priority() <= Self::UnresolvedOwner.priority()
|
||||
}
|
||||
}
|
||||
|
||||
/// Everything the engine needs that is not in the graph itself.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq)]
|
||||
pub struct ExclusionCtx {
|
||||
/// The **validated** live AEC module index, or `None` for `--aec=off`.
|
||||
/// The validation state machine (phase 4) owns the transitions; if it
|
||||
/// is still `Validating` or has `Failed`, its caller must not fan out at
|
||||
/// all rather than passing `None` here, which would merely mean "there
|
||||
/// is no AEC".
|
||||
pub aec_module_id: Option<u64>,
|
||||
/// pipewire-pulse's own PID, derived by the observer (phase 3) from a
|
||||
/// consistent `pipewire.sec.pid` across Pulse clients validated against
|
||||
/// `/proc/<pid>/comm`. `None` is safe but coarse — see [`owner`].
|
||||
pub pipewire_pulse_pid: Option<u32>,
|
||||
/// Serials of objects pixelpass itself created this run.
|
||||
pub pixelpass_owned: BTreeSet<Serial>,
|
||||
/// False until the readiness epoch has been reached (phase 3). Every
|
||||
/// candidate is then ineligible: a decision from a partial graph is not
|
||||
/// a decision.
|
||||
pub graph_ready: bool,
|
||||
}
|
||||
|
||||
/// Object identity for sticky bookkeeping. Always a [`Serial`] — never a
|
||||
/// recyclable id (v3.4 §6.1.3).
|
||||
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
|
||||
pub enum ObjectRef {
|
||||
Node(Serial),
|
||||
Client(Serial),
|
||||
}
|
||||
|
||||
/// One owner that has been tainted, and every object observed to constitute
|
||||
/// it. Cleared only when **all** of them are gone.
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct StickyOwner {
|
||||
/// Every object seen to be part of this owner, ever. Membership
|
||||
/// accumulates: that is what makes "clear only once all member objects
|
||||
/// have disappeared" true across churn.
|
||||
pub members: BTreeSet<ObjectRef>,
|
||||
/// Owner keys remembered across connections — strong keys and a usable
|
||||
/// process id, never `client.id`. Applied only while some serial member
|
||||
/// above is still live, which is what keeps a recyclable key from
|
||||
/// resurrecting a dead owner.
|
||||
///
|
||||
/// Needed because a live Client is not the same thing as a live owner:
|
||||
/// a process can leave one connection idle and open a second, and
|
||||
/// GStreamer opens one connection per stream as a matter of course, so
|
||||
/// following connections alone lets the next leg escape (Codex round 2,
|
||||
/// finding 2).
|
||||
pub fingerprints: BTreeSet<owner::Fingerprint>,
|
||||
/// The reason recorded for each node that was tainted in its own right.
|
||||
/// Kept per node rather than collapsed to one owner-wide reason, or a
|
||||
/// forwarder's output leg inherits its *input* leg's `tainted-upstream`
|
||||
/// and the audit output stops naming the mechanism that actually
|
||||
/// excluded it.
|
||||
pub node_reasons: BTreeMap<Serial, Reason>,
|
||||
}
|
||||
|
||||
impl StickyOwner {
|
||||
/// The reason to apply to a member: its own recorded one, or — for a
|
||||
/// leg that appeared later — the fact that it belongs to a tainted
|
||||
/// owner, which is a bridge by definition.
|
||||
fn reason_for(&self, serial: Serial) -> Reason {
|
||||
self.node_reasons
|
||||
.get(&serial)
|
||||
.copied()
|
||||
.unwrap_or(Reason::TaintedOwnerBridge { key: None })
|
||||
}
|
||||
}
|
||||
|
||||
/// Threaded explicitly through [`evaluate`] so stickiness is testable as a
|
||||
/// sequence of snapshots rather than as hidden mutable state.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq)]
|
||||
pub struct StickyState {
|
||||
pub owners: Vec<StickyOwner>,
|
||||
}
|
||||
|
||||
impl StickyState {
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.owners.is_empty()
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
|
||||
pub enum Eligibility {
|
||||
Eligible,
|
||||
NotEligible {
|
||||
reason: Reason,
|
||||
/// The taint was carried over from a previous snapshot rather than
|
||||
/// derived from the current topology.
|
||||
sticky: bool,
|
||||
},
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct NodeDecision {
|
||||
pub serial: Serial,
|
||||
pub name: Option<String>,
|
||||
pub eligibility: Eligibility,
|
||||
}
|
||||
|
||||
impl NodeDecision {
|
||||
pub fn is_eligible(&self) -> bool {
|
||||
matches!(self.eligibility, Eligibility::Eligible)
|
||||
}
|
||||
|
||||
pub fn reason(&self) -> Option<Reason> {
|
||||
match self.eligibility {
|
||||
Eligibility::Eligible => None,
|
||||
Eligibility::NotEligible { reason, .. } => Some(reason),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
|
||||
pub struct TaintEntry {
|
||||
pub reason: Reason,
|
||||
pub sticky: bool,
|
||||
}
|
||||
|
||||
/// The result of one recompute.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq)]
|
||||
pub struct Decisions {
|
||||
/// Every `Stream/Output/Audio` node in the snapshot — the complete
|
||||
/// candidate universe, so callers can assert an exact partition rather
|
||||
/// than spot-checking named nodes.
|
||||
pub candidates: BTreeMap<Serial, NodeDecision>,
|
||||
/// Taint over *all* node roles, for diagnostics and for the phase 5
|
||||
/// audit output.
|
||||
pub taint: BTreeMap<Serial, TaintEntry>,
|
||||
}
|
||||
|
||||
impl Decisions {
|
||||
/// Serials of eligible candidates, ascending.
|
||||
pub fn eligible(&self) -> Vec<Serial> {
|
||||
self.candidates
|
||||
.values()
|
||||
.filter(|d| d.is_eligible())
|
||||
.map(|d| d.serial)
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// `(serial, reason code)` for excluded candidates, ascending.
|
||||
pub fn excluded(&self) -> Vec<(Serial, &'static str)> {
|
||||
self.candidates
|
||||
.values()
|
||||
.filter_map(|d| d.reason().map(|r| (d.serial, r.code())))
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
|
||||
/// Recompute eligibility for the whole graph.
|
||||
///
|
||||
/// Full recompute per graph event is the v1 design; there is deliberately
|
||||
/// no incremental dirty-set.
|
||||
///
|
||||
/// ⚠️ **Cost is not O(V+E), despite what v3.4 §6.4 says.** Each fixpoint
|
||||
/// pass re-runs a full link BFS *and* a full owner scan, and the bridge
|
||||
/// scans every tainted source in a component for each target, so the bound
|
||||
/// is `O(D · (V + E + Σ_C |sources_C|·|targets_C|))` — worst case
|
||||
/// `O(D · (V² + E))` — for an owner-bridge depth D. D is 1 for every
|
||||
/// topology observed so far and 2 for a forwarder feeding a forwarder, and
|
||||
/// components on a real desktop are two or three nodes; the quadratic term
|
||||
/// needs one owner with many legs. A 60-layer chain test guards the depth
|
||||
/// dimension only. Phase 5 records the real recompute-duration
|
||||
/// distribution and maximum, which is what "full recompute is fine for v1"
|
||||
/// should rest on — measured headroom, not a node count.
|
||||
pub fn evaluate(
|
||||
snapshot: &GraphSnapshot,
|
||||
ctx: &ExclusionCtx,
|
||||
prior: &StickyState,
|
||||
) -> (Decisions, StickyState) {
|
||||
let components = OwnerComponents::build(snapshot, ctx.pipewire_pulse_pid);
|
||||
let keys = owner::OwnerKeyIndex::build(snapshot, ctx.pipewire_pulse_pid);
|
||||
|
||||
let mut taint: BTreeMap<Serial, Reason> = BTreeMap::new();
|
||||
let mut sticky_serials: BTreeSet<Serial> = BTreeSet::new();
|
||||
|
||||
seed_local_roots(snapshot, ctx, &mut taint);
|
||||
seed_sticky(
|
||||
snapshot,
|
||||
&keys,
|
||||
prior,
|
||||
&components,
|
||||
&mut taint,
|
||||
&mut sticky_serials,
|
||||
);
|
||||
|
||||
// Monotone fixpoint: every step only adds taint, or lowers a node's
|
||||
// reason priority, both of which are bounded. Link propagation and the
|
||||
// owner bridge feed each other — a bridged output leg has downstream
|
||||
// links, and a downstream monitor reader bridges to its own siblings —
|
||||
// so neither can be run once.
|
||||
let edges = downstream_edges(snapshot, &mut taint);
|
||||
loop {
|
||||
let mut changed = false;
|
||||
changed |= propagate_links(&edges.edges, &mut taint);
|
||||
changed |= propagate_owner_bridge(&keys, &components, &edges, &mut taint);
|
||||
changed |= propagate_unresolved_owner(snapshot, &keys, &edges, &mut taint);
|
||||
if !changed {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
let decisions = build_decisions(snapshot, ctx, &taint, &sticky_serials);
|
||||
// ⚠️ Readiness gates **retirement only**, never addition (Codex rounds
|
||||
// 1 and 2, which caught the two halves of this in turn). An object
|
||||
// missing from an untrustworthy snapshot has not been observed to
|
||||
// disappear, so retiring on that basis erases history and the next
|
||||
// ready recompute hands back a clean bill of health. But taint
|
||||
// *observed* during a not-ready epoch is real — a reader can consume
|
||||
// and buffer the call and then vanish before readiness — so discarding
|
||||
// additions was the same defect pointing the other way.
|
||||
let next_sticky = build_sticky(snapshot, &keys, &components, &taint, prior, ctx.graph_ready);
|
||||
(decisions, next_sticky)
|
||||
}
|
||||
|
||||
/// Roots that are visible on the node itself.
|
||||
fn seed_local_roots(
|
||||
snapshot: &GraphSnapshot,
|
||||
ctx: &ExclusionCtx,
|
||||
taint: &mut BTreeMap<Serial, Reason>,
|
||||
) {
|
||||
for node in snapshot.nodes() {
|
||||
if let Some(reason) = local_root_reason(node, ctx) {
|
||||
raise(taint, node.serial, reason);
|
||||
}
|
||||
// A node whose own global id is ambiguous cannot be the reliable
|
||||
// endpoint of any link, so its ancestry is unresolvable.
|
||||
if snapshot.node_by_id(node.id) == Some(IdLookup::Ambiguous) {
|
||||
raise(taint, node.serial, Reason::UnresolvedAncestry);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn local_root_reason(node: &NodeSnapshot, ctx: &ExclusionCtx) -> Option<Reason> {
|
||||
if node.props.peerspeak_owned {
|
||||
return Some(Reason::PeerspeakOwned);
|
||||
}
|
||||
if let (Some(module), Some(aec)) = (node.props.pulse_module_id, ctx.aec_module_id)
|
||||
&& module == aec
|
||||
{
|
||||
return Some(Reason::AecIdentity);
|
||||
}
|
||||
if ctx.pixelpass_owned.contains(&node.serial)
|
||||
|| node
|
||||
.name
|
||||
.as_deref()
|
||||
.is_some_and(|name| name.starts_with(CAPTURE_SINK_PREFIX))
|
||||
{
|
||||
return Some(Reason::PixelpassOwned);
|
||||
}
|
||||
if node
|
||||
.props
|
||||
.link_group
|
||||
.as_deref()
|
||||
.is_some_and(|group| group.starts_with(ECHO_CANCEL_GROUP_PREFIX))
|
||||
{
|
||||
return Some(Reason::ForeignEchoCancel);
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
/// Carry taint forward from previous snapshots (v3.4 §6.1.3).
|
||||
///
|
||||
/// An owner is re-seeded from three kinds of evidence, all lifetime-scoped
|
||||
/// to a still-live member: its own surviving nodes, nodes on a surviving
|
||||
/// **Client**, and nodes presenting a remembered owner **fingerprint**.
|
||||
fn seed_sticky(
|
||||
snapshot: &GraphSnapshot,
|
||||
keys: &owner::OwnerKeyIndex,
|
||||
prior: &StickyState,
|
||||
components: &OwnerComponents,
|
||||
taint: &mut BTreeMap<Serial, Reason>,
|
||||
sticky_serials: &mut BTreeSet<Serial>,
|
||||
) {
|
||||
for entry in &prior.owners {
|
||||
let mut live_nodes: Vec<Serial> = Vec::new();
|
||||
for member in &entry.members {
|
||||
match member {
|
||||
ObjectRef::Node(serial) => {
|
||||
if snapshot.node(*serial).is_some() {
|
||||
live_nodes.push(*serial);
|
||||
}
|
||||
}
|
||||
// A surviving **Client** re-seeds too. An app can close
|
||||
// every stream it had while keeping its PipeWire connection
|
||||
// open, then open a fresh one — Firefox does exactly this.
|
||||
ObjectRef::Client(serial) => {
|
||||
live_nodes.extend(nodes_of_client(snapshot, keys, *serial));
|
||||
}
|
||||
}
|
||||
}
|
||||
if live_nodes.is_empty() && !entry.members.iter().any(|m| is_live(snapshot, *m)) {
|
||||
// Nothing of this owner remains; its fingerprints are just
|
||||
// recyclable strings now and must not be applied to anyone.
|
||||
continue;
|
||||
}
|
||||
// Fingerprints reach a *new connection* of the same still-live
|
||||
// process, which neither of the two paths above can see.
|
||||
for fingerprint in &entry.fingerprints {
|
||||
live_nodes.extend(
|
||||
snapshot
|
||||
.nodes()
|
||||
.filter(|node| keys.has_fingerprint(node.serial, fingerprint))
|
||||
.map(|node| node.serial),
|
||||
);
|
||||
}
|
||||
// The owner is sticky, not the individual node: a leg that appears
|
||||
// later in the same still-live owner inherits the taint.
|
||||
for serial in live_nodes {
|
||||
for member in components.members_with(serial) {
|
||||
let reason = entry.reason_for(*member);
|
||||
if raise(taint, *member, reason) || taint.get(member) == Some(&reason) {
|
||||
sticky_serials.insert(*member);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Nodes currently attached to a client, by the client's **serial**. The
|
||||
/// client's snapshot-local id is resolved fresh each time, so a recycled id
|
||||
/// can never resurrect a dead owner.
|
||||
///
|
||||
/// Nodes for which `client.id` is not a usable owner key — session-manager
|
||||
/// device nodes — are excluded, or the shared `WirePlumber [export]` Client
|
||||
/// would drag every sound card on the box into one sticky owner.
|
||||
///
|
||||
/// The same gate is applied when *recording* clients into a sticky entry
|
||||
/// (`owner::client_serials_of`). Either one alone closes the leak; both are
|
||||
/// kept because they answer different questions ("may this client be
|
||||
/// remembered?" and "may this client speak for that node?"), and the
|
||||
/// regression test kills the removal of the pair.
|
||||
fn nodes_of_client(
|
||||
snapshot: &GraphSnapshot,
|
||||
keys: &owner::OwnerKeyIndex,
|
||||
client: Serial,
|
||||
) -> Vec<Serial> {
|
||||
let Some(id) = snapshot
|
||||
.clients()
|
||||
.find(|c| c.serial == client)
|
||||
.map(|c| c.id)
|
||||
else {
|
||||
return Vec::new();
|
||||
};
|
||||
snapshot
|
||||
.nodes()
|
||||
.filter(|node| node.props.client_id == Some(id))
|
||||
.filter(|node| keys.uses_client_key(node.serial))
|
||||
.map(|node| node.serial)
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// `output node → input nodes`, resolving snapshot-local ids. An endpoint
|
||||
/// that does not resolve taints the *other* end as unresolved ancestry when
|
||||
/// that other end is the input side — we cannot know what is feeding it.
|
||||
fn downstream_edges(snapshot: &GraphSnapshot, taint: &mut BTreeMap<Serial, Reason>) -> Edges {
|
||||
let mut edges: BTreeMap<Serial, Vec<Serial>> = BTreeMap::new();
|
||||
let mut receivers: BTreeSet<Serial> = BTreeSet::new();
|
||||
for link in snapshot.links() {
|
||||
let from = snapshot.node_by_id(link.output_node);
|
||||
let to = snapshot.node_by_id(link.input_node);
|
||||
match (from, to) {
|
||||
(Some(IdLookup::Unique(from)), Some(IdLookup::Unique(to))) => {
|
||||
edges.entry(from).or_default().push(to);
|
||||
receivers.insert(to);
|
||||
}
|
||||
(_, Some(IdLookup::Unique(to))) => {
|
||||
// Something feeds this node and we cannot say what.
|
||||
raise(taint, to, Reason::UnresolvedAncestry);
|
||||
receivers.insert(to);
|
||||
}
|
||||
(_, Some(IdLookup::Ambiguous)) => {
|
||||
// Several nodes claim the input id and we cannot say which
|
||||
// one this link feeds, so every claimant is a receiver.
|
||||
// They are already tainted as unresolved by their own
|
||||
// ambiguous id — but taint without receiver status cannot
|
||||
// start an owner bridge, so their sibling output legs stayed
|
||||
// Eligible (Codex round 2, finding 3).
|
||||
receivers.extend(
|
||||
snapshot
|
||||
.nodes_with_id(link.input_node)
|
||||
.map(|node| node.serial),
|
||||
);
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
for targets in edges.values_mut() {
|
||||
targets.sort_unstable();
|
||||
targets.dedup();
|
||||
}
|
||||
// A node that receives audio by *role* counts even with no inbound link
|
||||
// yet: a pixelpass capture sink is a taint root the moment it exists,
|
||||
// and its owner's re-emitting leg must be bridged from it immediately.
|
||||
receivers.extend(
|
||||
snapshot
|
||||
.nodes()
|
||||
.filter(|node| node.role.receives_audio())
|
||||
.map(|node| node.serial),
|
||||
);
|
||||
Edges { edges, receivers }
|
||||
}
|
||||
|
||||
/// Resolved signal edges plus the set of nodes that can receive audio.
|
||||
struct Edges {
|
||||
edges: BTreeMap<Serial, Vec<Serial>>,
|
||||
/// ⚠️ Membership is "appears as a resolved `link.input.node`" **or**
|
||||
/// "has a receiving role" — deliberately not role alone. Codex round 1:
|
||||
/// a node whose `media.class` is absent or unexpected (`Other`), or an
|
||||
/// `Audio/Source` that is really a filter output, can sit on an inbound
|
||||
/// link carrying tainted audio; inferring "receives audio" from the role
|
||||
/// alone left such a node unable to start an owner bridge, and its
|
||||
/// sibling output leg stayed Eligible while re-emitting the call.
|
||||
receivers: BTreeSet<Serial>,
|
||||
}
|
||||
|
||||
fn propagate_links(
|
||||
downstream: &BTreeMap<Serial, Vec<Serial>>,
|
||||
taint: &mut BTreeMap<Serial, Reason>,
|
||||
) -> bool {
|
||||
let mut changed = false;
|
||||
let mut queue: VecDeque<Serial> = taint
|
||||
.iter()
|
||||
.filter(|(_, reason)| reason.propagates())
|
||||
.map(|(serial, _)| *serial)
|
||||
.collect();
|
||||
while let Some(serial) = queue.pop_front() {
|
||||
let Some(targets) = downstream.get(&serial) else {
|
||||
continue;
|
||||
};
|
||||
for target in targets {
|
||||
if raise(taint, *target, Reason::TaintedUpstream) {
|
||||
changed = true;
|
||||
queue.push_back(*target);
|
||||
}
|
||||
}
|
||||
}
|
||||
changed
|
||||
}
|
||||
|
||||
/// The conditional owner bridge (v3.4 §6.1.1): taint crosses to an owner's
|
||||
/// other legs **only** when the tainted member is one that actually
|
||||
/// receives audio. The naive "this owner has both an input and an output
|
||||
/// leg ⇒ exclude the output" rule would exclude every app using a
|
||||
/// microphone, Firefox in a video call included.
|
||||
fn propagate_owner_bridge(
|
||||
keys: &owner::OwnerKeyIndex,
|
||||
components: &OwnerComponents,
|
||||
edges: &Edges,
|
||||
taint: &mut BTreeMap<Serial, Reason>,
|
||||
) -> bool {
|
||||
let mut changed = false;
|
||||
for members in components.components() {
|
||||
let sources: BTreeSet<Serial> = members
|
||||
.iter()
|
||||
.copied()
|
||||
.filter(|serial| {
|
||||
taint.get(serial).is_some_and(|r| r.propagates())
|
||||
&& edges.receivers.contains(serial)
|
||||
})
|
||||
.collect();
|
||||
if sources.is_empty() {
|
||||
continue;
|
||||
}
|
||||
for target in members {
|
||||
if sources.contains(target) {
|
||||
continue;
|
||||
}
|
||||
// Name the strongest key shared directly with any tainted
|
||||
// member; `None` means the two are only transitively related.
|
||||
let key = sources
|
||||
.iter()
|
||||
.filter_map(|source| keys.strongest_shared(*source, *target))
|
||||
.min();
|
||||
changed |= raise(taint, *target, Reason::TaintedOwnerBridge { key });
|
||||
}
|
||||
}
|
||||
changed
|
||||
}
|
||||
|
||||
/// Fail-closed backstop for an owner we cannot bound (v3.4 §6.1.1, final
|
||||
/// paragraph): something read tainted audio and nothing about the output
|
||||
/// legs on this box lets us enumerate which of them are its siblings, so we
|
||||
/// cannot know which one is re-emitting what it read. Exclude the output
|
||||
/// legs that are equally unbounded.
|
||||
///
|
||||
/// The trigger and the sweep, precisely (both edges hard-won across four
|
||||
/// Codex rounds):
|
||||
///
|
||||
/// - **Trigger — any tainted receiver that is not a real device node.** A
|
||||
/// tainted hardware sink is the normal case, not an anomaly (peerspeak's
|
||||
/// playback taints the default sink every recompute), so device nodes do
|
||||
/// not trip it. The source does **not** have to be unbounded: a reader
|
||||
/// with a `node.link-group` whose re-emitting leg carries none is bounded
|
||||
/// while its sibling is unfindable (round 1).
|
||||
/// - **Sweep — depends on whether any tainted reader is itself unbounded.**
|
||||
/// A *bounded* reader's siblings are exactly the outputs sharing its key,
|
||||
/// so only the unbounded outputs (which could share its unknowable-only-
|
||||
/// in-part identity) are swept; a differently-keyed output is provably a
|
||||
/// different owner. An *unbounded* reader could be **any** owner — a real
|
||||
/// process may present no PID on its reading leg (round 4) — so every
|
||||
/// output candidate is swept, real apps included.
|
||||
///
|
||||
/// **Two tiers, because a tainted reader we cannot bound is a bigger
|
||||
/// unknown than one we can** (Codex round 3 — the mirror image of the
|
||||
/// round-1 case):
|
||||
///
|
||||
/// - A *bounded* tainted reader has a strong key or a usable PID, so its
|
||||
/// siblings are exactly the output legs sharing that key. Any output leg
|
||||
/// that is *itself* bounded by a **different** key is provably a different
|
||||
/// owner and stays eligible; only unbounded output legs are its possible
|
||||
/// siblings. → exclude unbounded outputs.
|
||||
/// - An *unbounded* tainted reader has nothing that identifies its owner, so
|
||||
/// its re-emitting leg could be **any** output on the box, and no property
|
||||
/// on an output leg can prove it is unrelated. → exclude every output
|
||||
/// candidate.
|
||||
///
|
||||
/// ⚠️ I tried to narrow this to "daemon-owned outputs only", on the
|
||||
/// theory that an unbounded reader must be daemon-owned (a real app has a
|
||||
/// PID, which would bound it) so a real-PID output is provably a different
|
||||
/// owner. **Codex refuted it (round 4):** `application.process.id` is
|
||||
/// optional and client-controlled, so a real process can present *no* PID
|
||||
/// on its reading leg (unbounded) and a real PID on its output leg — one
|
||||
/// owner, spared by the narrowing, leaking the call. Only `pipewire.*`
|
||||
/// properties have protected identity; app properties cannot carry a
|
||||
/// soundness argument. So: exclude everything. The trigger is genuinely
|
||||
/// anomalous — a keyless reader actively consuming the call; EasyEffects
|
||||
/// and loopbacks carry a `node.link-group` and are *bounded*, so they do
|
||||
/// not trip this tier — and phase 5's dry run surfaces it before it can
|
||||
/// gate anything real.
|
||||
fn propagate_unresolved_owner(
|
||||
snapshot: &GraphSnapshot,
|
||||
keys: &owner::OwnerKeyIndex,
|
||||
edges: &Edges,
|
||||
taint: &mut BTreeMap<Serial, Reason>,
|
||||
) -> bool {
|
||||
let mut has_tainted_reader = false;
|
||||
let mut has_unbounded_tainted_reader = false;
|
||||
for node in snapshot.nodes() {
|
||||
let is_tainted_reader = !node.props.session_device
|
||||
&& edges.receivers.contains(&node.serial)
|
||||
&& taint.get(&node.serial).is_some_and(|r| r.propagates());
|
||||
if is_tainted_reader {
|
||||
has_tainted_reader = true;
|
||||
has_unbounded_tainted_reader |= !keys.is_bounded(node.serial);
|
||||
}
|
||||
}
|
||||
if !has_tainted_reader {
|
||||
return false;
|
||||
}
|
||||
let mut changed = false;
|
||||
for node in snapshot.nodes() {
|
||||
if node.role == MediaRole::StreamOutput
|
||||
&& (has_unbounded_tainted_reader || !keys.is_bounded(node.serial))
|
||||
{
|
||||
changed |= raise(taint, node.serial, Reason::UnresolvedOwner);
|
||||
}
|
||||
}
|
||||
changed
|
||||
}
|
||||
|
||||
fn build_decisions(
|
||||
snapshot: &GraphSnapshot,
|
||||
ctx: &ExclusionCtx,
|
||||
taint: &BTreeMap<Serial, Reason>,
|
||||
sticky_serials: &BTreeSet<Serial>,
|
||||
) -> Decisions {
|
||||
let mut candidates = BTreeMap::new();
|
||||
for node in snapshot.nodes().filter(|n| n.role.is_candidate()) {
|
||||
let sticky = sticky_serials.contains(&node.serial);
|
||||
let eligibility = if !ctx.graph_ready {
|
||||
Eligibility::NotEligible {
|
||||
reason: Reason::GraphNotReady,
|
||||
sticky: false,
|
||||
}
|
||||
} else if let Some(reason) = taint.get(&node.serial) {
|
||||
Eligibility::NotEligible {
|
||||
reason: *reason,
|
||||
sticky,
|
||||
}
|
||||
} else if let Some(reason) = local_exclusion(snapshot, node) {
|
||||
Eligibility::NotEligible {
|
||||
reason,
|
||||
sticky: false,
|
||||
}
|
||||
} else {
|
||||
Eligibility::Eligible
|
||||
};
|
||||
candidates.insert(
|
||||
node.serial,
|
||||
NodeDecision {
|
||||
serial: node.serial,
|
||||
name: node.name.clone(),
|
||||
eligibility,
|
||||
},
|
||||
);
|
||||
}
|
||||
Decisions {
|
||||
candidates,
|
||||
taint: taint
|
||||
.iter()
|
||||
.map(|(serial, reason)| {
|
||||
(
|
||||
*serial,
|
||||
TaintEntry {
|
||||
reason: *reason,
|
||||
sticky: sticky_serials.contains(serial),
|
||||
},
|
||||
)
|
||||
})
|
||||
.collect(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Node-local reasons a link cannot be created even though the node is
|
||||
/// clean. These do not propagate — an exclusive-port stream is unlinkable,
|
||||
/// not hazardous.
|
||||
fn local_exclusion(snapshot: &GraphSnapshot, node: &NodeSnapshot) -> Option<Reason> {
|
||||
if node.props.passthrough {
|
||||
return Some(Reason::Passthrough);
|
||||
}
|
||||
if snapshot.ports_of(node.id).any(|port| port.exclusive) {
|
||||
return Some(Reason::PortExclusive);
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
/// Sticky bookkeeping for the next recompute: every tainted owner, with
|
||||
/// every object observed to constitute it, merged with any prior entry that
|
||||
/// still overlaps. Members accumulate — that is what makes "clear only once
|
||||
/// all member objects have disappeared" true across churn.
|
||||
fn build_sticky(
|
||||
snapshot: &GraphSnapshot,
|
||||
keys: &owner::OwnerKeyIndex,
|
||||
components: &OwnerComponents,
|
||||
taint: &BTreeMap<Serial, Reason>,
|
||||
prior: &StickyState,
|
||||
retire_absent: bool,
|
||||
) -> StickyState {
|
||||
let mut entries: Vec<StickyOwner> = Vec::new();
|
||||
|
||||
// Carry forward prior entries that still have at least one live member.
|
||||
// An entry with none is gone for good: serials never recycle, so a
|
||||
// vanished member can never come back — but only a *trustworthy*
|
||||
// snapshot is allowed to conclude that a member is absent.
|
||||
for entry in &prior.owners {
|
||||
if !retire_absent
|
||||
|| entry
|
||||
.members
|
||||
.iter()
|
||||
.any(|member| is_live(snapshot, *member))
|
||||
{
|
||||
entries.push(entry.clone());
|
||||
}
|
||||
}
|
||||
|
||||
for members in components.components() {
|
||||
let node_reasons: BTreeMap<Serial, Reason> = members
|
||||
.iter()
|
||||
.filter_map(|serial| {
|
||||
taint
|
||||
.get(serial)
|
||||
.filter(|reason| reason.propagates())
|
||||
.map(|reason| (*serial, *reason))
|
||||
})
|
||||
.collect();
|
||||
if node_reasons.is_empty() {
|
||||
continue;
|
||||
}
|
||||
let mut refs: BTreeSet<ObjectRef> = members.iter().map(|s| ObjectRef::Node(*s)).collect();
|
||||
refs.extend(
|
||||
owner::client_serials_of(snapshot, keys, members)
|
||||
.into_iter()
|
||||
.map(ObjectRef::Client),
|
||||
);
|
||||
let fingerprints = members
|
||||
.iter()
|
||||
.flat_map(|serial| keys.fingerprints(*serial))
|
||||
.collect();
|
||||
entries.push(StickyOwner {
|
||||
members: refs,
|
||||
fingerprints,
|
||||
node_reasons,
|
||||
});
|
||||
}
|
||||
|
||||
StickyState {
|
||||
owners: merge_overlapping(entries),
|
||||
}
|
||||
}
|
||||
|
||||
fn is_live(snapshot: &GraphSnapshot, member: ObjectRef) -> bool {
|
||||
match member {
|
||||
ObjectRef::Node(serial) => snapshot.node(serial).is_some(),
|
||||
ObjectRef::Client(serial) => snapshot.clients().any(|c| c.serial == serial),
|
||||
}
|
||||
}
|
||||
|
||||
/// Merge entries that share any member, keeping the strongest reason.
|
||||
/// Owners fuse over time (a component that gains a leg belonging to a
|
||||
/// previously separate sticky owner is one owner now); splitting them back
|
||||
/// apart would drop taint, which is the unsafe direction.
|
||||
fn merge_overlapping(mut entries: Vec<StickyOwner>) -> Vec<StickyOwner> {
|
||||
let mut merged: Vec<StickyOwner> = Vec::new();
|
||||
while let Some(mut entry) = entries.pop() {
|
||||
let mut absorbed = true;
|
||||
while absorbed {
|
||||
absorbed = false;
|
||||
let mut rest = Vec::with_capacity(entries.len());
|
||||
for other in entries.drain(..) {
|
||||
if entry.members.is_disjoint(&other.members) {
|
||||
rest.push(other);
|
||||
} else {
|
||||
for (serial, reason) in other.node_reasons {
|
||||
entry
|
||||
.node_reasons
|
||||
.entry(serial)
|
||||
.and_modify(|existing| {
|
||||
if reason.priority() < existing.priority() {
|
||||
*existing = reason;
|
||||
}
|
||||
})
|
||||
.or_insert(reason);
|
||||
}
|
||||
entry.members.extend(other.members);
|
||||
entry.fingerprints.extend(other.fingerprints);
|
||||
absorbed = true;
|
||||
}
|
||||
}
|
||||
entries = rest;
|
||||
}
|
||||
merged.push(entry);
|
||||
}
|
||||
merged.sort_by(|a, b| a.members.iter().next().cmp(&b.members.iter().next()));
|
||||
merged
|
||||
}
|
||||
|
||||
/// Record `reason` for `serial` if it is new or strictly stronger than what
|
||||
/// is already recorded. Returns whether anything changed — the fixpoint's
|
||||
/// termination argument rests on this being monotone.
|
||||
fn raise(taint: &mut BTreeMap<Serial, Reason>, serial: Serial, reason: Reason) -> bool {
|
||||
match taint.get(&serial) {
|
||||
Some(existing) if existing.priority() <= reason.priority() => false,
|
||||
_ => {
|
||||
taint.insert(serial, reason);
|
||||
true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,390 @@
|
||||
//! The owner bridge — grouping nodes that belong to the same *owner* even
|
||||
//! though the graph shows no Link between them.
|
||||
//!
|
||||
//! This is the subtlest part of the design (v3.4 §6.1.2). Measured fact it
|
||||
//! exists to handle: a `module-loopback` forwarder's input leg and output
|
||||
//! leg have **no Link between them**, so walking Links alone from the
|
||||
//! leaking output leg finds no inbound links at all — a dead end that reads
|
||||
//! as "clean". The legs are related only by shared properties.
|
||||
//!
|
||||
//! ## The rule
|
||||
//!
|
||||
//! A union of keys, strongest first:
|
||||
//!
|
||||
//! | # | key | scope |
|
||||
//! | --- | --- | --- |
|
||||
//! | 1 | `node.link-group` | per module/filter instance |
|
||||
//! | 2 | `pulse.module.id` | per pactl module |
|
||||
//! | 3 | `client.id` | per **connection** |
|
||||
//! | 4 | `application.process.id` | per process |
|
||||
//!
|
||||
//! ⚠️ **"Resolves" means the two legs carry the key AND the values are
|
||||
//! EQUAL — not "the first key present".** A first-present implementation
|
||||
//! reproduces the exact measured leak: for `gst-launch pulsesrc ! pulsesink`
|
||||
//! both legs carry `client.id` (209 and 210) but the values *differ*, so
|
||||
//! first-present stops at key 3, sees a mismatch, and concludes "different
|
||||
//! owners". The legs are in fact one process (`application.process.id`
|
||||
//! 20172 on both). So: try each key in order, and a key resolves only if
|
||||
//! both legs carry it and the values are equal; otherwise fall through.
|
||||
//!
|
||||
//! ## Two exceptions, both guarding against mass over-exclusion
|
||||
//!
|
||||
//! 1. **Never bridge on key 4 when the value is pipewire-pulse's own PID**
|
||||
//! (v3.4 §6.1.2). Module-created streams all carry the daemon's PID, so
|
||||
//! bridging on it fuses every Pulse module into one owner and a single
|
||||
//! tainted module input would exclude every module-created stream on the
|
||||
//! box. Keys 1 and 2 already cover those cases precisely.
|
||||
//!
|
||||
//! 2. **Coarse keys (3 and 4) may not bridge nodes exported from a real
|
||||
//! `Device`** — i.e. nodes carrying `device.id`. ⚠️ This rule is *not*
|
||||
//! in design v3.4; it was found while implementing, and it is the exact
|
||||
//! analogue of exception 1 for the session manager.
|
||||
//! ✅ **MEASURED on the live graph 2026-07-21:**
|
||||
//!
|
||||
//! | node | `client.id` | `device.id` | `factory.name` |
|
||||
//! | --- | --- | --- | --- |
|
||||
//! | 5 × `alsa_{output,input}.*` | **42** (`WirePlumber [export]`) | 43/45/46 | `api.alsa.pcm.{sink,source}` |
|
||||
//! | 3 × `sink-sunshine-*` | 83 / 86 / 92 (each its own) | **absent** | `support.null-audio-sink` |
|
||||
//!
|
||||
//! So one shared coarse key genuinely does relate every hardware device
|
||||
//! on the box, and `device.id` cleanly separates that set from virtual
|
||||
//! sinks. Without the rule, the hardware sink carrying peerspeak's
|
||||
//! playback (tainted by design, every single recompute) would bridge to
|
||||
//! *every other device node including the microphone source*, whose
|
||||
//! readers would then taint their owners' playback legs — reproducing
|
||||
//! precisely the §6.1.1 catastrophe ("excludes any app using a
|
||||
//! microphone") through a different door.
|
||||
//!
|
||||
//! ⚠️ **Keyed on `device.id`, NOT on `media.class` being `Audio/Sink`.**
|
||||
//! The first cut suppressed coarse keys for every device-*role* node,
|
||||
//! and Codex refuted it: a **native virtual sink** — an app that creates
|
||||
//! an `Audio/Sink` plus a re-emitting stream on one client, with no
|
||||
//! `link-group` and no `pulse.module.id` — would then have had its only
|
||||
//! correlation stripped, and it would have leaked the whole call. Such a
|
||||
//! sink has no `device.id`, so it now bridges on `client.id` as it
|
||||
//! should.
|
||||
//!
|
||||
//! Grouping is **transitive** (union-find). That is the fail-closed
|
||||
//! direction: bigger owner components mean more taint, never less.
|
||||
|
||||
use std::collections::BTreeMap;
|
||||
|
||||
use super::snapshot::{GlobalId, GraphSnapshot, NodeSnapshot, Serial};
|
||||
|
||||
/// Which key bridged two legs. Ordered strongest first; the `Ord` derive is
|
||||
/// load-bearing for "report the strongest shared key".
|
||||
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
|
||||
pub enum OwnerKey {
|
||||
LinkGroup,
|
||||
PulseModuleId,
|
||||
ClientId,
|
||||
ProcessId,
|
||||
}
|
||||
|
||||
impl OwnerKey {
|
||||
/// Stable, machine-readable — this ends up in the phase 5 audit output
|
||||
/// and the phase 6 status event.
|
||||
pub fn code(self) -> &'static str {
|
||||
match self {
|
||||
Self::LinkGroup => "node.link-group",
|
||||
Self::PulseModuleId => "pulse.module.id",
|
||||
Self::ClientId => "client.id",
|
||||
Self::ProcessId => "application.process.id",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The value a node presents for a given key, if it presents one at all.
|
||||
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
|
||||
enum KeyValue {
|
||||
Text(String),
|
||||
Num(u64),
|
||||
}
|
||||
|
||||
/// Owner keys usable on this node, strongest first.
|
||||
///
|
||||
/// A key that is present but unusable (the pipewire-pulse PID; a coarse key
|
||||
/// on a device node) is **absent** here — that is the whole mechanism of the
|
||||
/// two exceptions.
|
||||
fn keys_of(node: &NodeSnapshot, pipewire_pulse_pid: Option<u32>) -> Vec<(OwnerKey, KeyValue)> {
|
||||
let mut out = Vec::new();
|
||||
if let Some(group) = &node.props.link_group {
|
||||
out.push((OwnerKey::LinkGroup, KeyValue::Text(group.clone())));
|
||||
}
|
||||
if let Some(module) = node.props.pulse_module_id {
|
||||
out.push((OwnerKey::PulseModuleId, KeyValue::Num(module)));
|
||||
}
|
||||
// Exception 2: coarse keys never bridge passive session-manager device
|
||||
// nodes — they all share the session manager's client.
|
||||
if node.props.session_device {
|
||||
return out;
|
||||
}
|
||||
if let Some(client) = node.props.client_id {
|
||||
out.push((OwnerKey::ClientId, KeyValue::Num(u64::from(client.0))));
|
||||
}
|
||||
if let Some(pid) = node.props.process_id {
|
||||
// Exception 1. Note the fail-closed asymmetry when the daemon PID is
|
||||
// unknown (`None`): the exception does *not* fire, key 4 applies to
|
||||
// everything, and Pulse modules fuse into one owner. That is broad
|
||||
// over-exclusion — annoying and safe — which is the direction v3.4
|
||||
// §6.1.2's failure-mode paragraph asks for.
|
||||
if Some(pid) != pipewire_pulse_pid {
|
||||
out.push((OwnerKey::ProcessId, KeyValue::Num(u64::from(pid))));
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// Can this node's owner be positively bounded — i.e. can we enumerate its
|
||||
/// sibling legs and be right?
|
||||
///
|
||||
/// ⚠️ Not the same as "has any usable key", and the difference is a leak.
|
||||
/// `client.id` alone does **not** bound an owner: that is the measured
|
||||
/// GStreamer refutation, where one process presented two different
|
||||
/// `client.id`s for its two legs. So an owner is bounded only by a strong
|
||||
/// key (link-group / pulse.module.id) or by a *usable* process id — usable
|
||||
/// meaning key 4 was not suppressed as pipewire-pulse's own PID.
|
||||
///
|
||||
/// The case this exists for is v3.4 §12's "module forwarder with neither
|
||||
/// `link-group` nor `pulse.module.id`": its process id is the daemon's and
|
||||
/// therefore suppressed, its two legs may carry different `client.id`s, and
|
||||
/// nothing else relates them. Its sibling output leg cannot be found, so
|
||||
/// the engine must fail closed rather than declare it clean
|
||||
/// (v3.4 §6.1.1, final paragraph).
|
||||
pub fn owner_is_bounded(node: &NodeSnapshot, pipewire_pulse_pid: Option<u32>) -> bool {
|
||||
keys_of(node, pipewire_pulse_pid)
|
||||
.iter()
|
||||
.any(|(key, _)| *key != OwnerKey::ClientId)
|
||||
}
|
||||
|
||||
/// Owner keys computed once per snapshot.
|
||||
///
|
||||
/// `keys_of` allocates a `Vec` and clones the `link-group` string, and the
|
||||
/// bridge asks for keys once per (tainted member × component member) pair —
|
||||
/// so recomputing was the hot spot in an otherwise linear pass.
|
||||
#[derive(Debug, Default)]
|
||||
pub struct OwnerKeyIndex {
|
||||
keys: BTreeMap<Serial, Vec<(OwnerKey, KeyValue)>>,
|
||||
}
|
||||
|
||||
impl OwnerKeyIndex {
|
||||
pub fn build(snapshot: &GraphSnapshot, pipewire_pulse_pid: Option<u32>) -> Self {
|
||||
Self {
|
||||
keys: snapshot
|
||||
.nodes()
|
||||
.map(|node| (node.serial, keys_of(node, pipewire_pulse_pid)))
|
||||
.collect(),
|
||||
}
|
||||
}
|
||||
|
||||
/// The strongest key these two nodes share directly, if any.
|
||||
pub fn strongest_shared(&self, a: Serial, b: Serial) -> Option<OwnerKey> {
|
||||
let (Some(a_keys), Some(b_keys)) = (self.keys.get(&a), self.keys.get(&b)) else {
|
||||
return None;
|
||||
};
|
||||
// Stored strongest-first, so the first match is the strongest.
|
||||
a_keys.iter().find_map(|(key, value)| {
|
||||
b_keys
|
||||
.iter()
|
||||
.any(|(other_key, other_value)| other_key == key && other_value == value)
|
||||
.then_some(*key)
|
||||
})
|
||||
}
|
||||
|
||||
/// Is `client.id` a usable owner key for this node?
|
||||
///
|
||||
/// ⚠️ Load-bearing for sticky state. A device node's `client.id` is
|
||||
/// suppressed by exception 2, so recording the session manager's Client
|
||||
/// as a *member* of a tainted device's sticky owner would smuggle the
|
||||
/// suppressed key back in: the next recompute would expand that Client
|
||||
/// to every hardware node on the box — the microphone included — and
|
||||
/// the §6.1.1 catastrophe would arrive one epoch late instead of never.
|
||||
/// (Codex round 2, finding 1.)
|
||||
pub fn uses_client_key(&self, serial: Serial) -> bool {
|
||||
self.keys
|
||||
.get(&serial)
|
||||
.is_some_and(|keys| keys.iter().any(|(key, _)| *key == OwnerKey::ClientId))
|
||||
}
|
||||
|
||||
/// The owner keys that are safe to remember *across* connections, for
|
||||
/// sticky taint: the strong keys plus a usable process id.
|
||||
///
|
||||
/// `client.id` is deliberately excluded — it identifies a *connection*,
|
||||
/// and the whole point of a fingerprint is to survive one process
|
||||
/// closing a connection and opening another. A live Client member is
|
||||
/// what covers the same-connection case, precisely.
|
||||
///
|
||||
/// These are recyclable strings and numbers, so they are only ever
|
||||
/// applied while some **serial** member of the owner is still live
|
||||
/// (v3.4 §6.1.3): while the process is alive, its PID cannot have been
|
||||
/// handed to anyone else.
|
||||
pub fn fingerprints(&self, serial: Serial) -> Vec<Fingerprint> {
|
||||
self.keys
|
||||
.get(&serial)
|
||||
.map(|keys| {
|
||||
keys.iter()
|
||||
.filter(|(key, _)| *key != OwnerKey::ClientId)
|
||||
.map(|(key, value)| Fingerprint(*key, value.clone()))
|
||||
.collect()
|
||||
})
|
||||
.unwrap_or_default()
|
||||
}
|
||||
|
||||
/// Does this node currently present `fingerprint`?
|
||||
pub fn has_fingerprint(&self, serial: Serial, fingerprint: &Fingerprint) -> bool {
|
||||
self.keys.get(&serial).is_some_and(|keys| {
|
||||
keys.iter()
|
||||
.any(|(key, value)| *key == fingerprint.0 && *value == fingerprint.1)
|
||||
})
|
||||
}
|
||||
|
||||
/// See [`owner_is_bounded`].
|
||||
pub fn is_bounded(&self, serial: Serial) -> bool {
|
||||
self.keys
|
||||
.get(&serial)
|
||||
.is_some_and(|keys| keys.iter().any(|(key, _)| *key != OwnerKey::ClientId))
|
||||
}
|
||||
}
|
||||
|
||||
/// The strongest key two nodes share, or `None` if they share none. Used to
|
||||
/// *name* the key in a bridge decision; membership itself is transitive and
|
||||
/// comes from [`OwnerComponents`].
|
||||
pub fn strongest_shared_key(
|
||||
a: &NodeSnapshot,
|
||||
b: &NodeSnapshot,
|
||||
pipewire_pulse_pid: Option<u32>,
|
||||
) -> Option<OwnerKey> {
|
||||
let a_keys = keys_of(a, pipewire_pulse_pid);
|
||||
let b_keys = keys_of(b, pipewire_pulse_pid);
|
||||
// `keys_of` yields strongest-first, so the first match is the strongest.
|
||||
a_keys.iter().find_map(|(key, value)| {
|
||||
b_keys
|
||||
.iter()
|
||||
.any(|(other_key, other_value)| other_key == key && other_value == value)
|
||||
.then_some(*key)
|
||||
})
|
||||
}
|
||||
|
||||
/// A remembered owner key — see [`OwnerKeyIndex::fingerprints`].
|
||||
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
|
||||
pub struct Fingerprint(OwnerKey, KeyValue);
|
||||
|
||||
/// Nodes partitioned into owner components.
|
||||
#[derive(Clone, Debug, Default)]
|
||||
pub struct OwnerComponents {
|
||||
/// node serial → component index.
|
||||
of_node: BTreeMap<Serial, usize>,
|
||||
/// component index → member node serials, ascending.
|
||||
members: Vec<Vec<Serial>>,
|
||||
}
|
||||
|
||||
impl OwnerComponents {
|
||||
pub fn build(snapshot: &GraphSnapshot, pipewire_pulse_pid: Option<u32>) -> Self {
|
||||
let serials: Vec<Serial> = snapshot.nodes().map(|n| n.serial).collect();
|
||||
let index: BTreeMap<Serial, usize> =
|
||||
serials.iter().enumerate().map(|(i, s)| (*s, i)).collect();
|
||||
let mut uf = UnionFind::new(serials.len());
|
||||
|
||||
// Group by (key, value) and union within each group. Equivalent to
|
||||
// the pairwise "some key resolves" rule, and O(n log n).
|
||||
let mut buckets: BTreeMap<(OwnerKey, KeyValue), Vec<usize>> = BTreeMap::new();
|
||||
for node in snapshot.nodes() {
|
||||
let slot = index[&node.serial];
|
||||
for (key, value) in keys_of(node, pipewire_pulse_pid) {
|
||||
buckets.entry((key, value)).or_default().push(slot);
|
||||
}
|
||||
}
|
||||
for group in buckets.values() {
|
||||
for pair in group.windows(2) {
|
||||
uf.union(pair[0], pair[1]);
|
||||
}
|
||||
}
|
||||
|
||||
// Compact roots into dense component indices, deterministically.
|
||||
let mut root_to_component: BTreeMap<usize, usize> = BTreeMap::new();
|
||||
let mut members: Vec<Vec<Serial>> = Vec::new();
|
||||
let mut of_node = BTreeMap::new();
|
||||
for (slot, serial) in serials.iter().enumerate() {
|
||||
let root = uf.find(slot);
|
||||
let component = *root_to_component.entry(root).or_insert_with(|| {
|
||||
members.push(Vec::new());
|
||||
members.len() - 1
|
||||
});
|
||||
members[component].push(*serial);
|
||||
of_node.insert(*serial, component);
|
||||
}
|
||||
Self { of_node, members }
|
||||
}
|
||||
|
||||
pub fn component_of(&self, serial: Serial) -> Option<usize> {
|
||||
self.of_node.get(&serial).copied()
|
||||
}
|
||||
|
||||
/// Member serials of the component containing `serial`, including it.
|
||||
/// Empty if the node is not in this snapshot.
|
||||
pub fn members_with(&self, serial: Serial) -> &[Serial] {
|
||||
match self.component_of(serial) {
|
||||
Some(component) => &self.members[component],
|
||||
None => &[],
|
||||
}
|
||||
}
|
||||
|
||||
pub fn components(&self) -> impl Iterator<Item = &[Serial]> {
|
||||
self.members.iter().map(Vec::as_slice)
|
||||
}
|
||||
}
|
||||
|
||||
struct UnionFind {
|
||||
parent: Vec<usize>,
|
||||
}
|
||||
|
||||
impl UnionFind {
|
||||
fn new(len: usize) -> Self {
|
||||
Self {
|
||||
parent: (0..len).collect(),
|
||||
}
|
||||
}
|
||||
|
||||
fn find(&mut self, mut node: usize) -> usize {
|
||||
while self.parent[node] != node {
|
||||
self.parent[node] = self.parent[self.parent[node]];
|
||||
node = self.parent[node];
|
||||
}
|
||||
node
|
||||
}
|
||||
|
||||
fn union(&mut self, a: usize, b: usize) {
|
||||
let (a, b) = (self.find(a), self.find(b));
|
||||
if a != b {
|
||||
// Lowest root wins, so components are deterministic.
|
||||
let (low, high) = if a < b { (a, b) } else { (b, a) };
|
||||
self.parent[high] = low;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Client objects belonging to an owner component, so sticky taint can be
|
||||
/// keyed on every object that constitutes the owner (v3.4 §6.1.3: clear the
|
||||
/// entry only once **all** member objects are gone).
|
||||
pub fn client_serials_of(
|
||||
snapshot: &GraphSnapshot,
|
||||
keys: &OwnerKeyIndex,
|
||||
nodes: &[Serial],
|
||||
) -> Vec<Serial> {
|
||||
let mut out: Vec<Serial> = nodes
|
||||
.iter()
|
||||
// Only nodes for which `client.id` is a *usable* owner key. See
|
||||
// `uses_client_key`: recording a device node's shared session-manager
|
||||
// Client here would defeat exception 2 on the next recompute.
|
||||
.filter(|serial| keys.uses_client_key(**serial))
|
||||
.filter_map(|serial| snapshot.node(*serial))
|
||||
.filter_map(|node| node.props.client_id)
|
||||
// An ambiguous client id means two Clients claim it and we cannot
|
||||
// say which one is ours, so remember both: an entry that recorded
|
||||
// neither could be retired while its owner was still live.
|
||||
.flat_map(|id: GlobalId| snapshot.clients_with_id(id).map(|client| client.serial))
|
||||
.collect();
|
||||
out.sort_unstable();
|
||||
out.dedup();
|
||||
out
|
||||
}
|
||||
@@ -0,0 +1,332 @@
|
||||
//! The plain, owned graph model the taint engine reasons over.
|
||||
//!
|
||||
//! **No PipeWire types appear in this file, by design** (impl plan §4,
|
||||
//! phase 2). The registry observer (phase 3) translates live globals into
|
||||
//! these structs; every test builds them by hand. Nothing here ever links
|
||||
//! against libpipewire.
|
||||
//!
|
||||
//! Two id-ish things live in this model and confusing them is the bug the
|
||||
//! whole file is shaped to prevent:
|
||||
//!
|
||||
//! - [`Serial`] — `object.serial`, 64-bit, monotonic, **never reused**.
|
||||
//! This is *identity*. Sticky taint is keyed on it.
|
||||
//! - [`GlobalId`] — the PipeWire global id, 32-bit and **recycled**. It is
|
||||
//! a *lookup key within one snapshot* and nothing else: links name their
|
||||
//! endpoints with it, nodes name their client with it. It must never
|
||||
//! outlive the snapshot it was read from (design v3.4 §6.1.3).
|
||||
|
||||
use std::collections::BTreeMap;
|
||||
|
||||
/// `object.serial` — 64-bit, monotonic, never recycled. Identity.
|
||||
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
|
||||
pub struct Serial(pub u64);
|
||||
|
||||
/// A PipeWire global id — 32-bit and **recycled**. Snapshot-local lookup
|
||||
/// key only; see the module docs.
|
||||
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
|
||||
pub struct GlobalId(pub u32);
|
||||
|
||||
/// What a node does with audio, parsed from `media.class`.
|
||||
///
|
||||
/// Taint is computed at **node** granularity (v3.4 §6.1 edge type 2: the
|
||||
/// monitor connection is already a real Link whose output node is the sink
|
||||
/// itself, so a node-level walk crosses `app → sink → monitor-reader` for
|
||||
/// free). Ports exist in the model for link creation in phase 6 and for the
|
||||
/// `port.exclusive` predicate, not for taint.
|
||||
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
|
||||
pub enum MediaRole {
|
||||
/// `Stream/Output/Audio` — an application playing audio. The only
|
||||
/// fan-out candidate.
|
||||
StreamOutput,
|
||||
/// `Stream/Input/Audio` — an application capturing audio.
|
||||
StreamInput,
|
||||
/// `Audio/Sink` — a real or virtual sink.
|
||||
Sink,
|
||||
/// `Audio/Source` — a real or virtual source.
|
||||
Source,
|
||||
/// `Audio/Duplex`. ⚠️ Node granularity smears taint across both roles
|
||||
/// of these; accepted for v1 as fail-closed over-exclusion
|
||||
/// (v3.4 §6.1, edge type 2 caveat).
|
||||
Duplex,
|
||||
/// Anything else, including video and unparseable/absent `media.class`.
|
||||
Other,
|
||||
}
|
||||
|
||||
impl MediaRole {
|
||||
pub fn parse(media_class: Option<&str>) -> Self {
|
||||
match media_class {
|
||||
Some("Stream/Output/Audio") => Self::StreamOutput,
|
||||
Some("Stream/Input/Audio") => Self::StreamInput,
|
||||
Some("Audio/Sink") => Self::Sink,
|
||||
Some("Audio/Source") => Self::Source,
|
||||
Some("Audio/Duplex") => Self::Duplex,
|
||||
_ => Self::Other,
|
||||
}
|
||||
}
|
||||
|
||||
/// Can this node *receive* audio? This is the gate on the owner bridge:
|
||||
/// taint crosses the intra-process hop only when the owner is actually
|
||||
/// reading tainted audio (v3.4 §6.1.1 — "this client has both an input
|
||||
/// and an output leg ⇒ exclude the output" is the catastrophic rule
|
||||
/// that excludes every app with a microphone).
|
||||
///
|
||||
/// `Sink` counts: EasyEffects' `ee_sink` is an `Audio/Sink` that
|
||||
/// receives the tainted mix, and its re-emitting leg is joined to it by
|
||||
/// `node.link-group` with no Link between them.
|
||||
pub fn receives_audio(self) -> bool {
|
||||
matches!(self, Self::StreamInput | Self::Sink | Self::Duplex)
|
||||
}
|
||||
|
||||
/// Device-ish nodes — everything that is not a `Stream/*`. Coarse owner
|
||||
/// keys are not allowed to bridge these; see [`super::owner`].
|
||||
pub fn is_device_role(self) -> bool {
|
||||
matches!(self, Self::Sink | Self::Source | Self::Duplex)
|
||||
}
|
||||
|
||||
/// Only `Stream/Output/Audio` nodes are fan-out candidates (v3.4 §6.2).
|
||||
pub fn is_candidate(self) -> bool {
|
||||
matches!(self, Self::StreamOutput)
|
||||
}
|
||||
}
|
||||
|
||||
/// The subset of node properties the engine actually reasons about.
|
||||
///
|
||||
/// Deliberately a struct of parsed fields rather than a property bag: the
|
||||
/// parsing (and its failure modes) belongs at the observer boundary, and a
|
||||
/// bag invites `props.get("...")` typos that silently read `None` — which
|
||||
/// on this feature means "not tainted".
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq)]
|
||||
pub struct NodeProps {
|
||||
/// `peerspeak.owned` is present and truthy (v3.4 §5.1). A correctness
|
||||
/// mechanism, explicitly *not* a security boundary.
|
||||
pub peerspeak_owned: bool,
|
||||
/// `pulse.module.id`, parsed as `u64` — never `u32`, per v3.4 §5.2's
|
||||
/// parse-defensively note and the phase 0a truncation bug.
|
||||
pub pulse_module_id: Option<u64>,
|
||||
/// `node.link-group` — owner key 1, and the `echo-cancel-` hazard
|
||||
/// prefix (v3.4 §5.4 / D3).
|
||||
pub link_group: Option<String>,
|
||||
/// `client.id` — owner key 3. A **connection**, not an owner: GStreamer
|
||||
/// opens one per stream (v3.4 §6.1.2, measured refutation).
|
||||
pub client_id: Option<GlobalId>,
|
||||
/// `application.process.id` **on the node** — owner key 4. For
|
||||
/// module-created streams this is pipewire-pulse's own PID, which is
|
||||
/// why [`super::ExclusionCtx::pipewire_pulse_pid`] exists.
|
||||
pub process_id: Option<u32>,
|
||||
/// The stream negotiated an encoded/passthrough format; a second link
|
||||
/// would refuse or corrupt it (v3.4 §6.2).
|
||||
pub passthrough: bool,
|
||||
/// This node is a **passive device node exported by the session
|
||||
/// manager** — a real sound card's sink or source, not something that
|
||||
/// forwards audio.
|
||||
///
|
||||
/// ⚠️ **A positive high-confidence classification the observer owes, not
|
||||
/// a raw property** (Codex rounds 2–3). PipeWire defines `device.id`
|
||||
/// only as "the Device this node belongs to" and `device.api` as that
|
||||
/// Device's access API; **neither promises the node passively terminates
|
||||
/// audio**, so a card-associated filter can satisfy both. Setting this
|
||||
/// flag *removes* two protections at once — the node's coarse owner keys
|
||||
/// (`owner` exception 2) and its ability to trip the fail-closed
|
||||
/// backstop — so a false positive is a leak, not over-exclusion.
|
||||
///
|
||||
/// **Phase-3 contract:**
|
||||
/// - Set `true` only on positively-identified passive hardware
|
||||
/// terminals: a resolved `device.id` on a real backend
|
||||
/// (`device.api` present) whose `factory.name` is on an **explicit
|
||||
/// hardware-PCM allowlist** — `api.alsa.pcm.sink`, `api.alsa.pcm.source`,
|
||||
/// and the equivalent for other real backends (bluez5, v4l2 for the
|
||||
/// media case) as phase 3 enumerates them — never a filter, loopback,
|
||||
/// or `support.null-audio-sink` factory. An allowlist, not a
|
||||
/// substring or a denylist: an unknown factory is not a device.
|
||||
/// Measured discriminator on the
|
||||
/// target box: the five ALSA nodes carry `device.api=alsa` +
|
||||
/// `factory.name=api.alsa.pcm.*` and share `client.id=42`
|
||||
/// (`WirePlumber [export]`); the three `support.null-audio-sink` nodes
|
||||
/// carry neither. (`node.physical` was measured **null** on the ALSA
|
||||
/// nodes here, so it is *not* a usable discriminator — do not rely on
|
||||
/// it.)
|
||||
/// - **Fail closed: unknown ⇒ `false`.** A node that cannot be
|
||||
/// positively classified keeps its owner keys and can trip the
|
||||
/// backstop; both are the safe direction.
|
||||
/// - A node MUST NOT enter a snapshot with this field provisional. If
|
||||
/// the Device backing a node has not yet been bound, withhold the node
|
||||
/// and keep the epoch not-ready — otherwise a provisional `false`
|
||||
/// during not-ready fuses sink and mic on the shared session client
|
||||
/// and that fusion can persist as sticky over-exclusion (round-3
|
||||
/// finding 3).
|
||||
///
|
||||
/// ⚠️ **A false positive is leak-capable — do not treat it as braced.**
|
||||
/// I claimed a mis-classified filter could not leak because its legs
|
||||
/// share a `node.link-group` (strong-key bridge) or trip the unbounded
|
||||
/// backstop. Codex refuted it (round 4): a filter *without* a shared
|
||||
/// strong key, marked `session_device=true`, cannot activate the
|
||||
/// backstop from its reading leg, so a differently-keyed re-emitting leg
|
||||
/// leaks. Those braces catch *some* shapes, not all. The only real
|
||||
/// defence is a correct classifier — hence "positive high-confidence"
|
||||
/// and "fail closed to false" above, without exception.
|
||||
///
|
||||
/// What it is for: every real device node shares the session manager's
|
||||
/// `client.id`, so coarse owner keys must not bridge them — else
|
||||
/// peerspeak's playback (which taints the default sink every recompute)
|
||||
/// would reach the microphone. See [`super::owner`] exception 2.
|
||||
pub session_device: bool,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct NodeSnapshot {
|
||||
pub serial: Serial,
|
||||
pub id: GlobalId,
|
||||
/// `node.name`, for diagnostics and for `pixelpass_capture_*` ancestry
|
||||
/// detection (v3.4 §6.2, cycle prevention).
|
||||
pub name: Option<String>,
|
||||
pub role: MediaRole,
|
||||
pub props: NodeProps,
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
|
||||
pub enum PortDirection {
|
||||
In,
|
||||
Out,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct PortSnapshot {
|
||||
pub serial: Serial,
|
||||
pub id: GlobalId,
|
||||
/// Owning node, by snapshot-local id.
|
||||
pub node: GlobalId,
|
||||
pub direction: PortDirection,
|
||||
/// `port.exclusive` — fan-out will be refused (v3.4 §6.2).
|
||||
pub exclusive: bool,
|
||||
/// `port.monitor`. Recorded for phase 6 link creation; taint does not
|
||||
/// need it at node granularity.
|
||||
pub monitor: bool,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct LinkSnapshot {
|
||||
pub serial: Serial,
|
||||
pub id: GlobalId,
|
||||
/// `link.output.node` — the node audio flows **from**.
|
||||
pub output_node: GlobalId,
|
||||
/// `link.input.node` — the node audio flows **to**.
|
||||
pub input_node: GlobalId,
|
||||
pub output_port: Option<GlobalId>,
|
||||
pub input_port: Option<GlobalId>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct ClientSnapshot {
|
||||
pub serial: Serial,
|
||||
pub id: GlobalId,
|
||||
/// `pipewire.sec.pid` — for Pulse-emulated clients this is
|
||||
/// **pipewire-pulse's** PID, identical across every unrelated app
|
||||
/// (v3.4 §5.2 correction 5). Phase 3 derives the daemon PID from the
|
||||
/// consistency of this value; the engine only consumes the result.
|
||||
pub sec_pid: Option<u32>,
|
||||
}
|
||||
|
||||
/// How a snapshot-local id resolves.
|
||||
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
|
||||
pub enum IdLookup {
|
||||
Unique(Serial),
|
||||
/// Two live objects in one snapshot claim the same global id — the
|
||||
/// observer missed a removal, so the recycled id is ambiguous. Every
|
||||
/// edge touching it is treated as unresolved, i.e. fail closed.
|
||||
Ambiguous,
|
||||
}
|
||||
|
||||
/// One coherent observation of the graph.
|
||||
///
|
||||
/// Built through [`GraphSnapshot::new`] so the id indexes and the ambiguity
|
||||
/// detection cannot be skipped.
|
||||
#[derive(Clone, Debug, Default, PartialEq, Eq)]
|
||||
pub struct GraphSnapshot {
|
||||
nodes: BTreeMap<Serial, NodeSnapshot>,
|
||||
ports: BTreeMap<Serial, PortSnapshot>,
|
||||
links: BTreeMap<Serial, LinkSnapshot>,
|
||||
clients: BTreeMap<Serial, ClientSnapshot>,
|
||||
node_ids: BTreeMap<GlobalId, IdLookup>,
|
||||
client_ids: BTreeMap<GlobalId, IdLookup>,
|
||||
}
|
||||
|
||||
impl GraphSnapshot {
|
||||
pub fn new(
|
||||
nodes: Vec<NodeSnapshot>,
|
||||
ports: Vec<PortSnapshot>,
|
||||
links: Vec<LinkSnapshot>,
|
||||
clients: Vec<ClientSnapshot>,
|
||||
) -> Self {
|
||||
let node_ids = index_ids(nodes.iter().map(|n| (n.id, n.serial)));
|
||||
let client_ids = index_ids(clients.iter().map(|c| (c.id, c.serial)));
|
||||
Self {
|
||||
nodes: nodes.into_iter().map(|n| (n.serial, n)).collect(),
|
||||
ports: ports.into_iter().map(|p| (p.serial, p)).collect(),
|
||||
links: links.into_iter().map(|l| (l.serial, l)).collect(),
|
||||
clients: clients.into_iter().map(|c| (c.serial, c)).collect(),
|
||||
node_ids,
|
||||
client_ids,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn nodes(&self) -> impl Iterator<Item = &NodeSnapshot> {
|
||||
self.nodes.values()
|
||||
}
|
||||
|
||||
pub fn node(&self, serial: Serial) -> Option<&NodeSnapshot> {
|
||||
self.nodes.get(&serial)
|
||||
}
|
||||
|
||||
pub fn links(&self) -> impl Iterator<Item = &LinkSnapshot> {
|
||||
self.links.values()
|
||||
}
|
||||
|
||||
pub fn ports(&self) -> impl Iterator<Item = &PortSnapshot> {
|
||||
self.ports.values()
|
||||
}
|
||||
|
||||
pub fn clients(&self) -> impl Iterator<Item = &ClientSnapshot> {
|
||||
self.clients.values()
|
||||
}
|
||||
|
||||
/// Resolve a snapshot-local node id. `None` means "no such node in this
|
||||
/// snapshot", which for a link endpoint means unresolved ancestry.
|
||||
pub fn node_by_id(&self, id: GlobalId) -> Option<IdLookup> {
|
||||
self.node_ids.get(&id).copied()
|
||||
}
|
||||
|
||||
pub fn client_by_id(&self, id: GlobalId) -> Option<IdLookup> {
|
||||
self.client_ids.get(&id).copied()
|
||||
}
|
||||
|
||||
/// Every node claiming a global id. More than one means the id is
|
||||
/// [`IdLookup::Ambiguous`] and each claimant must be treated as a
|
||||
/// possible endpoint of any link naming it.
|
||||
pub fn nodes_with_id(&self, id: GlobalId) -> impl Iterator<Item = &NodeSnapshot> {
|
||||
self.nodes.values().filter(move |node| node.id == id)
|
||||
}
|
||||
|
||||
/// Every client claiming a global id — same fail-closed reasoning.
|
||||
pub fn clients_with_id(&self, id: GlobalId) -> impl Iterator<Item = &ClientSnapshot> {
|
||||
self.clients.values().filter(move |client| client.id == id)
|
||||
}
|
||||
|
||||
/// Ports belonging to a node, by the node's snapshot-local id.
|
||||
pub fn ports_of(&self, node: GlobalId) -> impl Iterator<Item = &PortSnapshot> {
|
||||
self.ports.values().filter(move |p| p.node == node)
|
||||
}
|
||||
}
|
||||
|
||||
fn index_ids(entries: impl Iterator<Item = (GlobalId, Serial)>) -> BTreeMap<GlobalId, IdLookup> {
|
||||
let mut out: BTreeMap<GlobalId, IdLookup> = BTreeMap::new();
|
||||
for (id, serial) in entries {
|
||||
out.entry(id)
|
||||
.and_modify(|slot| {
|
||||
if *slot != IdLookup::Unique(serial) {
|
||||
*slot = IdLookup::Ambiguous;
|
||||
}
|
||||
})
|
||||
.or_insert(IdLookup::Unique(serial));
|
||||
}
|
||||
out
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user