Skip to content

Unify matching logic in pgrep and pkill #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cakebaker merged 6 commits into from
Feb 13, 2025
Merged

Unify matching logic in pgrep and pkill #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
be1869d
pgrep, pkill: Unify arg lists
dezgeg Feb 9, 2025
75c2bd5
pgrep: Small cleanup
dezgeg Feb 9, 2025
cfe4cb3
pkill: Support --inverse
dezgeg Feb 9, 2025
f0148e2
pkill: Simplify short signal number option handling
dezgeg Feb 10, 2025
f946eb6
pgrep: Support --signal and --require-handler
dezgeg Feb 10, 2025
a1ef871
Merge branch 'main' into pgrep_pkill_unification
Krysztal112233 Feb 13, 2025
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
52 changes: 45 additions & 7 deletions src/uu/pgrep/src/pgrep.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ use clap::{arg, crate_version, Arg, ArgAction, ArgGroup, ArgMatches, Command};
use process::{walk_process, ProcessInformation, Teletype};
use regex::Regex;
use std::{collections::HashSet, sync::OnceLock};
#[cfg(unix)]
use uucore::{display::Quotable, signals::signal_by_name_or_value};
use uucore::{
error::{UResult, USimpleError},
format_usage, help_about, help_usage,
Expand Down Expand Up @@ -87,9 +89,21 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> {
));
}

// Parse signal
#[cfg(unix)]
let sig_num = parse_signal_value(matches.get_one::<String>("signal").unwrap())?;

