Rename cap-primitives' link to hard_link.

sunfishcode · sunfishcode · commit 69a3cf44b0aa · 2020-10-16T06:47:12.000-07:00
diff --git a/cap-async-std/src/fs/dir.rs b/cap-async-std/src/fs/dir.rs
@@ -6,7 +6,7 @@ use async_std::os::wasi::{
 };
 use async_std::{fs, io};
 use cap_primitives::fs::{
-    canonicalize, copy, link, mkdir, open, open_ambient_dir, open_dir, read_dir, readlink,
+    canonicalize, copy, hard_link, mkdir, open, open_ambient_dir, open_dir, read_dir, readlink,
     remove_dir_all, remove_open_dir, remove_open_dir_all, rename, rmdir, set_permissions, stat,
     unlink, DirOptions, FollowSymlinks, Permissions,
 };
@@ -235,7 +235,7 @@ impl Dir {
     ) -> io::Result<()> {
         let src_file = unsafe { as_sync(&self.std_file) };
         let dst_file = unsafe { as_sync(&dst_dir.std_file) };
-        link(&src_file, src.as_ref(), &dst_file, dst.as_ref())
+        hard_link(&src_file, src.as_ref(), &dst_file, dst.as_ref())
     }
 
     /// Given a path, query the file system to get information about a file, directory, etc.
diff --git a/cap-primitives/src/fs/hard_link.rs b/cap-primitives/src/fs/hard_link.rs
@@ -1,17 +1,17 @@
-//! This defines `link`, the primary entrypoint to sandboxed hard-link creation.
+//! This defines `hard_link`, the primary entrypoint to sandboxed hard-link creation.
 
-use crate::fs::link_impl;
+use crate::fs::hard_link_impl;
 #[cfg(racy_asserts)]
 use crate::fs::{
-    canonicalize, link_unchecked, map_result, stat_unchecked, FollowSymlinks, Metadata,
+    canonicalize, hard_link_unchecked, map_result, stat_unchecked, FollowSymlinks, Metadata,
 };
 use std::{fs, io, path::Path};
 
 /// Perform a `linkat`-like operation, ensuring that the resolution of the path
 /// never escapes the directory tree rooted at `start`.
 #[cfg_attr(not(racy_asserts), allow(clippy::let_and_return))]
 #[inline]
