Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/uu/pgrep/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ categories = ["command-line-utilities"]


[dependencies]
uucore = { workspace = true }
uucore = { workspace = true, features = ["entries"] }
clap = { workspace = true }
walkdir = { workspace = true }
regex = { workspace = true }
Expand Down
50 changes: 50 additions & 0 deletions src/uu/pgrep/src/process.rs
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,43 @@ impl ProcessInformation {
Ok(time)
}

pub fn ppid(&mut self) -> Result<u64, io::Error> {
// the PPID is the fourth field in /proc/<PID>/stat
// (https://www.kernel.org/doc/html/latest/filesystems/proc.html#id10)
self.stat()
.get(3)
.ok_or(io::ErrorKind::InvalidData)?
.parse::<u64>()
.map_err(|_| io::ErrorKind::InvalidData.into())
}

fn get_uid_or_gid_field(&mut self, field: &str, index: usize) -> Result<u32, io::Error> {
self.status()
.get(field)
.ok_or(io::ErrorKind::InvalidData)?
.split_whitespace()
.nth(index)
.ok_or(io::ErrorKind::InvalidData)?
.parse::<u32>()
.map_err(|_| io::ErrorKind::InvalidData.into())
}

pub fn uid(&mut self) -> Result<u32, io::Error> {
self.get_uid_or_gid_field("Uid", 0)
}

pub fn euid(&mut self) -> Result<u32, io::Error> {
self.get_uid_or_gid_field("Uid", 1)
}

pub fn gid(&mut self) -> Result<u32, io::Error> {
self.get_uid_or_gid_field("Gid", 0)
}

pub fn egid(&mut self) -> Result<u32, io::Error> {
self.get_uid_or_gid_field("Gid", 1)
}

/// Fetch run state from [ProcessInformation::cached_stat]
///
/// - [The /proc Filesystem: Table 1-4](https://docs.kernel.org/filesystems/proc.html#id10)
Expand Down Expand Up @@ -507,4 +544,17 @@ mod tests {
let case = "83875 (sleep (2) .sh) S 75750 83875 75750 34824 83875 4194304 173 0 0 0 0 0 0 0 20 0 1 0 18366278 23187456 821 18446744073709551615 94424231874560 94424232638561 140734866834816 0 0 0 65536 4 65538 1 0 0 17 6 0 0 0 0 0 94424232876752 94424232924772 94424259932160 140734866837287 140734866837313 140734866837313 140734866841576 0";
assert!(stat_split(case)[1] == "sleep (2) .sh");
}

#[test]
#[cfg(target_os = "linux")]
fn test_uid_gid() {
let mut pid_entry = ProcessInformation::try_new(
PathBuf::from_str(&format!("/proc/{}", current_pid())).unwrap(),
)
.unwrap();
assert_eq!(pid_entry.uid().unwrap(), uucore::process::getuid());
assert_eq!(pid_entry.euid().unwrap(), uucore::process::geteuid());
assert_eq!(pid_entry.gid().unwrap(), uucore::process::getgid());
assert_eq!(pid_entry.egid().unwrap(), uucore::process::getegid());
}
}
106 changes: 78 additions & 28 deletions src/uu/pgrep/src/process_matcher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,19 @@

// Common process matcher logic shared by pgrep, pkill and pidwait

use std::collections::HashSet;
use std::hash::Hash;
use std::{collections::HashSet, io};

use clap::{arg, Arg, ArgAction, ArgMatches};
use regex::Regex;
use uucore::error::{UResult, USimpleError};
#[cfg(unix)]
use uucore::{display::Quotable, signals::signal_by_name_or_value};
use uucore::{
display::Quotable,
entries::{grp2gid, usr2uid},
signals::signal_by_name_or_value,
};

use uucore::error::{UResult, USimpleError};

use crate::process::{walk_process, ProcessInformation, Teletype};

