diff options
Diffstat (limited to 'src/utils.rs')
| -rw-r--r-- | src/utils.rs | 421 |
1 files changed, 0 insertions, 421 deletions
diff --git a/src/utils.rs b/src/utils.rs deleted file mode 100644 index 5801de9e..00000000 --- a/src/utils.rs +++ /dev/null @@ -1,421 +0,0 @@ -use std::ffi::{CString, OsStr}; -use std::io::{self, Write}; -use std::os::fd::{AsFd, AsRawFd, FromRawFd, OwnedFd}; -use std::os::unix::prelude::OsStrExt; -use std::os::unix::process::CommandExt; -use std::path::PathBuf; -use std::process::{Command, Stdio}; -use std::ptr::null_mut; -use std::sync::atomic::{AtomicBool, Ordering}; -use std::thread; -use std::time::Duration; - -use anyhow::{ensure, Context}; -use directories::UserDirs; -use git_version::git_version; -use libc::close_range; -use niri_config::Config; -use smithay::output::Output; -use smithay::reexports::rustix; -use smithay::reexports::rustix::io::{close, read, retry_on_intr, write}; -use smithay::reexports::rustix::pipe::{pipe_with, PipeFlags}; -use smithay::reexports::rustix::time::{clock_gettime, ClockId}; -use smithay::utils::{Logical, Point, Rectangle, Size}; - -pub fn clone2<T: Clone, U: Clone>(t: (&T, &U)) -> (T, U) { - (t.0.clone(), t.1.clone()) -} - -pub fn version() -> String { - format!( - "{} ({})", - env!("CARGO_PKG_VERSION"), - git_version!(fallback = "unknown commit"), - ) -} - -pub fn get_monotonic_time() -> Duration { - let ts = clock_gettime(ClockId::Monotonic); - Duration::new(ts.tv_sec as u64, ts.tv_nsec as u32) -} - -pub fn center(rect: Rectangle<i32, Logical>) -> Point<i32, Logical> { - rect.loc + rect.size.downscale(2).to_point() -} - -pub fn output_size(output: &Output) -> Size<i32, Logical> { - let output_scale = output.current_scale().integer_scale(); - let output_transform = output.current_transform(); - let output_mode = output.current_mode().unwrap(); - - output_transform - .transform_size(output_mode.size) - .to_logical(output_scale) -} - -pub fn make_screenshot_path(config: &Config) -> anyhow::Result<Option<PathBuf>> { - let Some(path) = &config.screenshot_path else { - return Ok(None); - }; - - let format = CString::new(path.clone()).context("path must not contain nul bytes")?; - - let mut buf = [0u8; 2048]; - let mut path; - unsafe { - let time = libc::time(null_mut()); - ensure!(time != -1, "error in time()"); - - let tm = libc::localtime(&time); - ensure!(!tm.is_null(), "error in localtime()"); - - let rv = libc::strftime(buf.as_mut_ptr().cast(), buf.len(), format.as_ptr(), tm); - ensure!(rv != 0, "error formatting time"); - - path = PathBuf::from(OsStr::from_bytes(&buf[..rv])); - } - - if let Ok(rest) = path.strip_prefix("~") { - let dirs = UserDirs::new().context("error retrieving home directory")?; - path = [dirs.home_dir(), rest].iter().collect(); - } - - Ok(Some(path)) -} - -pub static REMOVE_ENV_RUST_BACKTRACE: AtomicBool = AtomicBool::new(false); -pub static REMOVE_ENV_RUST_LIB_BACKTRACE: AtomicBool = AtomicBool::new(false); - -/// Spawns the command to run independently of the compositor. -pub fn spawn<T: AsRef<OsStr> + Send + 'static>(command: Vec<T>) { - let _span = tracy_client::span!(); - - if command.is_empty() { - return; - } - - // Spawning and waiting takes some milliseconds, so do it in a thread. - let res = thread::Builder::new() - .name("Command Spawner".to_owned()) - .spawn(move || { - let (command, args) = command.split_first().unwrap(); - spawn_sync(command, args); - }); - - if let Err(err) = res { - warn!("error spawning a thread to spawn the command: {err:?}"); - } -} - -fn spawn_sync(command: impl AsRef<OsStr>, args: impl IntoIterator<Item = impl AsRef<OsStr>>) { - let _span = tracy_client::span!(); - - let command = command.as_ref(); - - let mut process = Command::new(command); - process - .args(args) - .stdin(Stdio::null()) - .stdout(Stdio::null()) - .stderr(Stdio::null()); - - // Remove RUST_BACKTRACE and RUST_LIB_BACKTRACE from the environment if needed. - if REMOVE_ENV_RUST_BACKTRACE.load(Ordering::Relaxed) { - process.env_remove("RUST_BACKTRACE"); - } - if REMOVE_ENV_RUST_LIB_BACKTRACE.load(Ordering::Relaxed) { - process.env_remove("RUST_LIB_BACKTRACE"); - } - - // When running as a systemd session, we want to put children into their own transient scopes - // in order to separate them from the niri process. This is helpful for example to prevent the - // OOM killer from taking down niri together with a misbehaving client. - // - // Putting a child into a scope is done by calling systemd's StartTransientUnit D-Bus method - // with a PID. Unfortunately, there seems to be a race in systemd where if the child exits at - // just the right time, the transient unit will be created but empty, so it will linger around - // forever. - // - // To prevent this, we'll use our double-fork (done for a separate reason) to help. In our - // intermediate child we will send back the grandchild PID, and in niri we will create a - // transient scope with both our intermediate child and the grandchild PIDs set. Only then we - // will signal our intermediate child to exit. This way, even if the grandchild exits quickly, - // a non-empty scope will be created (with just our intermediate child), then cleaned up when - // our intermediate child exits. - - // Make a pipe to receive the grandchild PID. - let (pipe_pid_read, pipe_pid_write) = pipe_with(PipeFlags::CLOEXEC) - .map_err(|err| { - warn!("error creating a pipe to transfer child PID: {err:?}"); - }) - .ok() - .unzip(); - // Make a pipe to wait in the intermediate child. - let (pipe_wait_read, pipe_wait_write) = pipe_with(PipeFlags::CLOEXEC) - .map_err(|err| { - warn!("error creating a pipe for child to wait on: {err:?}"); - }) - .ok() - .unzip(); - - unsafe { - // The fds will be duplicated after a fork and closed on exec or exit automatically. Get - // the raw fd inside so that it's not closed any extra times. - let mut pipe_pid_read_fd = pipe_pid_read.as_ref().map(|fd| fd.as_raw_fd()); - let mut pipe_pid_write_fd = pipe_pid_write.as_ref().map(|fd| fd.as_raw_fd()); - let mut pipe_wait_read_fd = pipe_wait_read.as_ref().map(|fd| fd.as_raw_fd()); - let mut pipe_wait_write_fd = pipe_wait_write.as_ref().map(|fd| fd.as_raw_fd()); - - // Double-fork to avoid having to waitpid the child. - process.pre_exec(move || { - // Close FDs that we don't need. Especially important for the write ones to unblock the - // readers. - if let Some(fd) = pipe_pid_read_fd.take() { - close(fd); - } - if let Some(fd) = pipe_wait_write_fd.take() { - close(fd); - } - - // Convert the our FDs to OwnedFd, which will close them in all of our fork paths. - let pipe_pid_write = pipe_pid_write_fd.take().map(|fd| OwnedFd::from_raw_fd(fd)); - let pipe_wait_read = pipe_wait_read_fd.take().map(|fd| OwnedFd::from_raw_fd(fd)); - - match libc::fork() { - -1 => return Err(io::Error::last_os_error()), - 0 => (), - grandchild_pid => { - // Send back the PID. - if let Some(pipe) = pipe_pid_write { - let _ = write_all(pipe, &grandchild_pid.to_ne_bytes()); - } - - // Wait until the parent signals us to exit. - if let Some(pipe) = pipe_wait_read { - // We're going to exit afterwards. Close all other FDs to allow - // Command::spawn() to return in the parent process. - let raw = pipe.as_raw_fd() as u32; - let _ = close_range(0, raw - 1, 0); - let _ = close_range(raw + 1, !0, 0); - - let _ = read_all(pipe, &mut [0]); - } - - libc::_exit(0) - } - } - - Ok(()) - }); - } - - let mut child = match process.spawn() { - Ok(child) => child, - Err(err) => { - warn!("error spawning {command:?}: {err:?}"); - return; - } - }; - - drop(pipe_pid_write); - drop(pipe_wait_read); - - // Wait for the grandchild PID. - if let Some(pipe) = pipe_pid_read { - let mut buf = [0; 4]; - match read_all(pipe, &mut buf) { - Ok(()) => { - let pid = i32::from_ne_bytes(buf); - trace!("spawned PID: {pid}"); - - // Start a systemd scope for the grandchild. - #[cfg(feature = "systemd")] - if let Err(err) = start_systemd_scope(command, child.id(), pid as u32) { - trace!("error starting systemd scope for spawned command: {err:?}"); - } - } - Err(err) => { - warn!("error reading child PID: {err:?}"); - } - } - } - - // Signal the intermediate child to exit now that we're done trying to creating a systemd scope. - trace!("signaling child to exit"); - drop(pipe_wait_write); - - match child.wait() { - Ok(status) => { - if !status.success() { - warn!("child did not exit successfully: {status:?}"); - } - } - Err(err) => { - warn!("error waiting for child: {err:?}"); - } - } -} - -fn write_all(fd: impl AsFd, buf: &[u8]) -> rustix::io::Result<()> { - let mut written = 0; - loop { - let n = retry_on_intr(|| write(&fd, &buf[written..]))?; - if n == 0 { - return Err(rustix::io::Errno::CANCELED); - } - - written += n; - if written == buf.len() { - return Ok(()); - } - } -} - -fn read_all(fd: impl AsFd, buf: &mut [u8]) -> rustix::io::Result<()> { - let mut start = 0; - loop { - let n = retry_on_intr(|| read(&fd, &mut buf[start..]))?; - if n == 0 { - return Err(rustix::io::Errno::CANCELED); - } - - start += n; - if start == buf.len() { - return Ok(()); - } - } -} - -pub static IS_SYSTEMD_SERVICE: AtomicBool = AtomicBool::new(false); - -/// Puts a (newly spawned) pid into a transient systemd scope. -/// -/// This separates the pid from the compositor scope, which for example prevents the OOM killer -/// from bringing down the compositor together with a misbehaving client. -#[cfg(feature = "systemd")] -fn start_systemd_scope(name: &OsStr, intermediate_pid: u32, child_pid: u32) -> anyhow::Result<()> { - use std::fmt::Write as _; - use std::path::Path; - use std::sync::OnceLock; - - use zbus::zvariant::{OwnedObjectPath, Value}; - - // We only start transient scopes if we're a systemd service ourselves. - if !IS_SYSTEMD_SERVICE.load(Ordering::Relaxed) { - return Ok(()); - } - - let _span = tracy_client::span!(); - - // Extract the basename. - let name = Path::new(name).file_name().unwrap_or(name); - - let mut scope_name = String::from("app-niri-"); - - // Escape for systemd similarly to libgnome-desktop, which says it had adapted this from - // systemd source. - for &c in name.as_bytes() { - if c.is_ascii_alphanumeric() || matches!(c, b':' | b'_' | b'.') { - scope_name.push(char::from(c)); - } else { - let _ = write!(scope_name, "\\x{c:02x}"); - } - } - - let _ = write!(scope_name, "-{child_pid}.scope"); - - // Ask systemd to start a transient scope. - static CONNECTION: OnceLock<zbus::Result<zbus::blocking::Connection>> = OnceLock::new(); - let conn = CONNECTION - .get_or_init(zbus::blocking::Connection::session) - .clone() - .context("error connecting to session bus")?; - - let proxy = zbus::blocking::Proxy::new( - &conn, - "org.freedesktop.systemd1", - "/org/freedesktop/systemd1", - "org.freedesktop.systemd1.Manager", - ) - .context("error creating a Proxy")?; - - let signals = proxy - .receive_signal("JobRemoved") - .context("error creating a signal iterator")?; - - let pids: &[_] = &[intermediate_pid, child_pid]; - let properties: &[_] = &[ - ("PIDs", Value::new(pids)), - ("CollectMode", Value::new("inactive-or-failed")), - ]; - let aux: &[(&str, &[(&str, Value)])] = &[]; - - let job: OwnedObjectPath = proxy - .call("StartTransientUnit", &(scope_name, "fail", properties, aux)) - .context("error calling StartTransientUnit")?; - - trace!("waiting for JobRemoved"); - for message in signals { - let body: (u32, OwnedObjectPath, &str, &str) = - message.body().context("error parsing signal")?; - - if body.1 == job { - // Our transient unit had started, we're good to exit the intermediate child. - break; - } - } - - Ok(()) -} - -pub fn write_png_rgba8( - w: impl Write, - width: u32, - height: u32, - pixels: &[u8], -) -> Result<(), png::EncodingError> { - let mut encoder = png::Encoder::new(w, width, height); - encoder.set_color(png::ColorType::Rgba); - encoder.set_depth(png::BitDepth::Eight); - - let mut writer = encoder.write_header()?; - writer.write_image_data(pixels) -} - -#[cfg(feature = "dbus")] -pub fn show_screenshot_notification(image_path: Option<PathBuf>) { - let mut notification = notify_rust::Notification::new(); - notification - .summary("Screenshot captured") - .body("You can paste the image from the clipboard.") - .urgency(notify_rust::Urgency::Normal) - .hint(notify_rust::Hint::Transient(true)); - - // Try to add the screenshot as an image if possible. - if let Some(path) = image_path { - match path.canonicalize() { - Ok(path) => match url::Url::from_file_path(path) { - Ok(url) => { - notification.image_path(url.as_str()); - } - Err(err) => { - warn!("error converting screenshot path to file url: {err:?}"); - } - }, - Err(err) => { - warn!("error canonicalizing screenshot path: {err:?}"); - } - } - } - - if let Err(err) = notification.show() { - warn!("error showing screenshot notification: {err:?}"); - } -} - -#[inline(never)] -pub fn cause_panic() { - let a = Duration::from_secs(1); - let b = Duration::from_secs(2); - let _ = a - b; -} |