wprs

类似于 xpra，但适用于 Wayland，并使用 Rust 编写。

wprs 为远程 Wayland（以及通过 XWayland 的 X11）应用程序实现了无根远程桌面访问。

构建

源码

cargo build --profile=release-lto # 或 release，但 debug 模式运行速度极慢

wprsc、wprsd、xwayland-xdg-shell 需要以下依赖：

libxkbcommon（在 Debian 上为 -dev 包）
libwayland（在 Debian 上为 -dev 包）

启动器（wprs）需要：

python3
psutil（在 Debian 上为 python3-psutil）
ssh 客户端

deb 包

dpkg-buildpackage --sanitize-env -us -uc -b -d -rfakeroot

这需要安装 cargo 和与 rust-toolchain.toml 中匹配的 rustc。不使用 Debian 的 rustc 包，因为版本过旧。

使用方法

在远程主机上，启用 wprsd：

loginctl enable-linger
systemctl --user enable wprsd.service
systemctl --user start wprsd.service

在本地主机上：

# 在远程主机上启动应用程序（建立 ssh 连接，转发套接字，启动 wprsc，运行应用程序）
wprs <remote_host> run <application>

# 停止本地 wprs 连接，保持远程会话运行（断开 ssh 连接和转发的套接字，停止 wprsc）
wprs <remote_host> detach

# 连接到远程 wprs 会话（建立 ssh 连接，转发套接字，启动 wprsc）
wprs <remote_host> attach

系统优化

按照 https://wiki.archlinux.org/title/sysctl#Increase_the_memory_dedicated_to_the_network_interfaces 中的描述增加 Linux 的套接字缓冲区限制可以提高性能。

待办事项：测试不同 wmem_default 值对 ssh 套接字转发性能的影响。wprs 使用 setsockopt 增加其缓冲区大小，但 ssh 似乎没有这样做。

配置文件

您可以为 wprsc 和 wprsd 创建配置文件，而不是向 wprs 传递额外参数。要查看可用选项，请运行 wprsc --help 和 wprsd --help。

要生成默认配置，请运行：

# 在本地机器上
wprsc --print-default-config-and-exit=true > ~/.config/wprs/wprsc.ron

以及

# 在远程机器上
wprsd --print-default-config-and-exit=true > ~/.config/wprs/wprsd.ron

然后根据您的需求更新 wprsc.ron 和 wprsd.ron 文件。

当前限制

目前仅实现了 Core 和 XDG shell 协议。特别是，尚未实现硬件渲染/dmabuf 支持。

尚未实现触摸事件支持。
在某些情况下，拖放可能会出现问题。
尚未（或可能不会）实现 XWayland 拖放。
浏览器中的 webauthn 安全密钥尚不可用。

总的来说，wprs 将努力支持尽可能多的协议，这是一个时间和优先级的问题。

架构

在远程（服务器）端，wprsd 使用 Smithay 实现了一个 Wayland 合成器。但是，wprsd 不进行合成和渲染，而是将 Wayland 会话的状态序列化并使用自定义协议发送给连接的 wprsc 客户端。

在本地（客户端）端，wprsc 实现了一个 Wayland 客户端（使用 Smithay Client Toolkit），创建与远程 Wayland 对象对应的本地 Wayland 对象。例如，如果远程应用程序在 wprsd 上创建了一个 surface 和一个 xdg-toplevel，wprsc 将创建一个具有相同内容的 surface，一个具有相同元数据的 xdg-toplevel 等。从本地合成器的角度来看，wprsc 只是一个拥有多个窗口的普通应用程序。来自本地合成器的输入和其他事件由 wprsc 序列化并发送给 wprsd，后者将它们转发给适当的应用程序（即拥有与接收事件的 wprsc surface 对应的 surface 的应用程序）。

wprs 支持会话恢复（wprsc 断开连接后重新连接和 wprsc 重启）。Wayland 协议本身不支持这种方式的恢复，因为它依赖于合成器和客户端应用程序之间的共享状态。通过在应用程序本地实现 Wayland 合成器，wprsd 存储了 Wayland 应用程序所需的所有状态，并能够存储足够的状态（例如，每个 surface 最后一次提交时的缓冲区内容）以供新连接的 wprsc 正确设置所有必要的 Wayland 对象。wprsc 是无状态的，但 wprsd 不是，因此重启 wprsd 仍会终止所有运行在其上的 Wayland 应用程序，这与其他 Wayland 合成器类似。

wprsd 和 wprsc 之间的通信通过 Unix 域套接字进行；wprsd 创建一个套接字，wprsc 连接到它。默认操作模式是在客户端使用 ssh 将本地套接字转发到远程 wprsd 套接字，但也可以使用不同的传输方式，例如使用 socat 或自定义代理应用程序。提供了一个启动器脚本（wprs）来设置 ssh 套接字转发。

