Skip to content
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.

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

uucore: Sync proc_info methods from procps #7351

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
104 changes: 103 additions & 1 deletion src/uucore/src/lib/features/proc_info.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
// file that was distributed with this source code.

// spell-checker:ignore exitstatus cmdline kworker pgrep pwait snice procps
// spell-checker:ignore egid euid gettid ppid

//! Set of functions to manage IDs
//!
Expand Down Expand Up @@ -129,6 +130,14 @@ pub struct ProcessInformation {
cached_stat: Option<Rc<Vec<String>>>,

cached_start_time: Option<u64>,

cached_thread_ids: Option<Rc<Vec<usize>>>,
}

#[derive(Clone, Copy, Debug)]
enum UidGid {
Uid,
Gid,
}

impl ProcessInformation {
Expand Down Expand Up @@ -237,6 +246,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: UidGid, index: usize) -> Result<u32, io::Error> {
self.status()
.get(&format!("{:?}", 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(UidGid::Uid, 0)
}

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

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

pub fn egid(&mut self) -> Result<u32, io::Error> {
self.get_uid_or_gid_field(UidGid::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 @@ -271,8 +317,33 @@ impl ProcessInformation {

Teletype::Unknown
}
}

pub fn thread_ids(&mut self) -> Rc<Vec<usize>> {
if let Some(c) = &self.cached_thread_ids {
return Rc::clone(c);
}

let thread_ids_dir = format!("/proc/{}/task", self.pid);
let result = Rc::new(
WalkDir::new(thread_ids_dir)
.min_depth(1)
.max_depth(1)
.follow_links(false)
.into_iter()
.flatten()
.flat_map(|it| {
it.path()
.file_name()
.and_then(|it| it.to_str())
.and_then(|it| it.parse::<usize>().ok())
})
.collect::<Vec<_>>(),
);

self.cached_thread_ids = Some(Rc::clone(&result));
Rc::clone(&result)
}
}
impl TryFrom<DirEntry> for ProcessInformation {
type Error = io::Error;

Expand Down Expand Up @@ -399,6 +470,25 @@ mod tests {
);
}

#[test]
fn test_thread_ids() {
let main_tid = unsafe { uucore::libc::gettid() };
std::thread::spawn(move || {
let mut pid_entry = ProcessInformation::try_new(
PathBuf::from_str(&format!("/proc/{}", current_pid())).unwrap(),
)
.unwrap();
let thread_ids = pid_entry.thread_ids();

assert!(thread_ids.contains(&(main_tid as usize)));

let new_thread_tid = unsafe { uucore::libc::gettid() };
assert!(thread_ids.contains(&(new_thread_tid as usize)));
})
.join()
.unwrap();
}

#[test]
fn test_stat_split() {
let case = "32 (idle_inject/3) S 2 0 0 0 -1 69238848 0 0 0 0 0 0 0 0 -51 0 1 0 34 0 0 18446744073709551615 0 0 0 0 0 0 0 2147483647 0 0 0 0 17 3 50 1 0 0 0 0 0 0 0 0 0 0 0";
Expand All @@ -410,4 +500,16 @@ mod tests {
let case = "47246 (kworker /10:1-events) I 2 0 0 0 -1 69238880 0 0 0 0 17 29 0 0 20 0 1 0 1396260 0 0 18446744073709551615 0 0 0 0 0 0 0 2147483647 0 0 0 0 17 10 0 0 0 0 0 0 0 0 0 0 0 0 0";
assert!(stat_split(case)[1] == "kworker /10:1-events");
}

#[test]
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());
}
}
Loading