Merge pull request #231 from alxndrv/add-lslocks

Add partial implementation of `lslocks`

Cargo.lock

@@ -984,6 +984,7 @@ dependencies = [
  "uu_fsfreeze",
  "uu_last",
  "uu_lscpu",
+ "uu_lslocks",
  "uu_lsmem",
  "uu_mountpoint",
  "uu_rev",
@@ -1056,6 +1057,16 @@ dependencies = [
  "uucore",
 ]
 
+[[package]]
+name = "uu_lslocks"
+version = "0.0.1"
+dependencies = [
+ "clap",
+ "serde",
+ "serde_json",
+ "uucore",
+]
+
 [[package]]
 name = "uu_lsmem"
 version = "0.0.1"

Cargo.toml

@@ -32,6 +32,7 @@ feat_common_core = [
   "fsfreeze",
   "last",
   "lscpu",
+  "lslocks",
   "lsmem",
   "mountpoint",
   "rev",
@@ -76,6 +77,7 @@ dmesg = { optional = true, version = "0.0.1", package = "uu_dmesg", path = "src/
 fsfreeze = { optional = true, version = "0.0.1", package = "uu_fsfreeze", path = "src/uu/fsfreeze" }
 last = { optional = true, version = "0.0.1", package = "uu_last", path = "src/uu/last" }
 lscpu = { optional = true, version = "0.0.1", package = "uu_lscpu", path = "src/uu/lscpu" }
+lslocks = { optional = true, version = "0.0.1", package = "uu_lslocks", path = "src/uu/lslocks" }
 lsmem = { optional = true, version = "0.0.1", package = "uu_lsmem", path = "src/uu/lsmem" }
 mountpoint = { optional = true, version = "0.0.1", package = "uu_mountpoint", path = "src/uu/mountpoint" }
 rev = { optional = true, version = "0.0.1", package = "uu_rev", path = "src/uu/rev" }

src/uu/lslocks/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "uu_lslocks"
+version = "0.0.1"
+edition = "2021"
+
+[lib]
+path = "src/lslocks.rs"
+
+[[bin]]
+name = "lslocks"
+path = "src/main.rs"
+
+[dependencies]
+uucore = { workspace = true }
+clap = { workspace = true }
+serde = { workspace = true }
+serde_json = { workspace = true }

src/uu/lslocks/lslocks.md

@@ -0,0 +1,7 @@
+# lslocks
+
+```
+lslocks [OPTION]...
+```
+
+lists system locks

src/uu/lslocks/src/lslocks.rs

@@ -0,0 +1,306 @@
+// This file is part of the uutils util-linux package.
+//
+// For the full copyright and license information, please view the LICENSE
+// file that was distributed with this source code.
+
+use std::{fmt, fs, str::FromStr};
+
+use clap::{crate_version, Command};
+use uucore::{error::UResult, format_usage, help_about, help_usage};
+
+// See https://www.man7.org/linux/man-pages/man5/proc_locks.5.html for details on each field's meaning
+#[derive(Debug)]
+struct Lock {
+    _ord: usize,
+    lock_type: LockType,
+    mandatory: bool,
+    mode: LockMode,
+    pid: Option<usize>, // This value is -1 for OFD locks, hence the Option
+    major_minor: String,
+    inode: usize,
+    start_offset: usize,       // Byte offset to start of lock
+    end_offset: Option<usize>, // None = lock does not have an explicit end offset and applies until the end of the file
+}
+
+impl Lock {
+    fn get_value(&self, col: &Column) -> String {
+        match col {
+            Column::Command => resolve_command(self).unwrap_or("<unknown>".to_string()),
+            Column::Pid => self
+                .pid
+                .map(|pid| pid.to_string())
+                .unwrap_or("-".to_string()),
+            Column::Type => self.lock_type.to_string(),
+            Column::Size => todo!(),
+            Column::Inode => self.inode.to_string(),
+            Column::MajorMinor => self.major_minor.clone(),
+            Column::Mode => self.mode.to_string(),
+            Column::Mandatory => {
+                if self.mandatory {
+                    "1".to_string()
+                } else {
+                    "0".to_string()
+                }
+            }
+            Column::Start => self.start_offset.to_string(),
+            // TODO: In the case of EOF end_offset, we should actually resolve the actual file size and display that as the end offset
+            Column::End => self
+                .end_offset
+                .map(|offset| offset.to_string())
+                .unwrap_or("EOF".to_string()),
+            Column::Path => todo!(), // TODO: Resolve filepath of the lock target
+            Column::Blocker => todo!(), // TODO: Check if lock is blocker (and by what)
+            Column::Holders => todo!(), // TODO: Resolve all holders of the lock (this would also let us display a process/PID for OFD locks)
+        }
+    }
+}
+
+impl FromStr for Lock {
+    type Err = ();
+    fn from_str(input: &str) -> Result<Self, Self::Err> {
+        let mut parts = input.split_whitespace();
+
+        // Ordinal position comes in the form of `<value>:`, so we need to strip away the `:`
+        let ord = parts
+            .next()
+            .and_then(|s| s.strip_suffix(":"))
+            .unwrap()
+            .parse::<usize>()
+            .unwrap();
+        let lock_type = parts
+            .next()
+            .and_then(|part| LockType::from_str(part).ok())
+            .unwrap();
+        let mandatory = parts
+            .next()
+            .map(|part| match part {
+                "MANDATORY" => true,
+                "ADVISORY" => false,
+                _ => panic!("Unrecognized value in lock line: {}", part),
+            })
+            .unwrap();
+        let mode = parts
+            .next()
+            .and_then(|part| LockMode::from_str(part).ok())
+            .unwrap();
+        let pid: Option<usize> = parts.next().and_then(|pid_str| match pid_str {
+            "-1" => None,
+            other => other.parse::<usize>().ok(),
+        });
+
+        if lock_type == LockType::OFDLCK && pid.is_some() {
+            println!("Unexpected PID value on OFD lock: '{}'", input);
+            return Err(());
+        };
+
+        // This field has a format of MAJOR:MINOR:INODE
+        let major_minor_inode: Vec<_> = parts.next().unwrap().split(":").collect();
+        assert_eq!(major_minor_inode.len(), 3);
+        let major_minor = [major_minor_inode[0], major_minor_inode[1]].join(":");
+        let inode = major_minor_inode[2].parse::<usize>().unwrap();
+
+        let start_offset = parts.next().unwrap().parse::<usize>().unwrap();
+        let end_offset: Option<usize> = parts.next().and_then(|offset_str| match offset_str {
+            "EOF" => None,
+            other => other.parse::<usize>().ok(),
+        });
+
+        Ok(Self {
+            _ord: ord,
+            lock_type,
+            mandatory,
+            mode,
+            pid,
+            major_minor,
+            inode,
+            start_offset,
+            end_offset,
+        })
+    }
+}
+
+#[derive(Debug, PartialEq, Eq)]
+#[allow(clippy::upper_case_acronyms)]
+enum LockType {
+    FLOCK,  // BSD file lock
+    OFDLCK, // Open file descriptor
+    POSIX,  // POSIX byte-range lock
+}
+
+impl FromStr for LockType {
+    type Err = ();
+    fn from_str(input: &str) -> Result<Self, Self::Err> {
+        match input {
+            "FLOCK" => Ok(Self::FLOCK),
+            "OFDLCK" => Ok(Self::OFDLCK),
+            "POSIX" => Ok(Self::POSIX),
+            _ => Err(()),
+        }
+    }
+}
+
+impl fmt::Display for LockType {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            LockType::FLOCK => write!(f, "FLOCK"),
+            LockType::OFDLCK => write!(f, "OFDLCK"),
+            LockType::POSIX => write!(f, "POSIX"),
+        }
+    }
+}
+
+#[derive(Debug)]
+enum LockMode {
+    Read,
+    Write,
+}
+
+impl FromStr for LockMode {
+    type Err = ();
+    fn from_str(input: &str) -> Result<Self, Self::Err> {
+        match input {
+            "WRITE" => Ok(Self::Write),
+            "READ" => Ok(Self::Read),
+            _ => Err(()),
+        }
+    }
+}
+
+impl fmt::Display for LockMode {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            LockMode::Write => write!(f, "WRITE"),
+            LockMode::Read => write!(f, "READ"),
+        }
+    }
+}
+
+// All of the columns that need to be supported in the final version
+#[derive(Clone)]
+#[allow(dead_code)]
+enum Column {
+    Command,
+    Pid,
+    Type,
+    Size,
+    Inode,
+    MajorMinor,
+    Mode,
+    Mandatory,
+    Start,
+    End,
+    Path,
+    Blocker,
+    Holders,
+}
+
+impl Column {
+    fn header_text(&self) -> &'static str {
+        match self {
+            Self::Command => "COMMAND",
+            Self::Pid => "PID",
+            Self::Type => "TYPE",
+            Self::Size => "SIZE",
+            Self::Inode => "INODE",
+            Self::MajorMinor => "MAJ:MIN",
+            Self::Mode => "MODE",
+            Self::Mandatory => "M",
+            Self::Start => "START",
+            Self::End => "END",
+            Self::Path => "PATH",
+            Self::Blocker => "BLOCKER",
+            Self::Holders => "HOLDERS",
+        }
+    }
+}
+
+fn resolve_command(lock: &Lock) -> Option<String> {
+    if let Some(pid) = lock.pid {
+        return fs::read_to_string(format!("/proc/{}/comm", pid))
+            .map(|content| content.trim().to_string())
+            .ok();
+    }
+
+    // File descriptor locks don't have a real notion of an "owner process", since it can be shared by multiple processes.
+    // The original `lslocks` goes through `/proc/<pid>/fdinfo/*` to find *any* of the processes that reference the same device/inode combo from the lock
+    // We don't implement this behaviour yet, and just show "unknown" for the locks which don't have a clear owner
+    None
+}
+
+const DEFAULT_COLS: &[Column] = &[
+    Column::Command,
+    Column::Pid,
+    Column::Type,
+    //TODO: Implement Column::Size here
+    Column::Mode,
+    Column::Mandatory,
+    Column::Start,
+    Column::End,
+    //TODO: Implements Column::Path here
+];
+
+struct OutputOptions {
+    cols: Vec<Column>,
+}
+
+fn print_output(locks: Vec<Lock>, output_opts: OutputOptions) {
+    let mut column_widths: Vec<_> = output_opts
+        .cols
+        .iter()
+        .map(|col| col.header_text().len())
+        .collect();
+
+    for lock in &locks {
+        for (i, col) in output_opts.cols.iter().enumerate() {
+            column_widths[i] = column_widths[i].max(lock.get_value(col).len());
+        }
+    }
+
+    let headers: Vec<_> = output_opts
+        .cols
+        .iter()
+        .enumerate()
+        .map(|(i, col)| format!("{:<width$}", col.header_text(), width = column_widths[i]))
+        .collect();
+
+    println!("{}", headers.join(" "));
+
+    for lock in &locks {
+        let values: Vec<_> = output_opts
+            .cols
+            .iter()
+            .enumerate()
+            .map(|(i, col)| format!("{:<width$}", lock.get_value(col), width = column_widths[i]))
+            .collect();
+        println!("{}", values.join(" "));
+    }
+}
+
+#[uucore::main]
+pub fn uumain(_args: impl uucore::Args) -> UResult<()> {
+    let output_opts = OutputOptions {
+        cols: Vec::from(DEFAULT_COLS),
+    };
+
+    let locks: Vec<_> = match fs::read_to_string("/proc/locks") {
+        Ok(content) => content
+            .lines()
+            .map(|line| Lock::from_str(line).unwrap())
+            .collect(),
+        Err(e) => panic!("Could not read /proc/locks: {}", e),
+    };
+
+    print_output(locks, output_opts);
+    Ok(())
+}
+
+const ABOUT: &str = help_about!("lslocks.md");
+const USAGE: &str = help_usage!("lslocks.md");
+
+pub fn uu_app() -> Command {
+    Command::new(uucore::util_name())
+        .version(crate_version!())
+        .about(ABOUT)
+        .override_usage(format_usage(USAGE))
+        .infer_long_args(true)
+}