-pub fn link(
+pub fn hard_link(
     old_start: &fs::File,
     old_path: &Path,
     new_start: &fs::File,
@@ -24,7 +24,7 @@ pub fn link(
     );
 
     // Call the underlying implementation.
-    let result = link_impl(old_start, old_path, new_start, new_path);
+    let result = hard_link_impl(old_start, old_path, new_start, new_path);
 
     #[cfg(racy_asserts)]
     let (old_metadata_after, new_metadata_after) = (
@@ -33,7 +33,7 @@ pub fn link(
     );
 
     #[cfg(racy_asserts)]
-    check_link(
+    check_hard_link(
         old_start,
         old_path,
         new_start,
@@ -51,7 +51,7 @@ pub fn link(
 #[cfg(racy_asserts)]
 #[allow(clippy::too_many_arguments)]
 #[allow(clippy::enum_glob_use)]
-fn check_link(
+fn check_hard_link(
     old_start: &fs::File,
     old_path: &Path,
     new_start: &fs::File,
@@ -90,7 +90,7 @@ fn check_link(
             map_result(&canonicalize(old_start, old_path)),
             map_result(&canonicalize(new_start, new_path)),
         ) {
-            (Ok(old_canon), Ok(new_canon)) => match map_result(&link_unchecked(
+            (Ok(old_canon), Ok(new_canon)) => match map_result(&hard_link_unchecked(
                 old_start, &old_canon, new_start, &new_canon,
             )) {
                 Err((_unchecked_kind, _unchecked_message)) => {
diff --git a/cap-primitives/src/fs/mod.rs b/cap-primitives/src/fs/mod.rs
@@ -14,8 +14,8 @@ mod dir_options;
 mod file_path_by_searching;
 mod file_type;
 mod follow_symlinks;
+mod hard_link;
 mod is_read_write;
-mod link;
 mod maybe_owned_file;
 mod metadata;
 mod mkdir;
@@ -60,8 +60,8 @@ pub use dir_entry::*;
 pub use dir_options::*;
 pub use file_type::*;
 pub use follow_symlinks::*;
+pub use hard_link::*;
 pub use is_read_write::is_read_write;
-pub use link::*;
 pub use metadata::*;
 pub use mkdir::*;
 pub use open::*;
diff --git a/cap-primitives/src/fs/via_parent/hard_link.rs b/cap-primitives/src/fs/via_parent/hard_link.rs
@@ -1,10 +1,10 @@
 use super::open_parent;
-use crate::fs::{link_unchecked, MaybeOwnedFile};
+use crate::fs::{hard_link_unchecked, MaybeOwnedFile};
 use std::{fs, io, path::Path};
 
-/// Implement `link` by `open`ing up the parent component of the path and then
-/// calling `link_unchecked` on the last component.
-pub(crate) fn link(
+/// Implement `hard_link` by `open`ing up the parent component of the path and
+/// then calling `hard_link_unchecked` on the last component.
+pub(crate) fn hard_link(
     old_start: &fs::File,
     old_path: &Path,
     new_start: &fs::File,
@@ -16,7 +16,7 @@ pub(crate) fn link(
     let (old_dir, old_basename) = open_parent(old_start, old_path)?;
     let (new_dir, new_basename) = open_parent(new_start, new_path)?;
 
-    link_unchecked(
+    hard_link_unchecked(
         &old_dir,
         old_basename.as_ref(),
         &new_dir,
diff --git a/cap-primitives/src/fs/via_parent/mod.rs b/cap-primitives/src/fs/via_parent/mod.rs
@@ -2,7 +2,7 @@
 //! in `mkdir`, the last component names the path to be created, while the
 //! rest of the components just name the place to create it in.
 
-mod link;
+mod hard_link;
 mod mkdir;
 mod open_parent;
 #[cfg(not(windows))] // doesn't work on windows; use a windows-specific impl
@@ -18,7 +18,7 @@ mod unlink;
 
 use open_parent::open_parent;
 
-pub(crate) use link::link;
+pub(crate) use hard_link::hard_link;
 pub(crate) use mkdir::mkdir;
 #[cfg(not(windows))] // doesn't work on windows; use a windows-specific impl
 pub(crate) use readlink::readlink;
diff --git a/cap-primitives/src/posish/fs/hard_link_unchecked.rs b/cap-primitives/src/posish/fs/hard_link_unchecked.rs
@@ -1,12 +1,12 @@
 use posish::fs::{linkat, AtFlags};
 use std::{fs, io, path::Path};
 
-/// *Unsandboxed* function similar to `link`, but which does not perform sandboxing.
+/// *Unsandboxed* function similar to `hard_link`, but which does not perform sandboxing.
 ///
 /// Even though POSIX `linkat` has the ability to follow symlinks in `old_path`,
 /// using `AT_SYMLINK_FOLLOW`, Rust's `hard_link` doesn't need that, so we don't
 /// expose it here.
-pub(crate) fn link_unchecked(
+pub(crate) fn hard_link_unchecked(
     old_start: &fs::File,
     old_path: &Path,
     new_start: &fs::File,
diff --git a/cap-primitives/src/posish/fs/mod.rs b/cap-primitives/src/posish/fs/mod.rs
@@ -4,11 +4,11 @@ mod dir_entry_inner;
 mod dir_options_ext;
 mod dir_utils;
 mod file_type_ext;
+mod hard_link_unchecked;
 mod is_read_write_impl;
 mod is_root_dir;
 #[cfg(racy_asserts)]
 mod is_same_file;
-mod link_unchecked;
 mod metadata_ext;
 mod mkdir_unchecked;
 mod oflags;
@@ -62,7 +62,7 @@ pub(crate) use {set_permissions_impl::set_permissions_impl, set_times_impl::set_
 
 #[rustfmt::skip]
 pub(crate) use crate::fs::{
-    via_parent::link as link_impl,
+    via_parent::hard_link as hard_link_impl,
     via_parent::mkdir as mkdir_impl,
     via_parent::readlink as readlink_impl,
     via_parent::rename as rename_impl,
@@ -79,11 +79,11 @@ pub(crate) use dir_entry_inner::*;
 pub(crate) use dir_options_ext::*;
 pub(crate) use dir_utils::*;
 pub(crate) use file_type_ext::*;
+pub(crate) use hard_link_unchecked::*;
 pub(crate) use is_read_write_impl::*;
 pub(crate) use is_root_dir::*;
 #[cfg(racy_asserts)]
 pub(crate) use is_same_file::*;
-pub(crate) use link_unchecked::*;
 pub(crate) use metadata_ext::*;
 pub(crate) use mkdir_unchecked::*;
 pub(crate) use open_options_ext::*;
diff --git a/cap-primitives/src/winx/fs/hard_link_unchecked.rs b/cap-primitives/src/winx/fs/hard_link_unchecked.rs
@@ -1,8 +1,8 @@
 use super::get_path::concatenate_or_return_absolute;
 use std::{fs, io, path::Path};
 
-/// *Unsandboxed* function similar to `link`, but which does not perform sandboxing.
-pub(crate) fn link_unchecked(
+/// *Unsandboxed* function similar to `hard_link`, but which does not perform sandboxing.
+pub(crate) fn hard_link_unchecked(
     old_start: &fs::File,
     old_path: &Path,
     new_start: &fs::File,
diff --git a/cap-primitives/src/winx/fs/mod.rs b/cap-primitives/src/winx/fs/mod.rs
@@ -6,10 +6,10 @@ mod dir_options_ext;
 mod dir_utils;
 mod file_type_ext;
 mod get_path;
+mod hard_link_unchecked;
 mod is_read_write_impl;
 #[cfg(racy_asserts)]
 mod is_same_file;
-mod link_unchecked;
 mod metadata_ext;
 mod mkdir_unchecked;
 mod oflags;
@@ -33,7 +33,7 @@ pub(crate) mod errors;
 #[rustfmt::skip]
 pub(crate) use crate::fs::{
     manually::canonicalize as canonicalize_impl,
-    via_parent::link as link_impl,
+    via_parent::hard_link as hard_link_impl,
     via_parent::mkdir as mkdir_impl,
     via_parent::rename as rename_impl,
     via_parent::rmdir as rmdir_impl,
@@ -50,10 +50,10 @@ pub(crate) use dir_entry_inner::*;
 pub(crate) use dir_options_ext::*;
 pub(crate) use dir_utils::*;
 pub(crate) use file_type_ext::*;
+pub(crate) use hard_link_unchecked::*;
 pub(crate) use is_read_write_impl::*;
 #[cfg(racy_asserts)]
 pub(crate) use is_same_file::*;
-pub(crate) use link_unchecked::*;
 pub(crate) use manually::open as open_impl;
 pub(crate) use metadata_ext::*;
 pub(crate) use mkdir_unchecked::*;
diff --git a/cap-std/src/fs/dir.rs b/cap-std/src/fs/dir.rs
@@ -1,6 +1,6 @@
 use crate::fs::{DirBuilder, File, Metadata, OpenOptions, ReadDir};
 use cap_primitives::fs::{
-    canonicalize, copy, link, mkdir, open, open_ambient_dir, open_dir, read_dir, readlink,
+    canonicalize, copy, hard_link, mkdir, open, open_ambient_dir, open_dir, read_dir, readlink,
     remove_dir_all, remove_open_dir, remove_open_dir_all, rename, rmdir, set_permissions, stat,
     unlink, DirOptions, FollowSymlinks, Permissions,
 };
@@ -225,7 +225,7 @@ impl Dir {
         dst_dir: &Self,
         dst: Q,
     ) -> io::Result<()> {
-        link(
+        hard_link(
             &self.std_file,
             src.as_ref(),
             &dst_dir.std_file,
diff --git a/fuzz/fuzz_targets/cap-primitives.rs b/fuzz/fuzz_targets/cap-primitives.rs
@@ -90,7 +90,7 @@ impl Plan {
                     .ok();
                 }
                 Operation::Link(old_dirno, old_path, new_dirno, new_path) => {
-                    cap_primitives::fs::link(
+                    cap_primitives::fs::hard_link(
                         &files[*old_dirno % files.len()],
                         &paths[*old_path % paths.len()],
                         &files[*new_dirno % files.len()],