协议

用于在 wprsc 和 wprsd 之间序列化和传输 Wayland 状态的自定义协议是 Wayland 协议的简化版本。Wayland 对象表示为 Rust 类型，并使用 rkyv 进行序列化。与 Wayland 协议不同，wprs 协议尽可能保持幂等性。例如，wprsd 不会重复创建 surface、创建 xdg-surface、创建 xdg-toplevel、等待配置、创建缓冲区、附加缓冲区和提交的来回过程，而是向 wprsc 发送一个包含 surface 完整状态的单一提交消息（包括 surface 附加的缓冲区内容（如果有）、其角色（如果有）以及任何相关元数据等），wprsc 随后与本地合成器执行适当的交互。

帧回调由 wprsd 按配置的帧率在本地调度，不会从 wprsc 转发，因为这会由于网络往返而引入不可接受的帧延迟。当没有 wprsc 连接时，wprsd 会暂停向 Wayland 应用程序发送帧回调。

缓冲区压缩使用自定义的多线程和 SIMD 加速的无损图像压缩算法处理：

将图像从结构数组转换为数组结构。这使得后续步骤能够通过SIMD指令实现，大大提高了速度，并且由于每个颜色通道在空间上与自身的相关性比与其他通道的相关性更高，因此还提高了压缩比。
对每个颜色通道应用相邻（环绕）差分（差分脉冲编码调制）。这通过利用空间相关性来提高压缩比，将（例如）纯色线条转换为单个颜色字节，然后是一系列0字节，或将渐变转换为一系列1字节等。
将每个颜色通道转换为YUV类似的色彩空间：y := g, u := b - g, v := r - g, a := a。这通过利用跨颜色相关性，以类似于上一步的方式提高压缩比。
使用zstd压缩数据。

该算法旨在实现相当好的压缩比，同时保持极快的速度：每帧仅需几毫秒。解压缩通过反转这些步骤来完成。

此协议不稳定：不能保证不同版本的wprsc和wprsd，或使用不同版本依赖项甚至rustc构建的wprsc和wprsd之间的兼容性。这种情况将来可能会改变，但短期内不会发生。

与Waypipe的比较

Waypipe的模型类似于X转发，而wprs的模型类似于Xpra。Waypipe大致透明地在本地合成器和远程应用程序之间转发消息，因此客户端最终是有状态的，会话只能通过网络重连恢复，而不能通过客户端重启恢复。这两种方法各有利弊。Waypipe的方法部分向前兼容：它可以自动支持新的wayland协议，但如果这些协议以Waypipe无法处理的方式使用共享资源，它们可能会出现问题。另一方面，wprs需要为每个wayland协议进行显式实现。

XWayland

XWayland支持作为一个单独的二进制文件xwayland-xdg-shell实现。该二进制文件实现了一个wayland合成器（但仅限于xwayland使用的协议特性）和客户端，就像wprsd和wprsc一样，但在一个单一的二进制文件中（因此跳过了序列化/反序列化）。这与xwayland-proxy-virtwl采用相同的模型，后者又受到sommelier的启发。开发xwayland-xdg-shell的主要目的（而不是直接使用xwayland-proxy-virtwl）是为了与wprs共享通用设计/代码库，并利用Smithay及其wayland库形式的通用wayland开发。此外，xwayland-xdg-shell更加专注，其唯一目的是提供xwayland支持，而不涉及virtio-gpu或virtwl。

与xwayland-proxy-virtwl类似，xwayland-xdg-proxy可用于为任何wayland合成器实现外部xwayland支持，而无需在合成器内部重新实现它。除了消除了在每个合成器中实现xwayland支持的需求之外，据报道，这种方法在某些合成器中可以实现比原生xwayland支持更好的xwayland缩放，并且允许将xwayland应用程序更像常规wayland应用程序一样对待，而不是获得特殊访问权限。

安全性

wprsd是一个wayland合成器，因此它可以访问运行在其上的应用程序显示的所有表面，并且可以向它们注入输入。任何实现wprs协议并连接到wprs套接字的进程都将具有相同的访问权限。因此，wprs套接字创建在只有用户有访问权限的目录中（$XDG_RUNTIME_DIR），并且套接字本身只允许用户读写。以与wprsd相同用户身份运行的恶意应用程序仍然可以访问此套接字，但在这种情况下，你面临更大的问题。

wprs本身不进行任何身份验证，它完全依赖于所使用的传输方式（默认情况下是ssh）。

致谢

非常感谢以下优秀项目，它们使得这个项目比原本要容易得多：

感谢Waypipe和xwayland-proxy-virtwl在这个问题领域开辟了道路。