src/uu/lslocks/src/main.rs

@@ -0,0 +1 @@
+uucore::bin!(uu_lslocks);

tests/by-util/test_lslocks.rs

@@ -0,0 +1,22 @@
+// This file is part of the uutils util-linux package.
+//
+// For the full copyright and license information, please view the LICENSE
+// file that was distributed with this source code.
+
+use crate::common::util::TestScenario;
+
+#[test]
+#[cfg(target_os = "linux")]
+fn test_column_headers() {
+    let res = new_ucmd!().succeeds();
+    let stdout = res.no_stderr().stdout_str();
+
+    let header_line = stdout.lines().next().unwrap();
+    let cols: Vec<_> = header_line.split_whitespace().collect();
+
+    assert_eq!(cols.len(), 7);
+    assert_eq!(
+        cols,
+        vec!["COMMAND", "PID", "TYPE", "MODE", "M", "START", "END"]
+    );
+}

tests/tests.rs

@@ -13,6 +13,10 @@ mod test_lscpu;
 #[path = "by-util/test_lsmem.rs"]
 mod test_lsmem;
 
+#[cfg(feature = "lslocks")]
+#[path = "by-util/test_lslocks.rs"]
+mod test_lslocks;
+
 #[cfg(feature = "mountpoint")]
 #[path = "by-util/test_mountpoint.rs"]
 mod test_mountpoint;