Expand All @@ -25,12 +31,15 @@ pub struct Settings {
pub newest: bool,
pub oldest: bool,
pub older: Option<u64>,
pub parent: Option<Vec<u64>>,
pub parent: Option<HashSet<u64>>,
pub runstates: Option<String>,
pub terminal: Option<HashSet<Teletype>>,
#[cfg(unix)]
pub signal: usize,
pub require_handler: bool,
pub uid: Option<HashSet<u32>>,
pub euid: Option<HashSet<u32>>,
pub gid: Option<HashSet<u32>>,
}

pub fn get_match_settings(matches: &ArgMatches) -> UResult<Settings> {
Expand Down Expand Up @@ -58,14 +67,26 @@ pub fn get_match_settings(matches: &ArgMatches) -> UResult<Settings> {
#[cfg(unix)]
signal: parse_signal_value(matches.get_one::<String>("signal").unwrap())?,
require_handler: matches.get_flag("require-handler"),
uid: matches
.get_many::<u32>("uid")
.map(|ids| ids.cloned().collect()),
euid: matches
.get_many::<u32>("euid")
.map(|ids| ids.cloned().collect()),
gid: matches
.get_many::<u32>("group")
.map(|ids| ids.cloned().collect()),
};

if (!settings.newest
if !settings.newest
&& !settings.oldest
&& settings.runstates.is_none()
&& settings.older.is_none()
&& settings.parent.is_none()
&& settings.terminal.is_none())
&& settings.terminal.is_none()
&& settings.uid.is_none()
&& settings.euid.is_none()
&& settings.gid.is_none()
&& pattern.is_empty()
{
return Err(USimpleError::new(
Expand Down Expand Up @@ -137,6 +158,10 @@ fn try_get_pattern_from(matches: &ArgMatches) -> UResult<String> {
Ok(pattern.to_string())
}

fn any_matches<T: Eq + Hash>(optional_ids: &Option<HashSet<T>>, id: T) -> bool {
optional_ids.as_ref().is_none_or(|ids| ids.contains(&id))
}

/// Collect pids with filter construct from command line arguments
fn collect_matched_pids(settings: &Settings) -> Vec<ProcessInformation> {
// Filtration general parameters
Expand Down Expand Up @@ -171,28 +196,23 @@ fn collect_matched_pids(settings: &Settings) -> Vec<ProcessInformation> {
settings.regex.is_match(want)
};

let tty_matched = match &settings.terminal {
Some(ttys) => ttys.contains(&pid.tty()),
None => true,
};
let tty_matched = any_matches(&settings.terminal, pid.tty());

let arg_older = settings.older.unwrap_or(0);
let older_matched = pid.start_time().unwrap() >= arg_older;

// the PPID is the fourth field in /proc/<PID>/stat
// (https://www.kernel.org/doc/html/latest/filesystems/proc.html#id10)
let stat = pid.stat();
let ppid = stat.get(3);
let parent_matched = match (&settings.parent, ppid) {
(Some(parents), Some(ppid)) => parents.contains(&ppid.parse::<u64>().unwrap()),
_ => true,
};
let parent_matched = any_matches(&settings.parent, pid.ppid().unwrap());

let ids_matched = any_matches(&settings.uid, pid.uid().unwrap())
&& any_matches(&settings.euid, pid.euid().unwrap())
&& any_matches(&settings.gid, pid.gid().unwrap());

if (run_state_matched
&& pattern_matched
&& tty_matched
&& older_matched
&& parent_matched)
&& parent_matched
&& ids_matched)
^ settings.inverse
{
tmp_vec.push(pid);
Expand Down Expand Up @@ -249,6 +269,36 @@ fn parse_signal_value(signal_name: &str) -> UResult<usize> {
.ok_or_else(|| USimpleError::new(1, format!("Unknown signal {}", signal_name.quote())))
}

#[cfg(not(unix))]
pub fn usr2uid(_name: &str) -> io::Result<u32> {
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"unsupported on this platform",
))
}

#[cfg(not(unix))]
pub fn grp2gid(_name: &str) -> io::Result<u32> {
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"unsupported on this platform",
))
}

fn parse_uid_or_username(uid_or_username: &str) -> io::Result<u32> {
uid_or_username
.parse::<u32>()
.or_else(|_| usr2uid(uid_or_username))
.map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid user name"))
}

fn parse_gid_or_group_name(gid_or_group_name: &str) -> io::Result<u32> {
gid_or_group_name
.parse::<u32>()
.or_else(|_| grp2gid(gid_or_group_name))
.map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid group name"))
}

#[allow(clippy::cognitive_complexity)]
pub fn clap_args(pattern_help: &'static str, enable_v_flag: bool) -> Vec<Arg> {
vec![
Expand All @@ -263,9 +313,9 @@ pub fn clap_args(pattern_help: &'static str, enable_v_flag: bool) -> Vec<Arg> {
// arg!(-g --pgroup <PGID> "match listed process group IDs")
// .value_delimiter(',')
// .value_parser(clap::value_parser!(u64)),
// arg!(-G --group <GID> "match real group IDs")
// .value_delimiter(',')
// .value_parser(clap::value_parser!(u64)),
arg!(-G --group <GID> "match real group IDs")
.value_delimiter(',')
.value_parser(parse_gid_or_group_name),
arg!(-i --"ignore-case" "match case insensitively"),
arg!(-n --newest "select most recently started")
.group("oldest_newest_inverse"),
Expand All @@ -282,12 +332,12 @@ pub fn clap_args(pattern_help: &'static str, enable_v_flag: bool) -> Vec<Arg> {
arg!(--signal <sig> "signal to send (either number or name)")
.default_value("SIGTERM"),
arg!(-t --terminal <tty> "match by controlling terminal").value_delimiter(','),
// arg!(-u --euid <ID> "match by effective IDs")
// .value_delimiter(',')
// .value_parser(clap::value_parser!(u64)),
// arg!(-U --uid <ID> "match by real IDs")
// .value_delimiter(',')
// .value_parser(clap::value_parser!(u64)),
arg!(-u --euid <ID> "match by effective IDs")
.value_delimiter(',')
.value_parser(parse_uid_or_username),
arg!(-U --uid <ID> "match by real IDs")
.value_delimiter(',')
.value_parser(parse_uid_or_username),
arg!(-x --exact "match exactly with the command name"),
// arg!(-F --pidfile <file> "read PIDs from file"),
// arg!(-L --logpidfile "fail if PID file is not locked"),
Expand Down
2 changes: 1 addition & 1 deletion src/uu/pidwait/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ categories = ["command-line-utilities"]

[dependencies]
nix = { workspace = true }
uucore = { workspace = true }
uucore = { workspace = true, features = ["entries"] }
clap = { workspace = true }
regex = { workspace = true }
uu_pgrep = { path = "../pgrep" }
Expand Down
2 changes: 1 addition & 1 deletion src/uu/pkill/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ categories = ["command-line-utilities"]


[dependencies]
uucore = { workspace = true }
uucore = { workspace = true, features = ["entries"] }
clap = { workspace = true }
walkdir = { workspace = true }
regex = { workspace = true }
Expand Down
29 changes: 29 additions & 0 deletions tests/by-util/test_pgrep.rs
Original file line number Diff line number Diff line change
Expand Up @@ -391,3 +391,32 @@ fn test_too_long_pattern() {
.code_is(1)
.stderr_contains("pattern that searches for process name longer than 15 characters will result in zero matches");
}

#[test]
#[cfg(target_os = "linux")]
fn test_invalid_username() {
new_ucmd!()
.arg("--uid=DOES_NOT_EXIST")
.fails()
.code_is(1)
.stderr_contains("invalid user name");
}

#[test]
#[cfg(target_os = "linux")]
fn test_invalid_group_name() {
new_ucmd!()
.arg("--group=DOES_NOT_EXIST")
.fails()
.code_is(1)
.stderr_contains("invalid group name");
}

#[test]
#[cfg(target_os = "linux")]
fn test_current_user() {
new_ucmd!()
.arg("-U")
.arg(uucore::process::getuid().to_string())
.succeeds();
}
Loading