Merge fix/bind-app-surfaces-to-sessions: bind each app session's Wayland client to its session through appd (#18)

This commit is contained in:
Marco Allegretti 2026-10-10 09:23:18 +02:00 committed by GitHub
commit ff6ecacbb6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 1000 additions and 137 deletions

2
Cargo.lock generated
View file

@ -10473,6 +10473,7 @@ dependencies = [
"futures-util", "futures-util",
"libc", "libc",
"rmp-serde", "rmp-serde",
"rustix 1.1.4",
"sd-notify", "sd-notify",
"serde", "serde",
"serde_json", "serde_json",
@ -10494,6 +10495,7 @@ version = "0.1.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"bitflags 2.11.0", "bitflags 2.11.0",
"rustix 1.1.4",
"sd-notify", "sd-notify",
"smithay", "smithay",
"smithay-drm-extras", "smithay-drm-extras",

View file

@ -21,6 +21,7 @@ futures-util = { version = "0.3", default-features = false, features = ["sink",
tracing = "0.1" tracing = "0.1"
tracing-subscriber = { version = "0.3", features = ["env-filter"] } tracing-subscriber = { version = "0.3", features = ["env-filter"] }
libc = "0.2" libc = "0.2"
rustix = { version = "1", features = ["net"] }
[target.'cfg(unix)'.dependencies] [target.'cfg(unix)'.dependencies]
sd-notify = "0.4" sd-notify = "0.4"

View file

@ -1,4 +1,7 @@
use std::os::fd::OwnedFd;
use std::path::PathBuf; use std::path::PathBuf;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use tokio::io::AsyncWriteExt; use tokio::io::AsyncWriteExt;
use tokio::sync::mpsc; use tokio::sync::mpsc;
@ -6,7 +9,39 @@ use weft_ipc_types::{
AppdToCompositor, CompositorToAppd, MAX_FRAME_LEN, frame_decode, frame_encode, AppdToCompositor, CompositorToAppd, MAX_FRAME_LEN, frame_decode, frame_encode,
}; };
pub type CompositorSender = mpsc::Sender<AppdToCompositor>; /// A message for the compositor and the file descriptor it carries, if any.
pub struct Outbound {
pub msg: AppdToCompositor,
pub fd: Option<OwnedFd>,
}
impl From<AppdToCompositor> for Outbound {
fn from(msg: AppdToCompositor) -> Self {
Self { msg, fd: None }
}
}
/// Queues messages for the compositor and tells whether it is connected.
#[derive(Clone)]
pub struct CompositorSender {
tx: mpsc::Sender<Outbound>,
connected: Arc<AtomicBool>,
}
impl CompositorSender {
pub fn new(tx: mpsc::Sender<Outbound>, connected: Arc<AtomicBool>) -> Self {
Self { tx, connected }
}
/// Whether the compositor IPC connection is currently up.
pub fn is_connected(&self) -> bool {
self.connected.load(Ordering::Acquire)
}
pub fn try_send(&self, outbound: Outbound) -> Result<(), Outbound> {
self.tx.try_send(outbound).map_err(|e| e.into_inner())
}
}
/// Resolve the compositor IPC socket path. /// Resolve the compositor IPC socket path.
/// ///
@ -24,17 +59,24 @@ pub fn socket_path() -> Option<PathBuf> {
/// Spawn the compositor IPC client task and return a sender for outbound messages. /// Spawn the compositor IPC client task and return a sender for outbound messages.
/// ///
/// The task connects to `socket_path`, retrying every 2 s on failure. If the /// The task connects to `socket_path`, retrying every 2 s on failure. When
/// connection drops while sending, it waits 500 ms then reconnects. Incoming /// the connection drops, whether noticed by a failed write or by the
/// `CompositorToAppd` frames are decoded and logged; no behavioural action is /// compositor closing it, it waits 500 ms and reconnects; a message whose
/// taken yet (surface lifecycle hookup happens in a later task). /// write failed is sent again on the new connection. Incoming
/// `CompositorToAppd` frames are decoded and logged.
pub fn spawn(socket_path: PathBuf) -> CompositorSender { pub fn spawn(socket_path: PathBuf) -> CompositorSender {
let (tx, rx) = mpsc::channel::<AppdToCompositor>(32); let (tx, rx) = mpsc::channel::<Outbound>(32);
tokio::spawn(run_client(socket_path, rx)); let connected = Arc::new(AtomicBool::new(false));
tx tokio::spawn(run_client(socket_path, rx, connected.clone()));
CompositorSender::new(tx, connected)
} }
async fn run_client(socket_path: PathBuf, mut rx: mpsc::Receiver<AppdToCompositor>) { async fn run_client(
socket_path: PathBuf,
mut rx: mpsc::Receiver<Outbound>,
connected: Arc<AtomicBool>,
) {
let mut unsent: Option<Outbound> = None;
loop { loop {
let stream = loop { let stream = loop {
match tokio::net::UnixStream::connect(&socket_path).await { match tokio::net::UnixStream::connect(&socket_path).await {
@ -49,28 +91,85 @@ async fn run_client(socket_path: PathBuf, mut rx: mpsc::Receiver<AppdToComposito
}; };
let (read_half, mut write_half) = stream.into_split(); let (read_half, mut write_half) = stream.into_split();
let mut reader = tokio::spawn(read_unix_incoming(read_half));
tokio::spawn(read_unix_incoming(read_half)); connected.store(true, Ordering::Release);
loop { loop {
let Some(msg) = rx.recv().await else { let outbound = match unsent.take() {
return; Some(outbound) => outbound,
}; None => tokio::select! {
match frame_encode(&msg) { next = rx.recv() => match next {
Ok(frame) => { Some(outbound) => outbound,
if write_half.write_all(&frame).await.is_err() { None => return,
tracing::warn!("compositor IPC write failed; reconnecting"); },
_ = &mut reader => {
tracing::warn!("compositor closed the IPC connection; reconnecting");
break; break;
} }
},
};
let frame = match frame_encode(&outbound.msg) {
Ok(frame) => frame,
Err(e) => {
tracing::warn!(?e, "compositor IPC encode error");
continue;
} }
Err(e) => tracing::warn!(?e, "compositor IPC encode error"), };
if send_frame(&mut write_half, &frame, outbound.fd.as_ref())
.await
.is_err()
{
tracing::warn!("compositor IPC write failed; reconnecting");
unsent = Some(outbound);
break;
} }
} }
connected.store(false, Ordering::Release);
reader.abort();
tokio::time::sleep(tokio::time::Duration::from_millis(500)).await; tokio::time::sleep(tokio::time::Duration::from_millis(500)).await;
} }
} }
/// Writes `frame`, attaching `fd` to its first bytes so the compositor
/// receives the descriptor together with the message it belongs to.
async fn send_frame(
stream: &mut tokio::net::unix::OwnedWriteHalf,
frame: &[u8],
fd: Option<&OwnedFd>,
) -> std::io::Result<()> {
use rustix::net::{SendAncillaryBuffer, SendAncillaryMessage, SendFlags, sendmsg};
use std::mem::MaybeUninit;
use std::os::fd::AsFd;
let Some(fd) = fd else {
return stream.write_all(frame).await;
};
let socket: &tokio::net::UnixStream = stream.as_ref();
let sent = loop {
socket.writable().await?;
let result = socket.try_io(tokio::io::Interest::WRITABLE, || {
let mut space = [MaybeUninit::uninit(); rustix::cmsg_space!(ScmRights(1))];
let mut control = SendAncillaryBuffer::new(&mut space);
let fds = [fd.as_fd()];
control.push(SendAncillaryMessage::ScmRights(&fds));
sendmsg(
socket,
&[std::io::IoSlice::new(frame)],
&mut control,
SendFlags::NOSIGNAL,
)
.map_err(std::io::Error::from)
});
match result {
Err(e) if e.kind() == std::io::ErrorKind::WouldBlock => continue,
other => break other?,
}
};
// The descriptor travelled with the first bytes; the rest of a partly
// sent frame follows as plain data.
stream.write_all(&frame[sent..]).await
}
async fn read_unix_incoming(mut reader: tokio::net::unix::OwnedReadHalf) { async fn read_unix_incoming(mut reader: tokio::net::unix::OwnedReadHalf) {
use tokio::io::AsyncReadExt; use tokio::io::AsyncReadExt;
@ -110,8 +209,8 @@ fn handle_incoming(msg: CompositorToAppd) {
CompositorToAppd::SurfaceReady { session_id } => { CompositorToAppd::SurfaceReady { session_id } => {
tracing::debug!(session_id, "SurfaceReady from compositor"); tracing::debug!(session_id, "SurfaceReady from compositor");
} }
CompositorToAppd::ClientDisconnected { pid } => { CompositorToAppd::ClientDisconnected { session_id } => {
tracing::debug!(pid, "ClientDisconnected from compositor"); tracing::debug!(session_id, "ClientDisconnected from compositor");
} }
} }
} }

View file

@ -8,15 +8,7 @@ use anyhow::Context;
use tokio::io::AsyncWriteExt; use tokio::io::AsyncWriteExt;
use tokio::sync::Mutex; use tokio::sync::Mutex;
#[cfg(unix)]
mod compositor_client; mod compositor_client;
#[cfg(not(unix))]
mod compositor_client {
use tokio::sync::mpsc;
use weft_ipc_types::AppdToCompositor;
pub type CompositorSender = mpsc::Sender<AppdToCompositor>;
}
mod grants; mod grants;
mod ipc; mod ipc;
mod launch; mod launch;
@ -225,19 +217,35 @@ async fn run() -> anyhow::Result<()> {
let _ = sd_notify::notify(false, &[sd_notify::NotifyState::Ready]); let _ = sd_notify::notify(false, &[sd_notify::NotifyState::Ready]);
} }
if let Some(app_ids) = load_session() { // Restoring runs beside the request loops, so waiting for the
tracing::info!(count = app_ids.len(), "restoring previous session"); // compositor delays neither clients nor shutdown. Until it finishes,
for app_id in app_ids { // the restored list is what a shutdown saves.
let _ = dispatch( let restore = load_session().map(|app_ids| {
crate::ipc::Request::LaunchApp { let saved = app_ids.clone();
app_id, let registry = Arc::clone(&registry);
surface_id: 0, let task = tokio::spawn(async move {
}, // Apps need the compositor connection; give it a moment.
&registry, let compositor = registry.lock().await.compositor_tx.clone();
) if let Some(compositor) = compositor {
.await; let deadline = tokio::time::Instant::now() + std::time::Duration::from_secs(10);
} while !compositor.is_connected() && tokio::time::Instant::now() < deadline {
} tokio::time::sleep(std::time::Duration::from_millis(100)).await;
}
}
tracing::info!(count = app_ids.len(), "restoring previous session");
for app_id in app_ids {
let _ = dispatch(
crate::ipc::Request::LaunchApp {
app_id,
surface_id: 0,
},
&registry,
)
.await;
}
});
(task, saved)
});
#[cfg(unix)] #[cfg(unix)]
let mut sigterm = { let mut sigterm = {
@ -283,7 +291,14 @@ async fn run() -> anyhow::Result<()> {
} }
} }
save_session(registry.lock().await.running_app_ids()).await; let app_ids = match restore {
Some((task, saved)) if !task.is_finished() => {
task.abort();
saved
}
_ => registry.lock().await.running_app_ids(),
};
save_session(app_ids).await;
registry.lock().await.shutdown_all(); registry.lock().await.shutdown_all();
tokio::time::sleep(tokio::time::Duration::from_millis(200)).await; tokio::time::sleep(tokio::time::Duration::from_millis(200)).await;
let _ = std::fs::remove_file(&socket_path); let _ = std::fs::remove_file(&socket_path);
@ -446,8 +461,20 @@ pub(crate) async fn dispatch(req: Request, registry: &Registry) -> Response {
// The package is resolved and its capabilities granted before a // The package is resolved and its capabilities granted before a
// session exists; a package this host cannot satisfy is refused, // session exists; a package this host cannot satisfy is refused,
// not started. // not started.
let compositor_down = registry
.lock()
.await
.compositor_tx
.as_ref()
.is_some_and(|tx| !tx.is_connected());
let launch = if !weft_ipc_types::package::is_valid_app_id(&app_id) { let launch = if !weft_ipc_types::package::is_valid_app_id(&app_id) {
Err(grants::Refusal::new(400, "invalid app ID")) Err(grants::Refusal::new(400, "invalid app ID"))
} else if compositor_down {
// An app started now could never show a window.
Err(grants::Refusal::new(
503,
"weft-compositor is not connected",
))
} else if std::env::var("WEFT_RUNTIME_BIN").is_ok() { } else if std::env::var("WEFT_RUNTIME_BIN").is_ok() {
resolve_launch(app_id.clone()).await.map(Some) resolve_launch(app_id.clone()).await.map(Some)
} else { } else {
@ -1390,6 +1417,191 @@ mod tests {
assert!(!session_ipc_socket_path(session_id).unwrap().exists()); assert!(!session_ipc_socket_path(session_id).unwrap().exists());
} }
#[tokio::test(flavor = "current_thread")]
async fn without_a_connected_compositor_nothing_is_started() {
use std::os::unix::fs::PermissionsExt;
let _env = env_lock().lock().await;
use_test_runtime_dir();
let dir = std::env::temp_dir().join(format!("weft_test_nocomp_{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
let app = dir.join("store/org.example.nocomp");
write_test_package(&app, "org.example.nocomp", "");
// Each child records that it started.
let log = dir.join("started.log");
let child = dir.join("child.sh");
std::fs::write(
&child,
format!(
"#!/bin/sh\necho started >> '{}'\necho READY $WEFT_READY_TOKEN\nexec sleep 1\n",
log.display()
),
)
.unwrap();
std::fs::set_permissions(&child, std::fs::Permissions::from_mode(0o755)).unwrap();
let vars = [
("WEFT_RUNTIME_BIN", child.clone().into_os_string()),
("WEFT_APP_SHELL_BIN", child.clone().into_os_string()),
("WEFT_DISABLE_CGROUP", "1".into()),
("WEFT_APP_STORE", dir.join("store").into_os_string()),
];
let prior: Vec<_> = vars
.iter()
.map(|(k, _)| (*k, std::env::var_os(k)))
.collect();
for (key, value) in &vars {
// SAFETY: env_lock is held on a current_thread runtime.
unsafe { std::env::set_var(key, value) };
}
let registry = make_registry();
let (tx, mut compositor) = tokio::sync::mpsc::channel(8);
registry.lock().await.compositor_tx = Some(compositor_client::CompositorSender::new(
tx,
std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false)),
));
let refused = dispatch(
Request::LaunchApp {
app_id: "org.example.nocomp".into(),
surface_id: 0,
},
&registry,
)
.await;
tokio::time::sleep(std::time::Duration::from_millis(500)).await;
let started = std::fs::read_to_string(&log).unwrap_or_default();
for (key, value) in prior {
// SAFETY: as above.
unsafe {
match value {
Some(v) => std::env::set_var(key, v),
None => std::env::remove_var(key),
}
}
}
let _ = std::fs::remove_dir_all(&dir);
assert!(
matches!(refused, Response::Error { code: 503, .. }),
"{refused:?}"
);
// Nothing started and nothing was queued for the compositor.
assert_eq!(started, "");
assert!(compositor.try_recv().is_err());
}
#[tokio::test(flavor = "current_thread")]
async fn the_app_shell_connects_only_through_its_session_connection() {
use std::io::BufRead;
use std::os::unix::fs::PermissionsExt;
let _env = env_lock().lock().await;
use_test_runtime_dir();
let dir = std::env::temp_dir().join(format!("weft_test_attach_{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
let app = dir.join("store/org.example.attach");
write_test_package(&app, "org.example.attach", "");
// Each child writes its Wayland environment to its standard input,
// which only the app shell has connected to anything.
let child = dir.join("child.sh");
std::fs::write(
&child,
"#!/bin/sh\nprintf '%s %s\\n' \"${WAYLAND_SOCKET-unset}\" \
\"${WAYLAND_DISPLAY-unset}\" >&0 2>/dev/null\n\
echo READY $WEFT_READY_TOKEN\nexec sleep 1\n",
)
.unwrap();
std::fs::set_permissions(&child, std::fs::Permissions::from_mode(0o755)).unwrap();
let vars = [
("WEFT_RUNTIME_BIN", child.clone().into_os_string()),
("WEFT_APP_SHELL_BIN", child.clone().into_os_string()),
("WEFT_DISABLE_CGROUP", "1".into()),
("WEFT_APP_STORE", dir.join("store").into_os_string()),
("WAYLAND_DISPLAY", "wayland-ambient".into()),
];
let prior: Vec<_> = vars
.iter()
.map(|(k, _)| (*k, std::env::var_os(k)))
.collect();
for (key, value) in &vars {
// SAFETY: env_lock is held on a current_thread runtime.
unsafe { std::env::set_var(key, value) };
}
let registry = make_registry();
let (tx, mut compositor) = tokio::sync::mpsc::channel(8);
registry.lock().await.compositor_tx = Some(compositor_client::CompositorSender::new(
tx,
std::sync::Arc::new(std::sync::atomic::AtomicBool::new(true)),
));
let mut rx = registry.lock().await.subscribe();
let ack = dispatch(
Request::LaunchApp {
app_id: "org.example.attach".into(),
surface_id: 0,
},
&registry,
)
.await;
let attached = tokio::time::timeout(std::time::Duration::from_secs(10), compositor.recv())
.await
.ok()
.flatten();
let stopped = tokio::time::timeout(std::time::Duration::from_secs(10), async {
while !matches!(
rx.recv().await,
Ok(Response::AppState {
state: AppStateKind::Stopped,
..
})
) {}
})
.await;
let released = compositor.try_recv().ok().map(|out| out.msg);
for (key, value) in prior {
// SAFETY: as above.
unsafe {
match value {
Some(v) => std::env::set_var(key, v),
None => std::env::remove_var(key),
}
}
}
let _ = std::fs::remove_dir_all(&dir);
let Response::LaunchAck { session_id, .. } = ack else {
panic!("{ack:?}");
};
assert!(stopped.is_ok(), "session did not stop");
let attached = attached.expect("no connection was handed to the compositor");
assert!(
matches!(
&attached.msg,
weft_ipc_types::AppdToCompositor::AttachClient { session_id: s, app_id }
if *s == session_id && app_id == "org.example.attach"
),
"{:?}",
attached.msg
);
// The compositor's end reaches the app shell, which sees only
// WAYLAND_SOCKET and no display to connect to instead.
let stream = std::os::unix::net::UnixStream::from(attached.fd.expect("no descriptor"));
stream
.set_read_timeout(Some(std::time::Duration::from_secs(5)))
.unwrap();
let mut line = String::new();
std::io::BufReader::new(stream)
.read_line(&mut line)
.unwrap();
assert_eq!(line.trim(), "0 unset");
assert!(
matches!(
released,
Some(weft_ipc_types::AppdToCompositor::AppSurfaceDestroyed { session_id: s })
if s == session_id
),
"{released:?}"
);
}
#[tokio::test(flavor = "current_thread")] #[tokio::test(flavor = "current_thread")]
async fn children_receive_the_resolved_package_files() { async fn children_receive_the_resolved_package_files() {
use std::os::unix::fs::PermissionsExt; use std::os::unix::fs::PermissionsExt;

View file

@ -191,8 +191,26 @@ fn spawn_app_shell(
package: &LaunchPackage, package: &LaunchPackage,
token: &str, token: &str,
bridge_token: Option<String>, bridge_token: Option<String>,
wayland: Option<std::os::unix::net::UnixStream>,
) -> std::io::Result<tokio::process::Child> { ) -> std::io::Result<tokio::process::Child> {
let mut command = tokio::process::Command::new(bin); let mut command = tokio::process::Command::new(bin);
match wayland {
// The app shell's only Wayland connection is the one created for its
// session, handed over as its standard input: WAYLAND_SOCKET names
// that descriptor, and no display socket is offered to connect
// anywhere else. Only this child receives the descriptor.
Some(stream) => {
command
.stdin(std::process::Stdio::from(std::os::fd::OwnedFd::from(
stream,
)))
.env("WAYLAND_SOCKET", "0")
.env_remove("WAYLAND_DISPLAY");
}
None => {
command.stdin(std::process::Stdio::null());
}
}
if let Some(bridge_token) = bridge_token { if let Some(bridge_token) = bridge_token {
// The page holds this credential; it must differ from the readiness // The page holds this credential; it must differ from the readiness
// token, which page output could otherwise use to fake readiness. // token, which page output could otherwise use to fake readiness.
@ -204,7 +222,6 @@ fn spawn_app_shell(
.arg("--ui") .arg("--ui")
.arg(&package.ui_entry) .arg(&package.ui_entry)
.env(READY_TOKEN_ENV, token) .env(READY_TOKEN_ENV, token)
.stdin(std::process::Stdio::null())
.stdout(std::process::Stdio::piped()) .stdout(std::process::Stdio::piped())
.stderr(std::process::Stdio::piped()) .stderr(std::process::Stdio::piped())
.kill_on_drop(true) .kill_on_drop(true)
@ -330,7 +347,7 @@ pub(crate) async fn supervise(
relay: Some(relay), relay: Some(relay),
image, image,
compositor_tx, compositor_tx,
surface_announced: false, client_attached: false,
}; };
let mut runtime = match cmd.spawn() { let mut runtime = match cmd.spawn() {
@ -341,23 +358,6 @@ pub(crate) async fn supervise(
.await; .await;
} }
}; };
if let Some(tx) = &session.compositor_tx {
let pid = runtime.id().unwrap_or(0);
// A full queue (compositor disconnected) must not stall the session.
session.surface_announced = tx
.try_send(AppdToCompositor::AppSurfaceCreated {
app_id: app_id.to_owned(),
session_id,
pid,
})
.is_ok();
if !session.surface_announced {
tracing::warn!(
session_id,
"compositor queue unavailable; surface not announced"
);
}
}
let runtime_stdout = runtime.stdout.take().expect("stdout piped"); let runtime_stdout = runtime.stdout.take().expect("stdout piped");
tokio::spawn(drain_stderr( tokio::spawn(drain_stderr(
runtime.stderr.take().expect("stderr piped"), runtime.stderr.take().expect("stderr piped"),
@ -377,16 +377,35 @@ pub(crate) async fn supervise(
}; };
tokio::spawn(drain_stdout(runtime_stdout, session_id)); tokio::spawn(drain_stdout(runtime_stdout, session_id));
let bridge_token = registry.lock().await.bridge_token(session_id); // With a compositor, the app shell connects only through a connection
let mut app_shell = // the compositor received for this session, so every surface it creates
match spawn_app_shell(&shell_bin, session_id, &package, &token, bridge_token) { // is bound to the session.
Ok(child) => child, let wayland = match &session.compositor_tx {
Err(e) => { None => None,
return session Some(tx) => match attach_client(tx, session_id, app_id) {
.settle(&registry, &format!("failed to spawn app shell: {e}")) Ok(stream) => {
.await; session.client_attached = true;
Some(stream)
} }
}; Err(reason) => return session.settle(&registry, &reason).await,
},
};
let bridge_token = registry.lock().await.bridge_token(session_id);
let mut app_shell = match spawn_app_shell(
&shell_bin,
session_id,
&package,
&token,
bridge_token,
wayland,
) {
Ok(child) => child,
Err(e) => {
return session
.settle(&registry, &format!("failed to spawn app shell: {e}"))
.await;
}
};
let shell_stdout = app_shell.stdout.take().expect("stdout piped"); let shell_stdout = app_shell.stdout.take().expect("stdout piped");
tokio::spawn(drain_stderr( tokio::spawn(drain_stderr(
app_shell.stderr.take().expect("stderr piped"), app_shell.stderr.take().expect("stderr piped"),
@ -438,6 +457,29 @@ pub(crate) async fn supervise(
session.settle(&registry, &reason).await session.settle(&registry, &reason).await
} }
/// Creates the session's Wayland connection and queues the compositor's end
/// for the compositor, returning the app shell's end.
fn attach_client(
tx: &CompositorSender,
session_id: u64,
app_id: &str,
) -> Result<std::os::unix::net::UnixStream, String> {
if !tx.is_connected() {
return Err("weft-compositor is not connected, so the app cannot show a window".to_owned());
}
let (shell, compositor) = std::os::unix::net::UnixStream::pair()
.map_err(|e| format!("cannot create the app's Wayland connection: {e}"))?;
tx.try_send(crate::compositor_client::Outbound {
msg: AppdToCompositor::AttachClient {
session_id,
app_id: app_id.to_owned(),
},
fd: Some(compositor.into()),
})
.map_err(|_| "the compositor connection is not available".to_owned())?;
Ok(shell)
}
/// Marks a session that never started any process as stopped. /// Marks a session that never started any process as stopped.
async fn stop_unstarted( async fn stop_unstarted(
registry: &Registry, registry: &Registry,
@ -467,7 +509,8 @@ struct OwnedSession {
/// The mounted package image, released after both children have exited. /// The mounted package image, released after both children have exited.
image: Option<Mount>, image: Option<Mount>,
compositor_tx: Option<CompositorSender>, compositor_tx: Option<CompositorSender>,
surface_announced: bool, /// Whether the compositor was given this session's client connection.
client_attached: bool,
} }
impl OwnedSession { impl OwnedSession {
@ -476,10 +519,10 @@ impl OwnedSession {
tracing::info!(session_id, reason, "stopping session"); tracing::info!(session_id, reason, "stopping session");
kill_child(self.app_shell).await; kill_child(self.app_shell).await;
kill_child(self.runtime).await; kill_child(self.runtime).await;
if self.surface_announced if self.client_attached
&& let Some(tx) = &self.compositor_tx && let Some(tx) = &self.compositor_tx
&& tx && tx
.try_send(AppdToCompositor::AppSurfaceDestroyed { session_id }) .try_send(AppdToCompositor::AppSurfaceDestroyed { session_id }.into())
.is_err() .is_err()
{ {
tracing::warn!( tracing::warn!(

View file

@ -26,6 +26,7 @@ wayland-scanner = "0.31"
wayland-server = "0.31" wayland-server = "0.31"
wayland-backend = "0.3" wayland-backend = "0.3"
bitflags = "2" bitflags = "2"
rustix = { version = "1", features = ["net"] }
# DRM/KMS and hardware input depend on Linux kernel interfaces; compile only on Linux. # DRM/KMS and hardware input depend on Linux kernel interfaces; compile only on Linux.
[target.'cfg(target_os = "linux")'.dependencies] [target.'cfg(target_os = "linux")'.dependencies]

View file

@ -1,13 +1,21 @@
#[cfg(unix)] #[cfg(unix)]
use std::{ use std::{
collections::HashMap, collections::{HashMap, HashSet, VecDeque},
io::{self, Read, Write}, io,
os::fd::OwnedFd,
os::unix::net::{UnixListener, UnixStream}, os::unix::net::{UnixListener, UnixStream},
path::PathBuf, path::PathBuf,
sync::Arc,
}; };
#[cfg(unix)] #[cfg(unix)]
use smithay::reexports::calloop::{Interest, Mode, PostAction, generic::Generic}; use smithay::reexports::calloop::{
Interest, LoopHandle, Mode, PostAction, RegistrationToken, channel,
generic::Generic,
timer::{TimeoutAction, Timer},
};
#[cfg(unix)]
use smithay::reexports::wayland_server::backend::{ClientId, DisconnectReason};
#[cfg(unix)] #[cfg(unix)]
use weft_ipc_types::{ use weft_ipc_types::{
@ -15,15 +23,37 @@ use weft_ipc_types::{
}; };
#[cfg(unix)] #[cfg(unix)]
use crate::state::WeftCompositorState; use crate::state::{SessionBinding, WeftClientState, WeftCompositorState};
/// Descriptors received ahead of the messages that claim them; more than
/// this means the peer is not following the protocol.
#[cfg(unix)]
const MAX_PENDING_FDS: usize = 16;
#[cfg(unix)] #[cfg(unix)]
pub struct WeftAppdIpc { pub struct WeftAppdIpc {
pub socket_path: PathBuf, pub socket_path: PathBuf,
read_buf: Vec<u8>, read_buf: Vec<u8>,
write_stream: Option<UnixStream>, write_stream: Option<UnixStream>,
/// pid → (app_id, session_id) for Wayland clients whose surface has not yet arrived. /// Whether an appd connection's read source is registered. Only one
pub pending_pids: HashMap<u32, (String, u64)>, /// connection is served at a time.
connected: bool,
/// Descriptors received with appd messages, in arrival order. Each
/// `AttachClient` frame is sent with exactly one, attached to its first
/// bytes, so it has arrived by the time the frame is decoded.
fds: VecDeque<OwnedFd>,
/// The Wayland client of each appd session.
sessions: HashMap<u64, ClientId>,
/// Sessions whose first toplevel was reported to appd.
reported: HashSet<u64>,
/// Where clients report their session's disconnection.
disconnected: Option<channel::Sender<(u64, ClientId)>>,
/// Bytes for appd that did not fit in the socket buffer, sent before
/// anything else so frames stay whole.
out_buf: Vec<u8>,
/// Retries `flush` while `out_buf` holds bytes; armed only then.
flush_retry: Option<RegistrationToken>,
loop_handle: Option<LoopHandle<'static, WeftCompositorState>>,
} }
#[cfg(unix)] #[cfg(unix)]
@ -33,26 +63,104 @@ impl WeftAppdIpc {
socket_path, socket_path,
read_buf: Vec::new(), read_buf: Vec::new(),
write_stream: None, write_stream: None,
pending_pids: HashMap::new(), connected: false,
fds: VecDeque::new(),
sessions: HashMap::new(),
reported: HashSet::new(),
disconnected: None,
out_buf: Vec::new(),
flush_retry: None,
loop_handle: None,
} }
} }
#[allow(dead_code)]
pub fn send(&mut self, msg: &CompositorToAppd) { pub fn send(&mut self, msg: &CompositorToAppd) {
let Some(stream) = &mut self.write_stream else {
return;
};
match frame_encode(msg) { match frame_encode(msg) {
Ok(frame) => { Ok(frame) => {
if stream.write_all(&frame).is_err() { if self.write_stream.is_some() {
self.write_stream = None; self.out_buf.extend_from_slice(&frame);
self.flush();
self.schedule_flush();
} }
} }
Err(e) => tracing::warn!(?e, "failed to encode compositor IPC message"), Err(e) => tracing::warn!(?e, "failed to encode compositor IPC message"),
} }
} }
fn try_decode_frames(&mut self) -> Vec<AppdToCompositor> { /// Writes what appd's socket accepts now; the rest waits for the next
/// send or read. A backlog appd never drains, or a write error, ends the
/// connection, whose read side then cleans up.
fn flush(&mut self) {
use std::io::Write;
let Some(stream) = &mut self.write_stream else {
self.out_buf.clear();
return;
};
while !self.out_buf.is_empty() {
match stream.write(&self.out_buf) {
Ok(0) => break,
Ok(n) => {
self.out_buf.drain(..n);
}
Err(e) if e.kind() == io::ErrorKind::WouldBlock => break,
Err(e) if e.kind() == io::ErrorKind::Interrupted => {}
Err(e) => {
tracing::warn!(
?e,
"compositor IPC write failed; closing the appd connection"
);
let _ = stream.shutdown(std::net::Shutdown::Both);
self.write_stream = None;
self.out_buf.clear();
return;
}
}
}
if self.out_buf.len() > MAX_FRAME_LEN {
tracing::warn!("weft-appd is not reading compositor IPC; closing the connection");
let _ = stream.shutdown(std::net::Shutdown::Both);
self.write_stream = None;
self.out_buf.clear();
}
}
/// Retries the flush until appd has taken every queued byte, so the
/// last frames of a burst do not wait for unrelated traffic.
fn schedule_flush(&mut self) {
if self.out_buf.is_empty() || self.flush_retry.is_some() {
return;
}
let Some(handle) = &self.loop_handle else {
return;
};
let retry = Timer::from_duration(std::time::Duration::from_millis(20));
self.flush_retry = handle
.insert_source(retry, |_, _, state| {
let Some(ipc) = state.appd_ipc.as_mut() else {
return TimeoutAction::Drop;
};
ipc.flush();
if ipc.out_buf.is_empty() {
ipc.flush_retry = None;
TimeoutAction::Drop
} else {
TimeoutAction::ToDuration(std::time::Duration::from_millis(20))
}
})
.ok();
}
/// Reports a session's first toplevel to appd.
pub fn surface_created(&mut self, session_id: u64) {
if self.sessions.contains_key(&session_id) && self.reported.insert(session_id) {
self.send(&CompositorToAppd::SurfaceReady { session_id });
}
}
/// Decodes the complete frames in the buffer, and reports whether the
/// stream can no longer be trusted: after an oversized or undecodable
/// frame, descriptors could be paired with the wrong messages.
fn try_decode_frames(&mut self) -> (Vec<AppdToCompositor>, bool) {
let mut out = Vec::new(); let mut out = Vec::new();
loop { loop {
if self.read_buf.len() < 4 { if self.read_buf.len() < 4 {
@ -66,9 +174,7 @@ impl WeftAppdIpc {
]) as usize; ]) as usize;
if declared_len > MAX_FRAME_LEN { if declared_len > MAX_FRAME_LEN {
tracing::warn!(declared_len, "appd IPC frame too large; disconnecting"); tracing::warn!(declared_len, "appd IPC frame too large; disconnecting");
self.write_stream = None; return (out, true);
self.read_buf.clear();
break;
} }
if self.read_buf.len() < 4 + declared_len { if self.read_buf.len() < 4 + declared_len {
break; break;
@ -76,24 +182,45 @@ impl WeftAppdIpc {
let frame_end = 4 + declared_len; let frame_end = 4 + declared_len;
match frame_decode::<AppdToCompositor>(&self.read_buf[..frame_end]) { match frame_decode::<AppdToCompositor>(&self.read_buf[..frame_end]) {
Ok(msg) => out.push(msg), Ok(msg) => out.push(msg),
Err(e) => tracing::warn!(?e, "appd IPC frame decode error"), Err(e) => {
tracing::warn!(?e, "appd IPC frame decode error; disconnecting");
return (out, true);
}
} }
self.read_buf.drain(..frame_end); self.read_buf.drain(..frame_end);
} }
out (out, false)
} }
pub fn on_read(&mut self, stream: &mut UnixStream) -> (Vec<AppdToCompositor>, bool) { /// Reads what is available, keeping descriptors that arrive with the
/// data, and returns the complete messages and whether appd hung up.
pub fn on_read(&mut self, stream: &UnixStream) -> (Vec<AppdToCompositor>, bool) {
use rustix::net::{RecvAncillaryBuffer, RecvAncillaryMessage, RecvFlags, recvmsg};
use std::mem::MaybeUninit;
let mut buf = [0u8; 8192]; let mut buf = [0u8; 8192];
let mut eof = false; let mut eof = false;
loop { loop {
match stream.read(&mut buf) { let mut space = [MaybeUninit::uninit(); rustix::cmsg_space!(ScmRights(4))];
Ok(0) => { let mut control = RecvAncillaryBuffer::new(&mut space);
let received = recvmsg(
stream,
&mut [io::IoSliceMut::new(&mut buf)],
&mut control,
RecvFlags::CMSG_CLOEXEC | RecvFlags::DONTWAIT,
);
for message in control.drain() {
if let RecvAncillaryMessage::ScmRights(fds) = message {
self.fds.extend(fds);
}
}
match received {
Ok(msg) if msg.bytes == 0 => {
eof = true; eof = true;
break; break;
} }
Ok(n) => self.read_buf.extend_from_slice(&buf[..n]), Ok(msg) => self.read_buf.extend_from_slice(&buf[..msg.bytes]),
Err(e) if e.kind() == io::ErrorKind::WouldBlock => break, Err(rustix::io::Errno::AGAIN) => break,
Err(rustix::io::Errno::INTR) => continue,
Err(e) => { Err(e) => {
tracing::warn!(?e, "appd IPC stream read error"); tracing::warn!(?e, "appd IPC stream read error");
eof = true; eof = true;
@ -101,30 +228,50 @@ impl WeftAppdIpc {
} }
} }
} }
let messages = self.try_decode_frames(); let (messages, broken) = self.try_decode_frames();
if eof { eof |= broken;
self.write_stream = None; let claimed = messages
self.read_buf.clear(); .iter()
.filter(|m| matches!(m, AppdToCompositor::AttachClient { .. }))
.count();
if self.fds.len().saturating_sub(claimed) > MAX_PENDING_FDS {
tracing::warn!("appd sent descriptors without messages; disconnecting");
eof = true;
} }
(messages, eof) (messages, eof)
} }
/// Forgets the appd connection once its read source is gone. The
/// sessions it started are closed: they belong to that appd.
fn disconnect(&mut self) -> Vec<ClientId> {
self.connected = false;
self.write_stream = None;
self.out_buf.clear();
self.read_buf.clear();
self.fds.clear();
self.reported.clear();
self.sessions.drain().map(|(_, client)| client).collect()
}
} }
#[cfg(unix)] #[cfg(unix)]
fn handle_message(state: &mut WeftCompositorState, msg: AppdToCompositor) { fn handle_message(state: &mut WeftCompositorState, msg: AppdToCompositor) {
match msg { match msg {
AppdToCompositor::AppSurfaceCreated { AppdToCompositor::AttachClient { session_id, app_id } => {
app_id, attach_client(state, session_id, app_id);
session_id,
pid,
} => {
tracing::debug!(app_id, session_id, pid, "AppSurfaceCreated");
if let Some(ipc) = &mut state.appd_ipc {
ipc.pending_pids.insert(pid, (app_id, session_id));
}
} }
AppdToCompositor::AppSurfaceDestroyed { session_id } => { AppdToCompositor::AppSurfaceDestroyed { session_id } => {
tracing::debug!(session_id, "AppSurfaceDestroyed"); let Some(ipc) = state.appd_ipc.as_mut() else {
return;
};
ipc.reported.remove(&session_id);
if let Some(client) = ipc.sessions.remove(&session_id) {
tracing::info!(session_id, "closing the client of an ended session");
state
.display_handle
.backend_handle()
.kill_client(client, DisconnectReason::ConnectionClosed);
}
} }
AppdToCompositor::AppFocusRequest { session_id } => { AppdToCompositor::AppFocusRequest { session_id } => {
tracing::debug!(session_id, "AppFocusRequest"); tracing::debug!(session_id, "AppFocusRequest");
@ -132,6 +279,54 @@ fn handle_message(state: &mut WeftCompositorState, msg: AppdToCompositor) {
} }
} }
/// Makes the descriptor that came with an `AttachClient` message a Wayland
/// client bound to `session_id`.
#[cfg(unix)]
fn attach_client(state: &mut WeftCompositorState, session_id: u64, app_id: String) {
let Some(ipc) = state.appd_ipc.as_mut() else {
return;
};
let Some(fd) = ipc.fds.pop_front() else {
tracing::warn!(
session_id,
"AttachClient arrived without a connection; ignored"
);
return;
};
if !weft_ipc_types::package::is_valid_app_id(&app_id) {
tracing::warn!(session_id, "AttachClient with an invalid app ID; ignored");
return;
}
if ipc.sessions.contains_key(&session_id) {
tracing::warn!(
session_id,
"session already has a client; connection refused"
);
return;
}
let Some(disconnected) = ipc.disconnected.clone() else {
return;
};
let stream = UnixStream::from(fd);
let data = Arc::new(WeftClientState {
session: Some(SessionBinding {
session_id,
app_id: app_id.clone(),
disconnected,
}),
..WeftClientState::default()
});
match state.display_handle.insert_client(stream, data) {
Ok(client) => {
tracing::info!(session_id, %app_id, "client bound to session");
if let Some(ipc) = state.appd_ipc.as_mut() {
ipc.sessions.insert(session_id, client.id());
}
}
Err(e) => tracing::warn!(session_id, ?e, "cannot add the session's client"),
}
}
#[cfg(unix)] #[cfg(unix)]
pub fn compositor_socket_path() -> PathBuf { pub fn compositor_socket_path() -> PathBuf {
if let Ok(p) = std::env::var("WEFT_COMPOSITOR_SOCKET") { if let Ok(p) = std::env::var("WEFT_COMPOSITOR_SOCKET") {
@ -168,6 +363,31 @@ pub fn setup(state: &mut WeftCompositorState) -> anyhow::Result<()> {
tracing::info!(path = %socket_path.display(), "compositor IPC socket open"); tracing::info!(path = %socket_path.display(), "compositor IPC socket open");
if let Some(ipc) = state.appd_ipc.as_mut() {
ipc.loop_handle = Some(state.loop_handle.clone());
}
// Clients bound to a session report their disconnection here.
let (sender, receiver) = channel::channel::<(u64, ClientId)>();
if let Some(ipc) = state.appd_ipc.as_mut() {
ipc.disconnected = Some(sender);
}
state
.loop_handle
.insert_source(receiver, |event, _, state| {
// Only the session's current client: a client closed when its
// appd went away may report after a new appd reused the ID.
if let channel::Event::Msg((session_id, client)) = event
&& let Some(ipc) = state.appd_ipc.as_mut()
&& ipc.sessions.get(&session_id) == Some(&client)
{
ipc.sessions.remove(&session_id);
ipc.reported.remove(&session_id);
tracing::info!(session_id, "session client disconnected");
ipc.send(&CompositorToAppd::ClientDisconnected { session_id });
}
})
.map_err(|e| anyhow::anyhow!("insert session disconnect source: {e}"))?;
let handle = state.loop_handle.clone(); let handle = state.loop_handle.clone();
state state
.loop_handle .loop_handle
@ -177,6 +397,14 @@ pub fn setup(state: &mut WeftCompositorState) -> anyhow::Result<()> {
loop { loop {
match listener.accept() { match listener.accept() {
Ok((stream, _addr)) => { Ok((stream, _addr)) => {
// One appd at a time: a second connection while
// one is live is refused rather than replacing it.
if state.appd_ipc.as_ref().is_some_and(|ipc| ipc.connected) {
tracing::warn!(
"second compositor IPC connection refused; weft-appd is connected"
);
continue;
}
tracing::info!("weft-appd connected to compositor IPC"); tracing::info!("weft-appd connected to compositor IPC");
let write_clone = match stream.try_clone() { let write_clone = match stream.try_clone() {
Ok(c) => c, Ok(c) => c,
@ -187,10 +415,12 @@ pub fn setup(state: &mut WeftCompositorState) -> anyhow::Result<()> {
}; };
if let Some(ipc) = &mut state.appd_ipc { if let Some(ipc) = &mut state.appd_ipc {
ipc.write_stream = Some(write_clone); ipc.write_stream = Some(write_clone);
ipc.connected = true;
ipc.read_buf.clear(); ipc.read_buf.clear();
ipc.fds.clear();
} }
stream.set_nonblocking(true).ok(); stream.set_nonblocking(true).ok();
let _ = handle.insert_source( let registered = handle.insert_source(
Generic::new(stream, Interest::READ, Mode::Edge), Generic::new(stream, Interest::READ, Mode::Edge),
|_, stream, state| { |_, stream, state| {
// Safety: calloop wraps the fd in NoIoDrop to prevent // Safety: calloop wraps the fd in NoIoDrop to prevent
@ -203,16 +433,37 @@ pub fn setup(state: &mut WeftCompositorState) -> anyhow::Result<()> {
for msg in messages { for msg in messages {
handle_message(state, msg); handle_message(state, msg);
} }
if let Some(ipc) = state.appd_ipc.as_mut() {
ipc.flush();
}
if eof { if eof {
tracing::info!( tracing::info!(
"weft-appd disconnected from compositor IPC" "weft-appd disconnected from compositor IPC; \
closing its sessions' clients"
); );
let orphans = state
.appd_ipc
.as_mut()
.map(WeftAppdIpc::disconnect)
.unwrap_or_default();
for client in orphans {
state.display_handle.backend_handle().kill_client(
client,
DisconnectReason::ConnectionClosed,
);
}
Ok(PostAction::Remove) Ok(PostAction::Remove)
} else { } else {
Ok(PostAction::Continue) Ok(PostAction::Continue)
} }
}, },
); );
if let Err(e) = registered {
tracing::warn!(?e, "cannot watch the appd IPC connection");
if let Some(ipc) = state.appd_ipc.as_mut() {
ipc.disconnect();
}
}
} }
Err(e) if e.kind() == io::ErrorKind::WouldBlock => break, Err(e) if e.kind() == io::ErrorKind::WouldBlock => break,
Err(e) => tracing::warn!(?e, "accept error on compositor IPC socket"), Err(e) => tracing::warn!(?e, "accept error on compositor IPC socket"),
@ -225,3 +476,176 @@ pub fn setup(state: &mut WeftCompositorState) -> anyhow::Result<()> {
Ok(()) Ok(())
} }
#[cfg(all(test, unix))]
mod tests {
use super::*;
use rustix::net::{SendAncillaryBuffer, SendAncillaryMessage, SendFlags, sendmsg};
use std::mem::MaybeUninit;
use std::os::fd::AsFd;
fn send_with_fd(stream: &UnixStream, bytes: &[u8], fd: &impl AsFd) {
let mut space = [MaybeUninit::uninit(); rustix::cmsg_space!(ScmRights(1))];
let mut control = SendAncillaryBuffer::new(&mut space);
let fds = [fd.as_fd()];
assert!(control.push(SendAncillaryMessage::ScmRights(&fds)));
let sent = sendmsg(
stream,
&[io::IoSlice::new(bytes)],
&mut control,
SendFlags::empty(),
)
.unwrap();
assert_eq!(sent, bytes.len());
}
#[test]
fn a_connection_arrives_with_the_message_that_claims_it() {
let (appd, compositor) = UnixStream::pair().unwrap();
compositor.set_nonblocking(true).unwrap();
let (shell, client) = UnixStream::pair().unwrap();
let frame = frame_encode(&AppdToCompositor::AttachClient {
session_id: 7,
app_id: "org.weft.demo.counter".into(),
})
.unwrap();
send_with_fd(&appd, &frame, &client);
drop(client);
let mut ipc = WeftAppdIpc::new(PathBuf::from("/nonexistent"));
let (messages, eof) = ipc.on_read(&compositor);
assert!(!eof);
assert!(matches!(
messages.as_slice(),
[AppdToCompositor::AttachClient { session_id: 7, .. }]
));
// The received descriptor is the other end of the shell's connection.
let received = UnixStream::from(ipc.fds.pop_front().expect("no descriptor"));
use std::io::{Read, Write};
(&shell).write_all(b"hello").unwrap();
let mut buf = [0u8; 5];
(&received).read_exact(&mut buf).unwrap();
assert_eq!(&buf, b"hello");
}
#[test]
fn descriptors_without_messages_end_the_connection() {
let (appd, compositor) = UnixStream::pair().unwrap();
compositor.set_nonblocking(true).unwrap();
let (_shell, client) = UnixStream::pair().unwrap();
let mut ipc = WeftAppdIpc::new(PathBuf::from("/nonexistent"));
for _ in 0..=MAX_PENDING_FDS {
send_with_fd(&appd, &[0], &client);
}
let (messages, eof) = ipc.on_read(&compositor);
assert!(messages.is_empty());
assert!(eof);
ipc.disconnect();
assert!(ipc.fds.is_empty());
}
#[test]
fn a_burst_of_attachments_is_not_mistaken_for_abuse() {
let (appd, compositor) = UnixStream::pair().unwrap();
compositor.set_nonblocking(true).unwrap();
let mut keep = Vec::new();
for session_id in 0..(MAX_PENDING_FDS as u64 + 4) {
let (shell, client) = UnixStream::pair().unwrap();
let frame = frame_encode(&AppdToCompositor::AttachClient {
session_id,
app_id: "org.weft.demo.counter".into(),
})
.unwrap();
send_with_fd(&appd, &frame, &client);
// A plain frame between attachments keeps its place.
let plain = frame_encode(&AppdToCompositor::AppFocusRequest { session_id }).unwrap();
use std::io::Write;
(&appd).write_all(&plain).unwrap();
keep.push(shell);
}
let mut ipc = WeftAppdIpc::new(PathBuf::from("/nonexistent"));
let mut messages = Vec::new();
let mut connections = 0;
loop {
let (batch, eof) = ipc.on_read(&compositor);
assert!(!eof, "a legitimate burst ended the connection");
if batch.is_empty() {
break;
}
// As the handler does, each attachment takes its connection.
for message in &batch {
if matches!(message, AppdToCompositor::AttachClient { .. }) {
ipc.fds
.pop_front()
.expect("an attachment without its connection");
connections += 1;
}
}
messages.extend(batch);
}
assert_eq!(connections, MAX_PENDING_FDS + 4);
assert_eq!(messages.len(), 2 * (MAX_PENDING_FDS + 4));
assert!(ipc.fds.is_empty());
}
#[test]
fn a_slow_appd_gets_whole_frames_later_instead_of_losing_its_apps() {
let (appd, compositor) = UnixStream::pair().unwrap();
compositor.set_nonblocking(true).unwrap();
let mut ipc = WeftAppdIpc::new(PathBuf::from("/nonexistent"));
ipc.write_stream = Some(compositor);
ipc.connected = true;
// More than the socket buffer holds while appd is not reading.
let count = 20_000u64;
for session_id in 0..count {
ipc.send(&CompositorToAppd::SurfaceReady { session_id });
}
assert!(
ipc.write_stream.is_some(),
"a full buffer closed the connection"
);
assert!(!ipc.out_buf.is_empty());
// appd reads; every flush moves more, and every frame arrives whole.
appd.set_nonblocking(true).unwrap();
let mut received = Vec::new();
let mut buf = [0u8; 65536];
loop {
ipc.flush();
use std::io::Read;
match (&appd).read(&mut buf) {
Ok(n) => received.extend_from_slice(&buf[..n]),
Err(e) if e.kind() == io::ErrorKind::WouldBlock => {
if ipc.out_buf.is_empty() {
break;
}
}
Err(e) => panic!("{e}"),
}
}
let mut frames = 0u64;
while !received.is_empty() {
let len = u32::from_le_bytes(received[..4].try_into().unwrap()) as usize;
let frame: CompositorToAppd = frame_decode(&received[..4 + len]).unwrap();
assert!(
matches!(frame, CompositorToAppd::SurfaceReady { session_id } if session_id == frames)
);
received.drain(..4 + len);
frames += 1;
}
assert_eq!(frames, count);
}
#[test]
fn an_undecodable_frame_ends_the_connection() {
let (appd, compositor) = UnixStream::pair().unwrap();
compositor.set_nonblocking(true).unwrap();
use std::io::Write;
let mut frame = 3u32.to_le_bytes().to_vec();
frame.extend_from_slice(&[0xc1, 0xc1, 0xc1]);
(&appd).write_all(&frame).unwrap();
let mut ipc = WeftAppdIpc::new(PathBuf::from("/nonexistent"));
let (_, eof) = ipc.on_read(&compositor);
assert!(eof);
}
}

View file

@ -53,11 +53,35 @@ use smithay::{
#[derive(Default)] #[derive(Default)]
pub struct WeftClientState { pub struct WeftClientState {
pub compositor_state: CompositorClientState, pub compositor_state: CompositorClientState,
/// The appd session this client's connection was created for. Clients
/// that connect through the display socket have none.
pub session: Option<SessionBinding>,
}
/// The appd session a client belongs to, established by weft-appd handing
/// the compositor the client's connection, never by the client itself.
pub struct SessionBinding {
pub session_id: u64,
pub app_id: String,
/// Reports the session's disconnection to the event loop.
pub disconnected: smithay::reexports::calloop::channel::Sender<(u64, ClientId)>,
}
/// Whether `client` connected through the display socket rather than
/// through a connection weft-appd created for an application session.
pub fn outside_sessions(client: &Client) -> bool {
client
.get_data::<WeftClientState>()
.is_none_or(|data| data.session.is_none())
} }
impl ClientData for WeftClientState { impl ClientData for WeftClientState {
fn initialized(&self, _client_id: ClientId) {} fn initialized(&self, _client_id: ClientId) {}
fn disconnected(&self, _client_id: ClientId, _reason: DisconnectReason) {} fn disconnected(&self, client_id: ClientId, _reason: DisconnectReason) {
if let Some(binding) = &self.session {
let _ = binding.disconnected.send((binding.session_id, client_id));
}
}
} }
/// Accumulated state for a multi-touch swipe gesture in progress. /// Accumulated state for a multi-touch swipe gesture in progress.
@ -124,7 +148,10 @@ impl WeftCompositorState {
) -> Self { ) -> Self {
let compositor_state = CompositorState::new::<Self>(&display_handle); let compositor_state = CompositorState::new::<Self>(&display_handle);
let xdg_shell_state = XdgShellState::new::<Self>(&display_handle); let xdg_shell_state = XdgShellState::new::<Self>(&display_handle);
let layer_shell_state = WlrLayerShellState::new::<Self>(&display_handle); // Layer surfaces and input methods are shell-level: an application
// session's client is not offered them.
let layer_shell_state =
WlrLayerShellState::new_with_filter::<Self, _>(&display_handle, outside_sessions);
let shm_state = ShmState::new::<Self>(&display_handle, vec![]); let shm_state = ShmState::new::<Self>(&display_handle, vec![]);
let dmabuf_state = DmabufState::new(); let dmabuf_state = DmabufState::new();
let output_manager_state = OutputManagerState::new_with_xdg_output::<Self>(&display_handle); let output_manager_state = OutputManagerState::new_with_xdg_output::<Self>(&display_handle);
@ -132,7 +159,7 @@ impl WeftCompositorState {
let presentation_state = PresentationState::new::<Self>(&display_handle, 1); let presentation_state = PresentationState::new::<Self>(&display_handle, 1);
let text_input_state = TextInputManagerState::new::<Self>(&display_handle); let text_input_state = TextInputManagerState::new::<Self>(&display_handle);
let input_method_state = let input_method_state =
InputMethodManagerState::new::<Self, _>(&display_handle, |_client| true); InputMethodManagerState::new::<Self, _>(&display_handle, outside_sessions);
let pointer_constraints_state = PointerConstraintsState::new::<Self>(&display_handle); let pointer_constraints_state = PointerConstraintsState::new::<Self>(&display_handle);
let cursor_shape_state = CursorShapeManagerState::new::<Self>(&display_handle); let cursor_shape_state = CursorShapeManagerState::new::<Self>(&display_handle);
let weft_shell_state = WeftShellState::new::<Self>(&display_handle); let weft_shell_state = WeftShellState::new::<Self>(&display_handle);
@ -241,8 +268,16 @@ impl XdgShellHandler for WeftCompositorState {
fn new_toplevel(&mut self, surface: ToplevelSurface) { fn new_toplevel(&mut self, surface: ToplevelSurface) {
surface.send_configure(); surface.send_configure();
let session = surface.wl_surface().client().and_then(|client| {
client
.get_data::<WeftClientState>()
.and_then(|data| data.session.as_ref().map(|s| s.session_id))
});
let window = Window::new_wayland_window(surface); let window = Window::new_wayland_window(surface);
self.space.map_element(window, (0, 0), false); self.space.map_element(window, (0, 0), false);
if let (Some(session_id), Some(ipc)) = (session, self.appd_ipc.as_mut()) {
ipc.surface_created(session_id);
}
} }
fn new_popup(&mut self, surface: PopupSurface, positioner: PositionerState) { fn new_popup(&mut self, surface: PopupSurface, positioner: PositionerState) {
@ -466,7 +501,7 @@ impl GlobalDispatch<ZweftShellManagerV1, ()> for WeftCompositorState {
impl Dispatch<ZweftShellManagerV1, ()> for WeftCompositorState { impl Dispatch<ZweftShellManagerV1, ()> for WeftCompositorState {
fn request( fn request(
state: &mut Self, state: &mut Self,
_client: &Client, client: &Client,
_resource: &ZweftShellManagerV1, _resource: &ZweftShellManagerV1,
request: zweft_shell_manager_v1::Request, request: zweft_shell_manager_v1::Request,
_data: &(), _data: &(),
@ -486,6 +521,14 @@ impl Dispatch<ZweftShellManagerV1, ()> for WeftCompositorState {
width, width,
height, height,
} => { } => {
// An application session's windows carry the identity appd
// bound to its connection, and only the trusted shell, which
// connects through the display socket, may take shell roles.
let session = client
.get_data::<WeftClientState>()
.and_then(|data| data.session.as_ref());
let shell_role = matches!(role.as_str(), "panel" | "overlay");
let app_id = session.map_or(app_id, |s| s.app_id.clone());
let is_panel = role == "panel"; let is_panel = role == "panel";
let window = data_init.init( let window = data_init.init(
id, id,
@ -497,6 +540,18 @@ impl Dispatch<ZweftShellManagerV1, ()> for WeftCompositorState {
closed: std::sync::atomic::AtomicBool::new(false), closed: std::sync::atomic::AtomicBool::new(false),
}, },
); );
if let Some(session) = session
&& shell_role
{
window.post_error(
crate::protocols::server::zweft_shell_window_v1::Error::RoleNotPermitted,
format!(
"session {} ({}) may not create shell windows",
session.session_id, session.app_id
),
);
return;
}
if is_panel { if is_panel {
let (ox, oy, ow, oh) = state let (ox, oy, ow, oh) = state
.space .space

View file

@ -13,11 +13,16 @@ pub const MAX_FRAME_LEN: usize = 4 * 1024 * 1024;
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")] #[serde(tag = "type", rename_all = "snake_case")]
pub enum AppdToCompositor { pub enum AppdToCompositor {
AppSurfaceCreated { /// Hands the compositor its end of the Wayland connection weft-appd
app_id: String, /// created for the session's app shell. The frame is sent with exactly
/// one file descriptor attached (SCM_RIGHTS): the compositor end of that
/// connection. Holding the connection is the session's identity; no
/// client-supplied ID or process ID is trusted for it.
AttachClient {
session_id: u64, session_id: u64,
pid: u32, app_id: String,
}, },
/// The session ended; the compositor closes its client and windows.
AppSurfaceDestroyed { AppSurfaceDestroyed {
session_id: u64, session_id: u64,
}, },
@ -30,8 +35,10 @@ pub enum AppdToCompositor {
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")] #[serde(tag = "type", rename_all = "snake_case")]
pub enum CompositorToAppd { pub enum CompositorToAppd {
/// The session's client mapped its first toplevel.
SurfaceReady { session_id: u64 }, SurfaceReady { session_id: u64 },
ClientDisconnected { pid: u32 }, /// The session's Wayland client disconnected.
ClientDisconnected { session_id: u64 },
} }
/// Encode a message as a length-prefixed MessagePack frame. /// Encode a message as a length-prefixed MessagePack frame.
@ -114,23 +121,17 @@ mod tests {
use super::*; use super::*;
#[test] #[test]
fn roundtrip_appd_to_compositor_surface_created() { fn roundtrip_appd_to_compositor_attach_client() {
let msg = AppdToCompositor::AppSurfaceCreated { let msg = AppdToCompositor::AttachClient {
app_id: "com.example.app".into(), app_id: "com.example.app".into(),
session_id: 42, session_id: 42,
pid: 1234,
}; };
let frame = frame_encode(&msg).unwrap(); let frame = frame_encode(&msg).unwrap();
let decoded: AppdToCompositor = frame_decode(&frame).unwrap(); let decoded: AppdToCompositor = frame_decode(&frame).unwrap();
match decoded { match decoded {
AppdToCompositor::AppSurfaceCreated { AppdToCompositor::AttachClient { app_id, session_id } => {
app_id,
session_id,
pid,
} => {
assert_eq!(app_id, "com.example.app"); assert_eq!(app_id, "com.example.app");
assert_eq!(session_id, 42); assert_eq!(session_id, 42);
assert_eq!(pid, 1234);
} }
_ => panic!("unexpected variant"), _ => panic!("unexpected variant"),
} }
@ -171,11 +172,11 @@ mod tests {
#[test] #[test]
fn roundtrip_compositor_to_appd_disconnected() { fn roundtrip_compositor_to_appd_disconnected() {
let msg = CompositorToAppd::ClientDisconnected { pid: 5678 }; let msg = CompositorToAppd::ClientDisconnected { session_id: 5678 };
let frame = frame_encode(&msg).unwrap(); let frame = frame_encode(&msg).unwrap();
let decoded: CompositorToAppd = frame_decode(&frame).unwrap(); let decoded: CompositorToAppd = frame_decode(&frame).unwrap();
match decoded { match decoded {
CompositorToAppd::ClientDisconnected { pid } => assert_eq!(pid, 5678), CompositorToAppd::ClientDisconnected { session_id } => assert_eq!(session_id, 5678),
_ => panic!("unexpected variant"), _ => panic!("unexpected variant"),
} }
} }

View file

@ -8,7 +8,7 @@ WEFT OS is a Wayland compositor and application runtime where every app is a Web
### weft-compositor ### weft-compositor
Smithay-based Wayland compositor. Implements the `zweft-shell-unstable-v1` protocol extension, which allows shell clients (servo-shell, app-shell) to register their surfaces as typed shell slots. Supports DRM/KMS and winit (software/dev) backends. Smithay-based Wayland compositor. Implements the `zweft-shell-unstable-v1` protocol extension, which allows shell clients (servo-shell, app-shell) to register their surfaces as typed shell slots. Each application session's Wayland connection is handed to the compositor by weft-appd, which binds the client to that session (see `security.md`). Supports DRM/KMS and winit (software/dev) backends.
### weft-servo-shell ### weft-servo-shell
@ -16,7 +16,7 @@ System UI host. Renders one WebView pointing at `system-ui.html` using the embed
### weft-app-shell ### weft-app-shell
Per-application Servo host. Spawned by `weft-appd` after the Wasm runtime signals READY. Takes `<app_id>`, `<session_id>` and `--ui <path>`, the UI document weft-appd resolved from the package; it never looks for the package itself. Injects the `weftIpc` WebSocket bridge into the page. The bridge authenticates with the per-session token from `WEFT_BRIDGE_TOKEN` and can only exchange messages with its own session. It is installed only in top-level documents inside the application's UI directory, and top-level navigation outside that directory is denied; framed documents never receive the bridge. Every resource the page loads (subresources, `fetch()`, XHR, workers and WebSocket handshakes) is checked by the shell: the page may load files inside its UI directory, also after symbolic links are resolved, inline `data:` and `blob:` resources, `about:blank` and the session bridge; any other local file or network destination, and every redirect, fails with a network error. Loads Servo does not attribute to the webview, such as `navigator.sendBeacon()`, are all refused. Network access belongs to the Wasm component, under its fetch grants. Servo's privileged `navigator.servo` interface, which can change engine preferences, is not exposed to `about:blank` or `about:srcdoc` documents (a fork patch; see `crates/weft-servo-shell/SERVO_PIN.md`). Registers with the compositor as window type `application`. Exits when the appd session ends. Per-application Servo host. Spawned by `weft-appd` after the Wasm runtime signals READY. Takes `<app_id>`, `<session_id>` and `--ui <path>`, the UI document weft-appd resolved from the package; it never looks for the package itself. Injects the `weftIpc` WebSocket bridge into the page. The bridge authenticates with the per-session token from `WEFT_BRIDGE_TOKEN` and can only exchange messages with its own session. It is installed only in top-level documents inside the application's UI directory, and top-level navigation outside that directory is denied; framed documents never receive the bridge. Every resource the page loads (subresources, `fetch()`, XHR, workers and WebSocket handshakes) is checked by the shell: the page may load files inside its UI directory, also after symbolic links are resolved, inline `data:` and `blob:` resources, `about:blank` and the session bridge; any other local file or network destination, and every redirect, fails with a network error. Loads Servo does not attribute to the webview, such as `navigator.sendBeacon()`, are all refused. Network access belongs to the Wasm component, under its fetch grants. Servo's privileged `navigator.servo` interface, which can change engine preferences, is not exposed to `about:blank` or `about:srcdoc` documents (a fork patch; see `crates/weft-servo-shell/SERVO_PIN.md`). Registers with the compositor as window type `application`, over the one Wayland connection weft-appd created for its session and passed as standard input (`WAYLAND_SOCKET=0`). Exits when the appd session ends.
### weft-appd ### weft-appd

View file

@ -40,7 +40,9 @@ For verified read-only package storage, `weft-pack build-image` produces an EROF
## Wayland Surface Isolation ## Wayland Surface Isolation
Each app registers its surface with the compositor via `zweft_shell_manager_v1`. The compositor enforces that each surface belongs to the session that created it. The app cannot render outside its assigned surface slot. Each app shell is given exactly one Wayland connection, created for its session. weft-appd creates a connected socket pair, gives one end to the app shell as its standard input with `WAYLAND_SOCKET=0` and no `WAYLAND_DISPLAY`, and sends the other end to the compositor over the compositor IPC socket (`SCM_RIGHTS`) with the session ID and app ID. The compositor adds that end as a client bound to the session; the binding comes from appd holding the connection, never from an ID or process ID the client supplies. A session's `zweft_shell` windows carry the session's app ID whatever the client requests, and the shell-only `panel` and `overlay` roles are refused with a protocol error; layer-shell surfaces and the input-method interface are not offered to session clients at all. When the session ends, the compositor closes its client; when the client disconnects, the compositor reports it to appd; when appd's connection ends, the compositor closes every session client appd attached. The compositor accepts one appd connection at a time. A launch is refused (503) while appd is not connected to the compositor, rather than starting an app that could never show a window; if the compositor connection is lost before the session's connection is handed over, the session is stopped before the app shell starts. Frames for appd that its socket cannot take at once are queued and retried; a backlog beyond 4 MiB, from an appd that stopped reading, ends the connection and with it the sessions' clients.
Not yet covered: the compositor IPC socket accepts any process of the user while no appd is connected, so the first connection after a restart is trusted as appd; window placement, stacking, focus and close are not yet decided by the compositor per session (all toplevels start at the origin); and the trusted system shell is identified only by connecting through the display socket, which any process of the user, including an app shell, can open.
## JavaScript Engine (SpiderMonkey) ## JavaScript Engine (SpiderMonkey)

View file

@ -65,6 +65,11 @@
object identity; no separate window_id is exchanged. The object identity; no separate window_id is exchanged. The
compositor will emit configure on the new object to communicate the compositor will emit configure on the new object to communicate the
effective initial geometry and state. effective initial geometry and state.
For a client that the compositor associated with an application
session, the session's application identifier replaces the app_id
argument, and the panel and overlay roles are refused with the
role_not_permitted error on the new window.
</description> </description>
<arg name="id" type="new_id" interface="zweft_shell_window_v1" <arg name="id" type="new_id" interface="zweft_shell_window_v1"
summary="new window object"/> summary="new window object"/>
@ -114,6 +119,8 @@
<description summary="protocol errors"/> <description summary="protocol errors"/>
<entry name="defunct_window" value="0" <entry name="defunct_window" value="0"
summary="request sent after window_closed was received"/> summary="request sent after window_closed was received"/>
<entry name="role_not_permitted" value="1"
summary="an application session requested a shell-only role"/>
</enum> </enum>
<request name="destroy" type="destructor"> <request name="destroy" type="destructor">

View file

@ -176,9 +176,16 @@ def run(args, desktop, xdotool):
appd = AppdClient(port, token) appd = AppdClient(port, token)
appd.send({"type": "LAUNCH_APP", "app_id": APP_ID, "surface_id": 0}) appd.send({"type": "LAUNCH_APP", "app_id": APP_ID, "surface_id": 0})
try: try:
appd.wait_for(lambda m: m.get("type") == "APP_READY", STARTUP_TIMEOUT) ready = appd.wait_for(lambda m: m.get("type") == "APP_READY", STARTUP_TIMEOUT)
except TimeoutError: except TimeoutError:
raise AssertionError("no APP_READY") raise AssertionError("no APP_READY")
session_id = ready["session_id"]
# The app's only Wayland connection is the one appd handed the
# compositor for this session.
bound = f"client bound to session session_id={session_id} app_id={APP_ID}"
if bound not in desktop.log_text("compositor"):
raise AssertionError(f"the compositor did not bind the app's client: {bound!r}")
def capture_card(): def capture_card():
deadline = time.monotonic() + 10 deadline = time.monotonic() + 10
@ -220,6 +227,15 @@ def run(args, desktop, xdotool):
if states[3] != states[1]: if states[3] != states[1]:
raise AssertionError("count after ArrowDown does not match the count after one ArrowUp") raise AssertionError("count after ArrowDown does not match the count after one ArrowUp")
# Ending the session closes its client in the compositor.
appd.send({"type": "TERMINATE_APP", "session_id": session_id})
deadline = time.monotonic() + 15
closed = f"closing the client of an ended session session_id={session_id}"
while closed not in desktop.log_text("compositor"):
if time.monotonic() > deadline:
raise AssertionError(f"the compositor did not close the session's client: {closed!r}")
time.sleep(0.3)
def subprocess_run(xdotool, display, arguments): def subprocess_run(xdotool, display, arguments):
import subprocess import subprocess