// Collect pids
let pids = {
let mut pids = collect_matched_pids(&settings);
#[cfg(unix)]
if matches.get_flag("require-handler") {
pids.retain(|pid| {
let mask =
u64::from_str_radix(pid.clone().status().get("SigCgt").unwrap(), 16).unwrap();
mask & (1 << sig_num) != 0
});
}
if pids.is_empty() {
uucore::error::set_exit_code(1);
pids
Expand Down Expand Up @@ -170,7 +184,7 @@ fn collect_matched_pids(settings: &Settings) -> Vec<ProcessInformation> {
let mut tmp_vec = Vec::new();

for mut pid in walk_process().collect::<Vec<_>>() {
let run_state_matched = match (&settings.runstates, (pid).run_state()) {
let run_state_matched = match (&settings.runstates, pid.run_state()) {
(Some(arg_run_states), Ok(pid_state)) => {
arg_run_states.contains(&pid_state.to_string())
}
Expand Down Expand Up @@ -275,6 +289,12 @@ fn process_flag_o_n(
}
}

#[cfg(unix)]
fn parse_signal_value(signal_name: &str) -> UResult<usize> {
signal_by_name_or_value(signal_name)
.ok_or_else(|| USimpleError::new(1, format!("Unknown signal {}", signal_name.quote())))
}

#[allow(clippy::cognitive_complexity)]
pub fn uu_app() -> Command {
Command::new(uucore::util_name())
Expand All @@ -289,12 +309,17 @@ pub fn uu_app() -> Command {
.hide_default_value(true),
arg!(-l --"list-name" "list PID and process name"),
arg!(-a --"list-full" "list PID and full command line"),
arg!(-H --"require-handler" "match only if signal handler is present"),
arg!(-v --inverse "negates the matching"),
// arg!(-w --lightweight "list all TID"),
arg!(-c --count "count of matching processes"),
arg!(-f --full "use full process name to match"),
// arg!(-g --pgroup <PGID> ... "match listed process group IDs"),
// arg!(-G --group <GID> ... "match real group IDs"),
// 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!(-i --"ignore-case" "match case insensitively"),
arg!(-n --newest "select most recently started"),
arg!(-o --oldest "select least recently started"),
Expand All @@ -303,17 +328,30 @@ pub fn uu_app() -> Command {
arg!(-P --parent <PPID> "match only child processes of the given parent")
.value_delimiter(',')
.value_parser(clap::value_parser!(u64)),
// arg!(-s --session <SID> "match session IDs"),
// arg!(-s --session <SID> "match session IDs")
// .value_delimiter(',')
// .value_parser(clap::value_parser!(u64)),
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"),
// arg!(-U --uid <ID> ... "match by real IDs"),
// 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!(-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"),
arg!(-r --runstates <state> "match runstates [D,S,Z,...]"),
// arg!(-A --"ignore-ancestors" "exclude our ancestors from results"),
// arg!(--cgroup <grp> "match by cgroup v2 names")
// .value_delimiter(','),
// arg!( --ns <PID> "match the processes that belong to the same namespace as <pid>"),
// arg!( --nslist <ns> ... "list which namespaces will be considered for the --ns option."),
// arg!( --nslist <ns> ... "list which namespaces will be considered for the --ns option.")
// .value_delimiter(',')
// .value_parser(["ipc", "mnt", "net", "pid", "user", "uts"]),
])
.arg(
Arg::new("pattern")
Expand Down
96 changes: 43 additions & 53 deletions src/uu/pkill/src/pkill.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ struct Settings {
exact: bool,
full: bool,
ignore_case: bool,
inverse: bool,
newest: bool,
oldest: bool,
older: Option<u64>,
Expand All @@ -51,7 +52,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> {
#[cfg(target_os = "windows")]
let args = args.collect_ignore();
#[cfg(unix)]
let obs_signal = handle_obsolete(&mut args);
handle_obsolete(&mut args);

let matches = uu_app().try_get_matches_from(&args)?;

Expand All @@ -64,6 +65,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> {
exact: matches.get_flag("exact"),
full: matches.get_flag("full"),
ignore_case: matches.get_flag("ignore-case"),
inverse: matches.get_flag("inverse"),
newest: matches.get_flag("newest"),
oldest: matches.get_flag("oldest"),
parent: matches
Expand Down Expand Up @@ -94,13 +96,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> {

// Parse signal
#[cfg(unix)]
let sig_num = if let Some(signal) = obs_signal {
signal
} else if let Some(signal) = matches.get_one::<String>("signal") {
parse_signal_value(signal)?
} else {
15_usize //SIGTERM
};
let sig_num = parse_signal_value(matches.get_one::<String>("signal").unwrap())?;

#[cfg(unix)]
let sig_name = signal_name_by_value(sig_num);
Expand All @@ -123,7 +119,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> {
if matches.get_flag("require-handler") {
pids.retain(|pid| {
let mask =
u32::from_str_radix(pid.clone().status().get("SigCgt").unwrap(), 16).unwrap();
u64::from_str_radix(pid.clone().status().get("SigCgt").unwrap(), 16).unwrap();
mask & (1 << sig_num) != 0
});
}
Expand Down Expand Up @@ -235,11 +231,12 @@ fn collect_matched_pids(settings: &Settings) -> Vec<ProcessInformation> {
_ => true,
};

if run_state_matched
if (run_state_matched
&& pattern_matched
&& tty_matched
&& older_matched
&& parent_matched
&& parent_matched)
^ settings.inverse
{
tmp_vec.push(pid);
}
Expand Down Expand Up @@ -290,7 +287,7 @@ fn process_flag_o_n(
}

#[cfg(unix)]
fn handle_obsolete(args: &mut Vec<String>) -> Option<usize> {
fn handle_obsolete(args: &mut [String]) {
// Sanity check
if args.len() > 2 {
// Old signal can only be in the first argument position
Expand All @@ -299,25 +296,17 @@ fn handle_obsolete(args: &mut Vec<String>) -> Option<usize> {
// Check if it is a valid signal
let opt_signal = signal_by_name_or_value(signal);
if opt_signal.is_some() {
// remove the signal before return
args.remove(1);
return opt_signal;
// Replace with long option that clap can parse
args[1] = format!("--signal={}", signal);
}
}
}
None
}

#[cfg(unix)]
fn parse_signal_value(signal_name: &str) -> UResult<usize> {
let optional_signal_value = signal_by_name_or_value(signal_name);
match optional_signal_value {
Some(x) => Ok(x),
None => Err(USimpleError::new(
1,
format!("Unknown signal {}", signal_name.quote()),
)),
}
signal_by_name_or_value(signal_name)
.ok_or_else(|| USimpleError::new(1, format!("Unknown signal {}", signal_name.quote())))
}

#[cfg(unix)]
Expand All @@ -343,20 +332,21 @@ pub fn uu_app() -> Command {
.about(ABOUT)
.override_usage(format_usage(USAGE))
.args_override_self(true)
.group(ArgGroup::new("oldest_newest").args(["oldest", "newest"]))
.group(ArgGroup::new("oldest_newest").args(["oldest", "newest", "inverse"]))
.args([
// arg!(-<sig> "signal to send (either number or name)"),
arg!(-H --"require-handler" "match only if signal handler is present"),
arg!(-q --queue <value> "integer value to be sent with the signal"),
// arg!(-q --queue <value> "integer value to be sent with the signal"),
arg!(-e --echo "display what is killed"),
arg!(--inverse "negates the matching"),
arg!(-c --count "count of matching processes"),
arg!(-f --full "use full process name to match"),
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 --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!(-i --"ignore-case" "match case insensitively"),
arg!(-n --newest "select most recently started"),
arg!(-o --oldest "select least recently started"),
Expand All @@ -365,29 +355,29 @@ pub fn uu_app() -> Command {
arg!(-P --parent <PPID> "match only child processes of the given parent")
.value_delimiter(',')
.value_parser(clap::value_parser!(u64)),
arg!(-s --session <SID> "match session IDs")
.value_delimiter(',')
.value_parser(clap::value_parser!(u64)),
arg!(--signal <sig> "signal to send (either number or name)"),
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!(-s --session <SID> "match session IDs")
// .value_delimiter(',')
// .value_parser(clap::value_parser!(u64)),
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!(-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"),
// arg!(-F --pidfile <file> "read PIDs from file"),
// arg!(-L --logpidfile "fail if PID file is not locked"),
arg!(-r --runstates <state> "match runstates [D,S,Z,...]"),
arg!(-A --"ignore-ancestors" "exclude our ancestors from results"),
arg!(--cgroup <grp> "match by cgroup v2 names")
.value_delimiter(','),
arg!(--ns <PID> "match the processes that belong to the same namespace as <pid>"),
arg!(--nslist <ns> "list which namespaces will be considered for the --ns option.")
.value_delimiter(',')
.value_parser(["ipc", "mnt", "net", "pid", "user", "uts"]),
// arg!(-A --"ignore-ancestors" "exclude our ancestors from results"),
// arg!(--cgroup <grp> "match by cgroup v2 names")
// .value_delimiter(','),
// arg!(--ns <PID> "match the processes that belong to the same namespace as <pid>"),
// arg!(--nslist <ns> "list which namespaces will be considered for the --ns option.")
// .value_delimiter(',')
// .value_parser(["ipc", "mnt", "net", "pid", "user", "uts"]),
])
.arg(
Arg::new("pattern")
Expand Down
21 changes: 21 additions & 0 deletions tests/by-util/test_pgrep.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,3 +347,24 @@ fn test_parent_non_matching_parent() {
.code_is(1)
.no_output();
}

#[test]
#[cfg(target_os = "linux")]
fn test_require_handler() {
new_ucmd!()
.arg("--require-handler")
.arg("--signal=INT")
.arg("NONEXISTENT")
.fails()
.no_output();
}

#[test]
#[cfg(target_os = "linux")]
fn test_invalid_signal() {
new_ucmd!()
.arg("--signal=foo")
.arg("NONEXISTENT")
.fails()
.stderr_contains("Unknown signal 'foo'");
}
11 changes: 11 additions & 0 deletions tests/by-util/test_pkill.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@ fn test_invalid_arg() {
new_ucmd!().arg("--definitely-invalid").fails().code_is(1);
}

#[cfg(target_os = "linux")]
#[test]
fn test_inverse() {
new_ucmd!()
.arg("-0")
.arg("--inverse")
.arg("NONEXISTENT")
.fails()
.stderr_contains("Permission denied");
}

#[cfg(unix)]
#[test]
fn test_help() {
Expand Down
Loading