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

fix readlink/readlinkat to return too long only when it is long #1109

Merged
merged 8 commits into from
Aug 22, 2019
Merged

fix readlink/readlinkat to return too long only when it is long #1109

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ea10209
fix readlink/readlinkat to return too long only when it is long
sendilkumarn Aug 22, 2019
e743336
update readlink to return the path instead of mangling the buffer
sendilkumarn Aug 22, 2019
3d5eadd
Add changelog
sendilkumarn Aug 22, 2019
07e2ea9
fix review comments
sendilkumarn Aug 22, 2019
e99c267
add readlinkat too
sendilkumarn Aug 22, 2019
6737585
remove macro symbol
sendilkumarn Aug 22, 2019
4a4cfc0
updated changelog
sendilkumarn Aug 22, 2019
fa50f63
Update CHANGELOG.md
sendilkumarn Aug 22, 2019
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
10 changes: 9 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased] - ReleaseDate
### Added
### Changed
- Changed `readlink` and `readlinkat` to return `osString`
- Changed `readlink` and `readlinkat` to return `OsString`
([#1109](https://github.com/nix-rust/nix/pull/1109))

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example isn't going to mean much to a reader. I'm thinking something in English, like "the buffer argument of readlink and readlinkat has been removed, and the return value is now an owned type. Existing code can be updated by removing the buffer argument and removing any clone or similar operation on the output."

```rust
use nix::fcntl::{readlink, readlinkat};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line isn't important to readers. You can suppress it with a leading #, and delete the following blank line.


readlink(&path);
readlinkat(dirfd, &path);
```

### Fixed
### Removed

Expand Down
12 changes: 7 additions & 5 deletions src/fcntl.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,19 +188,21 @@ fn wrap_readlink_result(v: &mut Vec<u8>, res: ssize_t) -> Result<OsString> {
}

pub fn readlink<'a, P: ?Sized + NixPath>(path: &P) -> Result<OsString> {
let mut v = vec![0u8; libc::PATH_MAX as usize];
let len = libc::PATH_MAX as usize;
let mut v = Vec::with_capacity(len);
let res = path.with_nix_path(|cstr| {
unsafe { libc::readlink(cstr.as_ptr(), v.as_mut_ptr() as *mut c_char, v.len() as size_t) }
unsafe { libc::readlink(cstr.as_ptr(), v.as_mut_ptr() as *mut c_char, len as size_t) }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You seem to be unaware of the capacity method. You should write it like this:

let mut v = Vec::with_capacity(libc::PATH_MAX as usize);
let res = path.with_nix_path(|cstr| {
    unsafe { libc::readlink(cstr.as_ptr(), v.as_mut_ptr() as *mut c_char, v.capacity() as size_t) }

})?;

wrap_readlink_result(&mut v, res)
}


pub fn readlinkat<'a, P: ?Sized + NixPath>(dirfd: RawFd, path: &P) -> Result<OsString> {
let mut v = vec![0u8; libc::PATH_MAX as usize];
let len = libc::PATH_MAX as usize;
let mut v = Vec::with_capacity(len);
let res = path.with_nix_path(|cstr| {
unsafe { libc::readlinkat(dirfd, cstr.as_ptr(), v.as_mut_ptr() as *mut c_char, v.len() as size_t) }
unsafe { libc::readlinkat(dirfd, cstr.as_ptr(), v.as_mut_ptr() as *mut c_char, len as size_t) }
})?;

wrap_readlink_result(&mut v, res)
Expand Down