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.

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

ls: Fix display of bad file descriptor errors #2875

Merged
merged 13 commits into from
Jan 30, 2022
Merged

ls: Fix display of bad file descriptor errors #2875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
37ca6ed
Fix display of bad fd errors
kimono-koans Jan 16, 2022
15efba5
Use dir_entry metadata for dereferenced bad fds to match GNU, add com…
kimono-koans Jan 16, 2022
e1bffea
Merge branch 'master' into ls_bad_fd_2
kimono-koans Jan 16, 2022
e6ce049
Fix Windows lints/build errors
kimono-koans Jan 16, 2022
16b7b38
Run cargo fmt
kimono-koans Jan 16, 2022
4bee652
Add new test, never print error on deref-ed bad fd
kimono-koans Jan 17, 2022
0b53cd8
Make suggested changes
kimono-koans Jan 20, 2022
1d629d8
Move more logic into md function, make enter_directory function clearer
kimono-koans Jan 26, 2022
7512200
Cleanup comments
kimono-koans Jan 26, 2022
463c1ac
Make suggested changes: Move logic into PathData struct, etc.
kimono-koans Jan 27, 2022
8b6c133
Fix broken test in certain Linux containers
kimono-koans Jan 27, 2022
5e82d60
Fix comments
kimono-koans Jan 27, 2022
72c5321
Prevent potential unwrap on a None value
kimono-koans Jan 28, 2022
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
208 changes: 152 additions & 56 deletions src/uu/ls/src/ls.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ use lscolors::LsColors;
use number_prefix::NumberPrefix;
use once_cell::unsync::OnceCell;
use quoting_style::{escape_name, QuotingStyle};
use std::ffi::OsString;
#[cfg(windows)]
use std::os::windows::fs::MetadataExt;
use std::{
Expand All @@ -39,6 +38,7 @@ use std::{
os::unix::fs::{FileTypeExt, MetadataExt},
time::Duration,
};
use std::{ffi::OsString, fs::ReadDir};
use term_grid::{Cell, Direction, Filling, Grid, GridOptions};
use uucore::{
display::Quotable,
Expand Down Expand Up @@ -165,7 +165,7 @@ impl Display for LsError {
LsError::IOError(e) => write!(f, "general io error: {}", e),
LsError::IOErrorContext(e, p) => {
let error_kind = e.kind();
let raw_os_error = e.raw_os_error().unwrap_or(13i32);
let errno = e.raw_os_error().unwrap_or(1i32);

match error_kind {
// No such file or directory
Expand All @@ -180,7 +180,7 @@ impl Display for LsError {
ErrorKind::PermissionDenied =>
{
#[allow(clippy::wildcard_in_or_patterns)]
match raw_os_error {
match errno {
1i32 => {
write!(
f,
Expand All @@ -205,12 +205,24 @@ impl Display for LsError {
}
}
}
_ => write!(
f,
"unknown io error: '{:?}', '{:?}'",
p.to_string_lossy(),
e
),
_ => match errno {
9i32 => {
// only should ever occur on a read_dir on a bad fd
write!(
f,
"cannot open directory '{}': Bad file descriptor",
p.to_string_lossy(),
)
}
_ => {
write!(
f,
"unknown io error: '{:?}', '{:?}'",
p.to_string_lossy(),
e
)
}
},
}
}
}
Expand Down Expand Up @@ -1270,6 +1282,7 @@ struct PathData {
// Result<MetaData> got from symlink_metadata() or metadata() based on config
md: OnceCell<Option<Metadata>>,
ft: OnceCell<Option<FileType>>,
de: Option<DirEntry>,
// Name of the file - will be empty for . or ..
display_name: OsString,
// PathBuf that all above data corresponds to
Expand All @@ -1281,7 +1294,7 @@ struct PathData {
impl PathData {
fn new(
p_buf: PathBuf,
file_type: Option<std::io::Result<FileType>>,
dir_entry: Option<std::io::Result<DirEntry>>,
file_name: Option<OsString>,
config: &Config,
command_line: bool,
Expand Down Expand Up @@ -1315,8 +1328,23 @@ impl PathData {
Dereference::None => false,
};

let ft = match file_type {
Some(ft) => OnceCell::from(ft.ok()),
let de: Option<DirEntry> = match dir_entry {
Some(de) => de.ok(),
None => None,
};

// Why prefer to check the DirEntry file_type()? B/c the call is
// nearly free compared to a metadata() call on a Path
let ft = match de {
Some(ref de) => {
if let Ok(ft_de) = de.file_type() {
OnceCell::from(Some(ft_de))
} else if let Ok(md_pb) = p_buf.metadata() {
OnceCell::from(Some(md_pb.file_type()))
} else {
OnceCell::new()
}
}
None => OnceCell::new(),
};

Expand All @@ -1329,6 +1357,7 @@ impl PathData {
Self {
md: OnceCell::new(),
ft,
de,
display_name,
p_buf,
must_dereference,
Expand All @@ -1338,16 +1367,34 @@ impl PathData {

fn md(&self, out: &mut BufWriter<Stdout>) -> Option<&Metadata> {
self.md
.get_or_init(
|| match get_metadata(self.p_buf.as_path(), self.must_dereference) {
.get_or_init(|| {
// check if we can use DirEntry metadata
if !self.must_dereference {
if let Some(dir_entry) = &self.de {
return dir_entry.metadata().ok();
}
}

// if not, check if we can use Path metadata
match get_metadata(self.p_buf.as_path(), self.must_dereference) {
Err(err) => {
let _ = out.flush();
let errno = err.raw_os_error().unwrap_or(1i32);
// a bad fd will throw an error when dereferenced,
// but GNU will not throw an error until a bad fd "dir"
// is entered, here we match that GNU behavior, by handing
// back the non-dereferenced metadata upon an EBADF
if self.must_dereference && errno == 9i32 {
if let Some(dir_entry) = &self.de {
return dir_entry.metadata().ok();
}
}
show!(LsError::IOErrorContext(err, self.p_buf.clone(),));
None
}
Ok(md) => Some(md),
},
)
}
})
.as_ref()
}

Expand Down Expand Up @@ -1397,16 +1444,28 @@ fn list(locs: Vec<&Path>, config: Config) -> UResult<()> {

display_items(&files, &config, &mut out);

for (pos, dir) in dirs.iter().enumerate() {
for (pos, path_data) in dirs.iter().enumerate() {
// Do read_dir call here to match GNU semantics by printing
// read_dir errors before directory headings, names and totals
let read_dir = match fs::read_dir(&path_data.p_buf) {
Err(err) => {
// flush stdout buffer before the error to preserve formatting and order
let _ = out.flush();
show!(LsError::IOErrorContext(err, path_data.p_buf.clone()));
continue;
}
Ok(rd) => rd,
};

// Print dir heading - name... 'total' comes after error display
if initial_locs_len > 1 || config.recursive {
if pos.eq(&0usize) && files.is_empty() {
let _ = writeln!(out, "{}:", dir.p_buf.display());
let _ = writeln!(out, "{}:", path_data.p_buf.display());
} else {
let _ = writeln!(out, "\n{}:", dir.p_buf.display());
let _ = writeln!(out, "\n{}:", path_data.p_buf.display());
}
}
enter_directory(dir, &config, &mut out);
enter_directory(path_data, read_dir, &config, &mut out);
}

Ok(())
Expand Down Expand Up @@ -1475,12 +1534,29 @@ fn should_display(entry: &DirEntry, config: &Config) -> bool {
true
}

fn enter_directory(dir: &PathData, config: &Config, out: &mut BufWriter<Stdout>) {
fn enter_directory(
path_data: &PathData,
read_dir: ReadDir,
config: &Config,
out: &mut BufWriter<Stdout>,
) {
// Create vec of entries with initial dot files
let mut entries: Vec<PathData> = if config.files == Files::All {
vec![
PathData::new(dir.p_buf.clone(), None, Some(".".into()), config, false),
PathData::new(dir.p_buf.join(".."), None, Some("..".into()), config, false),
PathData::new(
path_data.p_buf.clone(),
None,
Some(".".into()),
config,
false,
),
PathData::new(
path_data.p_buf.join(".."),
None,
Some("..".into()),
config,
false,
),
]
} else {
vec![]
Expand All @@ -1489,19 +1565,8 @@ fn enter_directory(dir: &PathData, config: &Config, out: &mut BufWriter<Stdout>)
// Convert those entries to the PathData struct
let mut vec_path_data = Vec::new();

// check for errors early, and ignore entries with errors
let read_dir = match fs::read_dir(&dir.p_buf) {
Err(err) => {
// flush buffer because the error may get printed in the wrong order
let _ = out.flush();
show!(LsError::IOErrorContext(err, dir.p_buf.clone()));
return;
}
Ok(res) => res,
};

for entry in read_dir {
let unwrapped = match entry {
for raw_entry in read_dir {
let dir_entry = match raw_entry {
Ok(path) => path,
Err(err) => {
let _ = out.flush();
Expand All @@ -1510,27 +1575,17 @@ fn enter_directory(dir: &PathData, config: &Config, out: &mut BufWriter<Stdout>)
}
};

if should_display(&unwrapped, config) {
// why check the DirEntry file_type()? B/c the call is
// nearly free compared to a metadata() or file_type() call on a dir/file
let path_data = match unwrapped.file_type() {
Err(err) => {
let _ = out.flush();
show!(LsError::IOErrorContext(err, unwrapped.path()));
continue;
}
Ok(dir_ft) => {
PathData::new(unwrapped.path(), Some(Ok(dir_ft)), None, config, false)
}
};
vec_path_data.push(path_data);
if should_display(&dir_entry, config) {
let entry_path_data =
PathData::new(dir_entry.path(), Some(Ok(dir_entry)), None, config, false);
vec_path_data.push(entry_path_data);
};
}

sort_entries(&mut vec_path_data, config, out);
entries.append(&mut vec_path_data);

// ...and total
// Print total after any error display
if config.format == Format::Long {
display_total(&entries, config, out);
}
Expand All @@ -1541,13 +1596,21 @@ fn enter_directory(dir: &PathData, config: &Config, out: &mut BufWriter<Stdout>)
for e in entries
.iter()
.skip(if config.files == Files::All { 2 } else { 0 })
// Already requested file_type for the dir_entries above. So we know the OnceCell is set.
// And can unwrap again because we tested whether path has is_some here
.filter(|p| p.ft.get().is_some())
.filter(|p| p.ft.get().unwrap().is_some())
.filter(|p| p.ft.get().unwrap().unwrap().is_dir())
{
let _ = writeln!(out, "\n{}:", e.p_buf.display());
enter_directory(e, config, out);
match fs::read_dir(&e.p_buf) {
Err(err) => {
let _ = out.flush();
show!(LsError::IOErrorContext(err, e.p_buf.clone()));
continue;
}
Ok(rd) => {
let _ = writeln!(out, "\n{}:", e.p_buf.display());
enter_directory(e, rd, config, out);
}
}
}
}
}
Expand Down Expand Up @@ -1971,10 +2034,43 @@ fn display_item_long(
}
}

#[cfg(unix)]
let leading_char = {
if let Some(Some(ft)) = item.ft.get() {
if ft.is_char_device() {
"c"
} else if ft.is_block_device() {
"b"
} else if ft.is_symlink() {
"l"
} else if ft.is_dir() {
"d"
} else {
"-"
}
} else {
"-"
}
};
#[cfg(not(unix))]
let leading_char = {
if let Some(Some(ft)) = item.ft.get() {
if ft.is_symlink() {
"l"
} else if ft.is_dir() {
"d"
} else {
"-"
}
} else {
"-"
}
};

let _ = write!(
out,
"{}{} {}",
"l?????????",
format_args!("{}?????????", leading_char),
if item.security_context.len() > 1 {
// GNU `ls` uses a "." character to indicate a file with a security context,
// but not other alternate access method.
Expand Down
Loading