mirror of
https://github.com/VallierDev/uu-remote-linux.git
synced 2026-11-16 08:50:40 +01:00
One release package for every desktop: Wayland and portal engines as runtime plugins
The release tarball was X11 only, so Hyprland/niri and GNOME/KDE Wayland users had to build from source (#43, #54). With --features engine-plugins the wayland and portal engines are built as libuu-wayland.so / libuu-portal.so and dlopen'ed only when the session selects them, so X11 hosts need none of their libraries. The wayland plugin is built on Ubuntu 22.04 with the main binary; the portal plugin needs libei >= 1.1 and is built on 24.04 (glibc >= 2.39). Source builds without engine-plugins keep linking the engines statically. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
1 parent
3480318089
commit
65c04e796a
12 files changed
+273
-16
No files matched your search
@@ -24,10 +24,17 @@ jobs:
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y build-essential pkg-config \
|
||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev
|
||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev \
|
||||
libwayland-dev libwayland-bin libxkbcommon-dev
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- uses: Swatinem/rust-cache@v2
|
||||
- run: cargo test --locked
|
||||
# Same as the release job: the wayland plugin is built on 22.04; libei is unavailable here, so
|
||||
# the portal plugin is skipped with a warning (release builds it on 24.04).
|
||||
- name: Release feature set
|
||||
run: |
|
||||
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
|
||||
test -f target/debug/libuu-wayland.so
|
||||
|
||||
test-viewer:
|
||||
runs-on: ubuntu-22.04
|
||||
@@ -56,6 +63,12 @@ jobs:
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- uses: Swatinem/rust-cache@v2
|
||||
- run: cargo test --locked --features wayland,portal
|
||||
# Release layout: engines as runtime-loaded plugins; uuremote-server must not link them.
|
||||
- name: Engine plugins
|
||||
run: |
|
||||
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
|
||||
for lib in libuu-wayland.so libuu-portal.so; do test -f "target/debug/$lib"; done
|
||||
! readelf -d target/debug/uuremote-server | grep NEEDED | grep -E 'libei|libpipewire|libwayland-client|libxkbcommon'
|
||||
- name: Native portal and EIS regression tests (ASan/UBSan)
|
||||
env:
|
||||
ASAN_OPTIONS: detect_leaks=1
|
||||
|
||||
@@ -9,7 +9,26 @@ permissions:
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
# GNOME/KDE Wayland engine: libei >= 1.1 first ships in Ubuntu 24.04, so this plugin needs
|
||||
# glibc >= 2.39. It is only loaded on portal sessions; X11 and wlroots hosts never open it.
|
||||
portal-plugin:
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Install build dependencies
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y build-essential pkg-config \
|
||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libglib2.0-dev libpipewire-0.3-dev libei-dev
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- run: UU_NO_GTK=1 cargo build --release --locked --features portal,engine-plugins --bin uuremote-server
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: libuu-portal
|
||||
path: target/release/libuu-portal.so
|
||||
|
||||
release:
|
||||
needs: portal-plugin
|
||||
# Built on 22.04 so the binary also runs on Ubuntu 22.04/24.04 and newer Debian (glibc >= 2.35).
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
@@ -18,17 +37,25 @@ jobs:
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y build-essential pkg-config \
|
||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev libsdl2-dev
|
||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev libsdl2-dev \
|
||||
libwayland-dev libwayland-bin libxkbcommon-dev
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- run: cargo test --release --locked
|
||||
- run: cargo build --release --locked
|
||||
# Experimental viewer; built after the host so uuremote-server keeps the default features.
|
||||
# One package for every desktop: Wayland (wlroots) and GNOME/KDE portal engines are plugins
|
||||
# opened at runtime (engine-plugins), so X11 hosts need none of their libraries.
|
||||
- run: cargo build --release --locked --features wayland,portal,engine-plugins
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: libuu-portal
|
||||
path: target/release
|
||||
# Experimental viewer; built after the host so uuremote-server keeps the release features.
|
||||
- run: cargo build --release --locked --features native-viewer,viewer-sdl --bin uuremote-viewer
|
||||
- name: Package
|
||||
run: |
|
||||
name=uu-remote-linux-${GITHUB_REF_NAME}-x86_64-linux
|
||||
mkdir -p "$name"
|
||||
cp target/release/uuremote-server target/release/uuremote-viewer LICENSE README.md README.en.md config.example.json "$name/"
|
||||
cp target/release/uuremote-server target/release/uuremote-viewer target/release/libuu-wayland.so target/release/libuu-portal.so \
|
||||
LICENSE README.md README.en.md config.example.json "$name/"
|
||||
cp -r contrib "$name/"
|
||||
tar czf "$name.tar.gz" "$name"
|
||||
sha256sum "$name.tar.gz" > "$name.tar.gz.sha256"
|
||||
|
||||
@@ -116,6 +116,7 @@ viewer does not reconnect them automatically.
|
||||
| `UU_FFMPEG_ROOT` | FFmpeg prefix (`bin/ffmpeg`, libs in `lib/x86_64-linux-gnu`) |
|
||||
| `UU_AUDIO=0`, `UU_AUDIO_SOURCE` | disable sound / choose the Pulse source (default `@DEFAULT_MONITOR@`) |
|
||||
| `UU_LOGIN_WINDOW=0` | don't auto-open the login window |
|
||||
| `UU_ENGINE_DIR` | directory holding `libuu-wayland.so` / `libuu-portal.so` (`--features engine-plugins`, used by release packages: engines are dlopen'ed only on Wayland sessions; also searched next to the binary, `../lib/uu-remote-linux`, `~/.local/lib/uu-remote-linux`, `/usr/lib/uu-remote-linux`) |
|
||||
| `UU_USE_PROXY=1` | honor HTTP/SOCKS proxy env vars; cloud API clients bypass env proxies by default |
|
||||
| `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors |
|
||||
|
||||
@@ -143,6 +144,7 @@ every 60 s.
|
||||
| `src/initialization.rs`, `src/control_protocol.rs`, `src/protocol.rs` | protobuf encoders/decoders for CONTROL |
|
||||
| `src/session_ice.rs`, `src/network_diagnostics.rs` | cloud ICE servers, address-free path diagnostics |
|
||||
| `src/desktop_backend.rs`, `src/wayland.rs`, `src/portal*.rs` | backend selection, Hyprland, GNOME/KDE portal |
|
||||
| `src/engine_plugin.rs` | `engine_ffi!`: engine C functions linked statically, or dlsym-resolved from runtime plugins with `engine-plugins` |
|
||||
| `c_engine/portal_eis.inc` | scaled GNOME input through the existing Portal session's EIS connection; all input must use EIS once connected |
|
||||
| `c_engine/x11_engine.c`, `c_engine/clipboard.c` | X11 capture/input/selection |
|
||||
| `c_engine/wayland_engine.c`, `c_engine/portal_engine.c` | Wayland and portal engines |
|
||||
|
||||
@@ -28,6 +28,8 @@ wayland = []
|
||||
# Experimental direct linear framebuffer capture; never enabled in release builds.
|
||||
kms = []
|
||||
portal = []
|
||||
# Build the wayland/portal engines as runtime-loaded libuu-wayland.so / libuu-portal.so (release packages).
|
||||
engine-plugins = []
|
||||
# In-process capture and encoding through FFmpeg 6 libraries (libavcodec/libavdevice dev packages).
|
||||
# Off by default so release binaries do not link the build machine's libav.
|
||||
inproc-av = ["dep:ffmpeg-next", "dep:x11rb"]
|
||||
|
||||
@@ -120,6 +120,28 @@ mapping and hardware acceleration remain unverified. This is not zero-copy VAAPI
|
||||
|
||||
## Installation
|
||||
|
||||
### 0. Prebuilt release package (recommended, x86_64)
|
||||
|
||||
Download `uu-remote-linux-<version>-x86_64-linux.tar.gz` from [Releases](../../releases/latest), extract it, then:
|
||||
|
||||
```sh
|
||||
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
||||
install -Dm644 libuu-wayland.so libuu-portal.so -t ~/.local/lib/uu-remote-linux/
|
||||
```
|
||||
|
||||
One package covers X11, wlroots compositors (Hyprland, Sway, niri) and GNOME/KDE Wayland: the backend is chosen from the
|
||||
running session at startup, and the matching `libuu-*.so` is loaded only on Wayland, so X11 hosts need no Wayland libraries.
|
||||
|
||||
| Session | Requirements |
|
||||
|---|---|
|
||||
| X11 | glibc >= 2.35 (Ubuntu 22.04, Debian 12 and newer) |
|
||||
| wlroots (Hyprland / Sway / niri) | the same, plus `libwayland-client` and `libxkbcommon` (present on Wayland desktops) |
|
||||
| GNOME / KDE Wayland | glibc >= 2.39 (Ubuntu 24.04, Fedora 40, Debian 13 and newer), libei >= 1.1 and PipeWire |
|
||||
|
||||
Plugins are found next to `uuremote-server`, in `../lib/uu-remote-linux/`, `~/.local/lib/uu-remote-linux/` or
|
||||
`/usr/lib/uu-remote-linux/` (`UU_ENGINE_DIR` overrides); a missing library or too old glibc is reported in the log.
|
||||
Continue with step 3 (login). Other architectures (ARM): build from source below.
|
||||
|
||||
### 1. Dependencies (Ubuntu / Debian)
|
||||
|
||||
```sh
|
||||
|
||||
@@ -68,6 +68,8 @@ Portal 仅作用于本服务获授权的会话。文件传输、终端等独立
|
||||
| niri | Wayland(wlroots 原生协议) | 🧪 实验性,协议支持已按 niri 源码确认,尚未实机验收(#55) | `--features wayland` |
|
||||
| GNOME / KDE Plasma | Wayland(xdg-desktop-portal) | 🧪 实验性,验证范围与限制见下 | `--features wayland,portal` |
|
||||
|
||||
最后一列是源码编译方式;Release 预编译包已包含全部后端,直接使用即可(见[安装](#0-直接用-release-预编译包推荐x86_64))。
|
||||
|
||||
GNOME Wayland 的 Portal/EIS 路径已在 Ubuntu 26.04、GNOME 50、单屏 4K/200% 缩放下验证画面和键鼠;锁屏冷连接自动解锁已用 Mac 和 iPhone 4.42.0 客户端实机验证,其余锁屏恢复及重连仍待验收。除 GNOME 的上述路径和 X11 外,其余桌面目前主要在虚拟机里测试。如果你在真机上遇到问题,欢迎[提交 issue](../../issues),
|
||||
请附上发行版、桌面环境、显卡型号和 `journalctl --user -u uuremote-native.service` 里的相关日志。
|
||||
|
||||
@@ -105,6 +107,27 @@ GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通
|
||||
|
||||
## 安装
|
||||
|
||||
### 0. 直接用 Release 预编译包(推荐,x86_64)
|
||||
|
||||
从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`,解压后:
|
||||
|
||||
```sh
|
||||
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
||||
install -Dm644 libuu-wayland.so libuu-portal.so -t ~/.local/lib/uu-remote-linux/
|
||||
```
|
||||
|
||||
同一个包支持 X11、Hyprland 等 wlroots 合成器和 GNOME/KDE Wayland:程序启动时按当前会话自动选择后端,只在 Wayland 会话里
|
||||
才加载对应的 `libuu-*.so`,X11 用户不需要任何 Wayland 库。系统要求:
|
||||
|
||||
| 会话 | 要求 |
|
||||
|---|---|
|
||||
| X11 | glibc ≥ 2.35(Ubuntu 22.04、Debian 12 及更新) |
|
||||
| Hyprland / Sway / niri 等 wlroots | 同上,另需 `libwayland-client`、`libxkbcommon`(Wayland 桌面自带) |
|
||||
| GNOME / KDE Wayland | glibc ≥ 2.39(Ubuntu 24.04、Fedora 40、Debian 13 及更新),以及 libei ≥ 1.1、PipeWire |
|
||||
|
||||
插件放在 `uuremote-server` 同目录、`../lib/uu-remote-linux/`、`~/.local/lib/uu-remote-linux/` 或 `/usr/lib/uu-remote-linux/` 都能找到
|
||||
(`UU_ENGINE_DIR` 可指定)。缺库或版本太旧时日志会写明原因。之后从第 3 步「登录」继续;ARM 等其他架构请按下面源码编译。
|
||||
|
||||
### 1. 依赖(Ubuntu / Debian)
|
||||
|
||||
```sh
|
||||
|
||||
@@ -50,7 +50,15 @@ fn main() {
|
||||
}
|
||||
None => println!("cargo:warning=gtk+-3.0 not found: building without the login window"),
|
||||
}
|
||||
if std::env::var_os("CARGO_FEATURE_PORTAL").is_some() {
|
||||
let plugins = std::env::var_os("CARGO_FEATURE_ENGINE_PLUGINS").is_some();
|
||||
if plugins && std::env::var_os("CARGO_FEATURE_PORTAL").is_some() {
|
||||
// Runtime-loaded libuu-portal.so; skipped (with a warning) where libei >= 1.1 is unavailable.
|
||||
for file in ["portal_engine.c", "portal_engine.h", "portal_eis.inc", "desktop_power.c"] { println!("cargo:rerun-if-changed=c_engine/{file}"); }
|
||||
match pkg_config(&["gio-2.0", "gio-unix-2.0", "libpipewire-0.3", "libei-1.0 >= 1.1"]) {
|
||||
Some((cflags, libs)) => shared_engine("libuu-portal.so", &["c_engine/portal_engine.c", "c_engine/desktop_power.c"], &[], &cflags, &libs),
|
||||
None => println!("cargo:warning=GIO/PipeWire/libei >= 1.1 not found: libuu-portal.so not built"),
|
||||
}
|
||||
} else if std::env::var_os("CARGO_FEATURE_PORTAL").is_some() {
|
||||
println!("cargo:rerun-if-changed=c_engine/portal_engine.c");
|
||||
println!("cargo:rerun-if-changed=c_engine/portal_engine.h");
|
||||
println!("cargo:rerun-if-changed=c_engine/portal_eis.inc");
|
||||
@@ -76,6 +84,7 @@ fn main() {
|
||||
let mut build = cc::Build::new();
|
||||
build.flag_if_supported("-Wno-unused-parameter"); // protocol listener signatures
|
||||
build.file("c_engine/wayland_engine.c").include(&out);
|
||||
let mut sources = vec!["c_engine/wayland_engine.c".to_owned()];
|
||||
for name in ["wlr-screencopy-unstable-v1", "wlr-virtual-pointer-unstable-v1", "virtual-keyboard-unstable-v1", "wlr-output-power-management-unstable-v1", "linux-dmabuf-unstable-v1"] {
|
||||
let xml = format!("c_engine/wayland-protocols/{name}.xml");
|
||||
println!("cargo:rerun-if-changed={xml}");
|
||||
@@ -84,13 +93,43 @@ fn main() {
|
||||
let status = std::process::Command::new("wayland-scanner").args([mode, &xml]).arg(&target).status()
|
||||
.expect("Install wayland-scanner to build the Wayland backend");
|
||||
assert!(status.success(), "wayland-scanner failed");
|
||||
if mode == "private-code" { build.file(target); }
|
||||
if mode == "private-code" { sources.push(target.to_string_lossy().into_owned()); build.file(target); }
|
||||
}
|
||||
}
|
||||
println!("cargo:rerun-if-changed=c_engine/wayland_engine.c");
|
||||
build.compile("uu_wayland_engine");
|
||||
println!("cargo:rustc-link-lib=wayland-client");
|
||||
println!("cargo:rustc-link-lib=xkbcommon");
|
||||
if plugins {
|
||||
let sources: Vec<&str> = sources.iter().map(String::as_str).collect();
|
||||
match pkg_config(&["wayland-client", "xkbcommon"]) {
|
||||
Some((cflags, libs)) => shared_engine("libuu-wayland.so", &sources, &[out.as_path()], &cflags, &libs),
|
||||
None => println!("cargo:warning=wayland-client/xkbcommon not found: libuu-wayland.so not built"),
|
||||
}
|
||||
} else {
|
||||
build.compile("uu_wayland_engine");
|
||||
println!("cargo:rustc-link-lib=wayland-client");
|
||||
println!("cargo:rustc-link-lib=xkbcommon");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// `pkg-config --cflags` / `--libs` for `packages`, or None when any is missing.
|
||||
fn pkg_config(packages: &[&str]) -> Option<(String, String)> {
|
||||
let run = |kind: &str| std::process::Command::new("pkg-config").arg(kind).args(packages).output().ok()
|
||||
.filter(|o| o.status.success()).map(|o| String::from_utf8_lossy(&o.stdout).into_owned());
|
||||
run("--cflags").zip(run("--libs"))
|
||||
}
|
||||
|
||||
/// Builds an engine as a shared library for engine-plugins and places it next to the binaries
|
||||
/// (target/<profile>/), where the release workflow packages it. Not linked into uuremote-server.
|
||||
fn shared_engine(name: &str, sources: &[&str], includes: &[&std::path::Path], cflags: &str, libs: &str) {
|
||||
let out = std::path::PathBuf::from(std::env::var_os("OUT_DIR").unwrap());
|
||||
let library = out.join(name);
|
||||
let mut command = cc::Build::new().pic(true).opt_level(2).get_compiler().to_command();
|
||||
command.args(["-shared", "-fPIC", "-Wno-unused-parameter", "-Wl,-z,defs"]).arg(format!("-Wl,-soname,{name}")).arg("-o").arg(&library);
|
||||
for include in includes { command.arg("-I").arg(include); }
|
||||
command.args(cflags.split_whitespace()).args(sources).args(libs.split_whitespace()).arg("-lpthread");
|
||||
let status = command.status().expect("C compiler for the engine plugin");
|
||||
assert!(status.success(), "building {name} failed");
|
||||
// OUT_DIR = target/<profile>/build/<package>-<hash>/out
|
||||
if let Some(profile) = out.ancestors().nth(3) { std::fs::copy(&library, profile.join(name)).expect("copy engine plugin"); }
|
||||
}
|
||||
@@ -4,7 +4,7 @@
|
||||
mod native {
|
||||
use std::{ffi::c_void, ptr::NonNull};
|
||||
|
||||
extern "C" {
|
||||
crate::engine_ffi! { crate::engine_plugin::Engine::Portal;
|
||||
fn uu_desktop_power_wake() -> i32;
|
||||
fn uu_desktop_idle_inhibitor_acquire(error: *mut i32) -> *mut c_void;
|
||||
fn uu_desktop_idle_inhibitor_release(inhibitor: *mut c_void);
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
//! Optional desktop engines loaded at runtime (`--features engine-plugins`).
|
||||
//!
|
||||
//! The Wayland (wlroots) and GNOME/KDE portal engines link libwayland/libxkbcommon and
|
||||
//! GIO/PipeWire/libei. Linking them into `uuremote-server` would stop it from starting on X11 hosts
|
||||
//! without those libraries, and libei is missing on older distributions. With engine-plugins they
|
||||
//! are built as `libuu-wayland.so` / `libuu-portal.so`, shipped next to the binary, and opened with
|
||||
//! dlopen only when the session needs them, so one release package serves every backend.
|
||||
//! Without the feature the engines are linked statically as before and nothing here is used.
|
||||
#![cfg_attr(not(feature = "engine-plugins"), allow(dead_code))]
|
||||
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub enum Engine { Wayland, Portal }
|
||||
|
||||
impl Engine {
|
||||
pub fn file(self) -> &'static str { match self { Self::Wayland => "libuu-wayland.so", Self::Portal => "libuu-portal.so" } }
|
||||
fn index(self) -> usize { self as usize }
|
||||
}
|
||||
|
||||
/// Directories searched for engine libraries, in order.
|
||||
fn search_dirs() -> Vec<std::path::PathBuf> {
|
||||
let mut dirs = Vec::new();
|
||||
if let Some(dir) = std::env::var_os("UU_ENGINE_DIR").filter(|d| !d.is_empty()) { dirs.push(dir.into()); }
|
||||
if let Some(exe_dir) = std::env::current_exe().ok().and_then(|exe| exe.parent().map(|d| d.to_path_buf())) {
|
||||
dirs.push(exe_dir.join("../lib/uu-remote-linux"));
|
||||
dirs.push(exe_dir.clone());
|
||||
}
|
||||
if let Some(home) = std::env::var_os("HOME") { dirs.push(std::path::Path::new(&home).join(".local/lib/uu-remote-linux")); }
|
||||
dirs.extend(["/usr/local/lib/uu-remote-linux", "/usr/lib/uu-remote-linux"].map(std::path::PathBuf::from));
|
||||
dirs
|
||||
}
|
||||
|
||||
#[cfg(all(target_os = "linux", feature = "engine-plugins"))]
|
||||
mod native {
|
||||
use super::Engine;
|
||||
use std::sync::OnceLock;
|
||||
|
||||
static HANDLES: [OnceLock<Result<usize, String>>; 2] = [OnceLock::new(), OnceLock::new()];
|
||||
|
||||
fn dlerror() -> String {
|
||||
let message = unsafe { libc::dlerror() };
|
||||
if message.is_null() { return "unknown dlopen error".into(); }
|
||||
unsafe { std::ffi::CStr::from_ptr(message) }.to_string_lossy().into_owned()
|
||||
}
|
||||
|
||||
fn open(engine: Engine) -> Result<usize, String> {
|
||||
for dir in super::search_dirs() {
|
||||
let path = dir.join(engine.file());
|
||||
if !path.is_file() { continue; }
|
||||
use std::os::unix::ffi::OsStrExt;
|
||||
let Ok(c_path) = std::ffi::CString::new(path.as_os_str().as_bytes()) else { continue };
|
||||
let handle = unsafe { libc::dlopen(c_path.as_ptr(), libc::RTLD_NOW | libc::RTLD_LOCAL) };
|
||||
if handle.is_null() {
|
||||
// Usually a missing system library (e.g. libei.so.1) or a too old glibc.
|
||||
return Err(format!("{} could not be loaded: {}", path.display(), dlerror()));
|
||||
}
|
||||
log::info!("Desktop engine loaded: {}", path.display());
|
||||
return Ok(handle as usize);
|
||||
}
|
||||
Err(format!("{} not found (looked next to uuremote-server, in ../lib/uu-remote-linux, ~/.local/lib/uu-remote-linux, /usr/lib/uu-remote-linux; UU_ENGINE_DIR overrides)", engine.file()))
|
||||
}
|
||||
|
||||
pub fn load(engine: Engine) -> Result<(), String> {
|
||||
HANDLES[engine.index()].get_or_init(|| open(engine)).as_ref().map(|_| ()).map_err(Clone::clone)
|
||||
}
|
||||
|
||||
/// Address of `name` (NUL-terminated) in the engine, or 0 when the engine or symbol is missing.
|
||||
pub fn symbol(engine: Engine, name: &'static str) -> usize {
|
||||
let Ok(handle) = HANDLES[engine.index()].get_or_init(|| open(engine)) else { return 0 };
|
||||
let address = unsafe { libc::dlsym(*handle as *mut libc::c_void, name.as_ptr().cast()) };
|
||||
if address.is_null() { log::warn!("Desktop engine {} lacks {}", engine.file(), name.trim_end_matches('\0')); }
|
||||
address as usize
|
||||
}
|
||||
}
|
||||
|
||||
/// Loads `engine`, or explains why it is unavailable. Always Ok when the engines are linked in.
|
||||
pub fn load(engine: Engine) -> Result<(), String> {
|
||||
#[cfg(all(target_os = "linux", feature = "engine-plugins"))]
|
||||
{ native::load(engine) }
|
||||
#[cfg(not(all(target_os = "linux", feature = "engine-plugins")))]
|
||||
{ let _ = engine; Ok(()) }
|
||||
}
|
||||
|
||||
#[cfg(all(target_os = "linux", feature = "engine-plugins"))]
|
||||
pub use native::symbol;
|
||||
|
||||
/// Value returned by an engine call whose library could not be loaded (callers check `load` first).
|
||||
pub trait Missing { fn missing() -> Self; }
|
||||
impl Missing for () { fn missing() -> Self {} }
|
||||
impl Missing for i32 { fn missing() -> Self { -1 } }
|
||||
impl<T> Missing for *mut T { fn missing() -> Self { std::ptr::null_mut() } }
|
||||
|
||||
/// Declares engine C functions: an `extern "C"` block when linked statically, or dlsym-resolved
|
||||
/// wrappers with the same names and signatures with `engine-plugins`.
|
||||
#[macro_export]
|
||||
macro_rules! engine_ffi {
|
||||
($engine:expr; $(fn $name:ident($($arg:ident: $ty:ty),* $(,)?) $(-> $ret:ty)?;)*) => {
|
||||
#[cfg(not(feature = "engine-plugins"))]
|
||||
extern "C" { $(fn $name($($arg: $ty),*) $(-> $ret)?;)* }
|
||||
$(
|
||||
#[cfg(feature = "engine-plugins")]
|
||||
unsafe fn $name($($arg: $ty),*) $(-> $ret)? {
|
||||
static ADDRESS: std::sync::OnceLock<usize> = std::sync::OnceLock::new();
|
||||
let address = *ADDRESS.get_or_init(|| $crate::engine_plugin::symbol($engine, concat!(stringify!($name), "\0")));
|
||||
if address == 0 { return $crate::engine_plugin::Missing::missing(); }
|
||||
let function: unsafe extern "C" fn($($ty),*) $(-> $ret)? = unsafe { std::mem::transmute(address) };
|
||||
unsafe { function($($arg),*) }
|
||||
}
|
||||
)*
|
||||
};
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#[test]
|
||||
fn search_prefers_override_then_package_layout() {
|
||||
let dirs = super::search_dirs();
|
||||
let exe_dir = std::env::current_exe().unwrap().parent().unwrap().to_path_buf();
|
||||
assert!(dirs.iter().position(|d| *d == exe_dir.join("../lib/uu-remote-linux")) < dirs.iter().position(|d| *d == exe_dir));
|
||||
assert_eq!(dirs.last().unwrap(), std::path::Path::new("/usr/lib/uu-remote-linux"));
|
||||
}
|
||||
}
|
||||
+4
-2
@@ -1,6 +1,7 @@
|
||||
//! UU Remote Pure Native Linux Server (Rust Edition)
|
||||
//! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated
|
||||
|
||||
mod engine_plugin;
|
||||
mod desktop_backend;
|
||||
mod desktop_session;
|
||||
mod desktop_power;
|
||||
@@ -412,8 +413,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
let capture = Arc::new((if desktop_backend::headless() {
|
||||
Err("headless mode (UU_DESKTOP_BACKEND=none)".to_owned())
|
||||
} else if desktop_backend::detect()?==desktop_backend::DesktopBackend::Portal {
|
||||
Err(if cfg!(feature = "portal") { "Portal capture waits for a desktop CONTROL connection".to_owned() }
|
||||
else { portal::NOT_BUILT.to_owned() })
|
||||
Err(if !cfg!(feature = "portal") { portal::NOT_BUILT.to_owned() }
|
||||
else if let Err(reason) = engine_plugin::load(engine_plugin::Engine::Portal) { format!("GNOME/KDE Wayland (portal) engine unavailable: {reason}") }
|
||||
else { "Portal capture waits for a desktop CONTROL connection".to_owned() })
|
||||
} else { ScreenCapture::new() }).unwrap_or_else(|error| {
|
||||
log::warn!("Desktop unavailable; terminal and file tools remain available: {error}");
|
||||
ScreenCapture::unavailable(error)
|
||||
|
||||
+7
-2
@@ -22,7 +22,7 @@ mod permissions;
|
||||
#[cfg(all(target_os = "linux", feature = "portal"))]
|
||||
mod native {
|
||||
use std::{ffi::c_void, ptr::NonNull, sync::{Mutex, MutexGuard, TryLockError}};
|
||||
extern "C" {
|
||||
crate::engine_ffi! { crate::engine_plugin::Engine::Portal;
|
||||
fn uu_portal_open_persist(restore: *const libc::c_char, save: extern "C" fn(*const libc::c_char, *mut c_void), data: *mut c_void, error: *mut i32, width: *mut u32, height: *mut u32) -> *mut c_void;
|
||||
fn uu_portal_open_persist_cancellable(restore: *const libc::c_char, save: extern "C" fn(*const libc::c_char, *mut c_void), save_data: *mut c_void, cancelled: extern "C" fn(*mut c_void) -> i32, cancel_data: *mut c_void, error: *mut i32, width: *mut u32, height: *mut u32) -> *mut c_void;
|
||||
fn uu_portal_clipboard_supported(portal: *mut c_void) -> i32;
|
||||
@@ -116,6 +116,8 @@ mod native {
|
||||
if cancelled.is_some_and(|value| value.load(std::sync::atomic::Ordering::Acquire)) {
|
||||
return Err(super::PortalError { code: 13 });
|
||||
}
|
||||
// engine-plugins: libuu-portal.so (or one of its libraries) may be missing on this host.
|
||||
crate::engine_plugin::load(crate::engine_plugin::Engine::Portal).map_err(|_| super::PortalError { code: 15 })?;
|
||||
let (mut error, mut width, mut height) = (0, 0, 0);
|
||||
let directory = super::permissions::directory();
|
||||
let key = super::permissions::desktop_key();
|
||||
@@ -584,7 +586,10 @@ fn error(code: i32) -> String {
|
||||
8 => "unsupported frame format or size", 9 => "session closed or stream lost",
|
||||
10 => "frame unavailable", 11 => "invalid input or frame buffer",
|
||||
13 => "operation cancelled", 14 => "dimensions changed; reconnect required",
|
||||
15 => return NOT_BUILT.into(),
|
||||
15 => return match crate::engine_plugin::load(crate::engine_plugin::Engine::Portal) {
|
||||
Err(reason) if cfg!(feature = "portal") => format!("GNOME/KDE Wayland (portal) engine unavailable: {reason}"),
|
||||
_ => NOT_BUILT.into(),
|
||||
},
|
||||
_ => "operation failed",
|
||||
};
|
||||
format!("Portal {reason} (code {code})")
|
||||
|
||||
+2
-1
@@ -1,6 +1,6 @@
|
||||
//! Hyprland/wlroots native backend. No XWayland fallback and no input logging.
|
||||
#[cfg(all(target_os="linux", feature="wayland"))]
|
||||
extern "C" {
|
||||
crate::engine_ffi! { crate::engine_plugin::Engine::Wayland;
|
||||
fn uu_wl_init(out_w: *mut i32, out_h: *mut i32) -> i32;
|
||||
fn uu_wl_capture(buffer: *mut u8, length: usize) -> i32;
|
||||
fn uu_wl_move(x: i32, y: i32, relative: i32) -> i32;
|
||||
@@ -38,6 +38,7 @@ pub fn release_all()->i32 {
|
||||
pub fn init() -> Result<(u32,u32),String> {
|
||||
#[cfg(all(target_os="linux", feature="wayland"))]
|
||||
{
|
||||
crate::engine_plugin::load(crate::engine_plugin::Engine::Wayland).map_err(|reason| format!("Wayland engine unavailable: {reason}"))?;
|
||||
let (mut w,mut h)=(0,0);
|
||||
let result=unsafe { uu_wl_init(&mut w,&mut h) };
|
||||
if result != 0 || w <= 0 || h <= 0 {
|
||||
|
||||
Reference in new issue
Block a user