diff --git a/lib/libc/sys/fhlink.2 b/lib/libc/sys/fhlink.2 index 029ec8d7c2eb..6d27697199c4 100644 --- a/lib/libc/sys/fhlink.2 +++ b/lib/libc/sys/fhlink.2 @@ -1,250 +1,257 @@ .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2018 Gandi .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" -.Dd February 23, 2021 +.Dd November 30, 2022 .Dt FHLINK 2 .Os .Sh NAME .Nm fhlink , .Nm fhlinkat .Nd make a hard file link .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In unistd.h .Ft int .Fn fhlink "fhandle_t *fhp" "const char *to" .Ft int .Fn fhlinkat "fhandle_t *fhp" "int tofd" "const char *to" .Fc .Sh DESCRIPTION The .Fn fhlink system call atomically creates the specified directory entry (hard link) .Fa to with the attributes of the underlying object pointed at by .Fa fhp . If the link is successful: the link count of the underlying object is incremented; .Fa fhp and .Fa to share equal access and rights to the underlying object. .Pp If .Fa fhp is removed, the file .Fa to is not deleted and the link count of the underlying object is decremented. .Pp The object pointed at by the .Fa fhp argument must exist for the hard link to succeed and both .Fa fhp and .Fa to must be in the same file system. The .Fa fhp argument may not be a directory. .Pp The .Fn fhlinkat system call is equivalent to .Fa fhlink except in the case where .Fa to is a relative paths. In this case a relative path .Fa to is interpreted relative to the directory associated with the file descriptor .Fa tofd instead of the current working directory. .Pp If .Fn fhlinkat is passed the special value .Dv AT_FDCWD in the .Fa tofd parameter, the current working directory is used for the .Fa to argument. If .Fa tofd has value .Dv AT_FDCWD , the behavior is identical to a call to .Fn link . Unless .Fa flag contains the .Dv AT_SYMLINK_FOLLOW flag, if .Fa fhp names a symbolic link, a new link is created for the symbolic link .Fa fhp and not its target. .Sh RETURN VALUES .Rv -std link .Sh ERRORS The .Fn fhlink system call will fail and no link will be created if: .Bl -tag -width Er .It Bq Er ENOTDIR A component of .Fa to prefix is not a directory. .It Bq Er ENAMETOOLONG A component of .Fa to exceeded 255 characters, or entire length of .Fa to name exceeded 1023 characters. .It Bq Er ENOENT A component of .Fa to prefix does not exist. .It Bq Er EOPNOTSUPP The file system containing the file pointed at by .Fa fhp does not support links. .It Bq Er EMLINK The link count of the file pointed at by .Fa fhp would exceed 32767. .It Bq Er EACCES A component of .Fa to prefix denies search permission. .It Bq Er EACCES The requested link requires writing in a directory with a mode that denies write permission. .It Bq Er ELOOP Too many symbolic links were encountered in translating one of the pathnames. .It Bq Er ENOENT The file pointed at by .Fa fhp does not exist. .It Bq Er EEXIST The link named by .Fa to does exist. .It Bq Er EPERM The file pointed at by .Fa fhp is a directory. .It Bq Er EPERM The file pointed at by .Fa fhp has its immutable or append-only flag set, see the .Xr chflags 2 manual page for more information. .It Bq Er EPERM The parent directory of the file named by .Fa to has its immutable flag set. .It Bq Er EXDEV The link named by .Fa to and the file pointed at by .Fa fhp are on different file systems. .It Bq Er ENOSPC The directory in which the entry for the new link is being placed cannot be extended because there is no space left on the file system containing the directory. .It Bq Er EDQUOT The directory in which the entry for the new link is being placed cannot be extended because the user's quota of disk blocks on the file system containing the directory has been exhausted. .It Bq Er EIO An I/O error occurred while reading from or writing to the file system to make the directory entry. .It Bq Er EINTEGRITY Corrupted data was detected while reading from the file system. .It Bq Er EROFS The requested link requires writing in a directory on a read-only file system. .It Bq Er EFAULT One of the pathnames specified is outside the process's allocated address space. .It Bq Er ESTALE The file handle .Fa fhp is no longer valid .El .Pp In addition to the errors returned by the .Fn fhlink , the .Fn fhlinkat system call may fail if: .Bl -tag -width Er .It Bq Er EBADF The .Fa fhp or .Fa to argument does not specify an absolute path and the .Fa tofd argument, is not .Dv AT_FDCWD nor a valid file descriptor open for searching. .It Bq Er EINVAL The value of the .Fa flag argument is not valid. .It Bq Er ENOTDIR The .Fa fhp or .Fa to argument is not an absolute path and .Fa tofd is not .Dv AT_FDCWD nor a file descriptor associated with a directory. .El .Sh SEE ALSO .Xr fhopen 2 , .Xr fhreadlink 2 , .Xr fhstat 2 +.Sh HISTORY +The +.Fn fhlink +and +.Fn fhlinkat +system calls first appeared in +.Fx 12.1 . diff --git a/lib/libc/sys/fhreadlink.2 b/lib/libc/sys/fhreadlink.2 index 2837fd593d84..2b9a43110e4c 100644 --- a/lib/libc/sys/fhreadlink.2 +++ b/lib/libc/sys/fhreadlink.2 @@ -1,94 +1,99 @@ .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2018 Gandi .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" -.Dd March 30, 2020 +.Dd November 30, 2022 .Dt FHREADLINK 2 .Os .Sh NAME .Nm fhreadlink .Nd read value of a symbolic link .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/param.h .In sys/mount.h .Ft int .Fn fhreadlink "fhandle_t *fhp" "char *buf" "size_t bufsize" .Fc .Sh DESCRIPTION The .Fn fhreadlink system call places the contents of the symbolic link .Fa fhp in the buffer .Fa buf , which has size .Fa bufsiz . The .Fn fhreadlink system call does not append a .Dv NUL character to .Fa buf . .Pp .Sh RETURN VALUES The call returns the count of characters placed in the buffer if it succeeds, or a \-1 if an error occurs, placing the error code in the global variable .Va errno . .Sh ERRORS The .Fn readlink system call will fail if: .Bl -tag -width Er .It Bq Er ENOENT The named file does not exist. .It Bq Er ELOOP Too many symbolic links were encountered in translating the file handle .Fa fhp . .It Bq Er EINVAL The named file is not a symbolic link. .It Bq Er EIO An I/O error occurred while reading from the file system. .It Bq Er EINTEGRITY Corrupted data was detected while reading from the file system. .It Bq Er EFAULT The .Fa buf argument extends outside the process's allocated address space. .It Bq Er ESTALE The file handle .Fa fhp is no longer valid .El .El .Sh SEE ALSO .Xr fhstat 2 , .Xr fhlink 2 , +.Sh HISTORY +The +.Fn fhreadlink +system call first appeared in +.Fx 12.1 . diff --git a/lib/libc/sys/getfh.2 b/lib/libc/sys/getfh.2 index e042839a00c4..fb3d434b2d08 100644 --- a/lib/libc/sys/getfh.2 +++ b/lib/libc/sys/getfh.2 @@ -1,226 +1,234 @@ .\" Copyright (c) 1989, 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" Copyright (c) 2018 Gandi .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)getfh.2 8.1 (Berkeley) 6/9/93 .\" $FreeBSD$ .\" -.Dd December 23, 2021 +.Dd November 30, 2022 .Dt GETFH 2 .Os .Sh NAME .Nm getfh , .Nm lgetfh , .Nm getfhat .Nd get file handle .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In sys/param.h .In sys/mount.h .Ft int .Fn getfh "const char *path" "fhandle_t *fhp" .Ft int .Fn lgetfh "const char *path" "fhandle_t *fhp" .Ft int .Fn getfhat "int fd" "const char *path" "fhandle_t *fhp" "int flag" .Sh DESCRIPTION The .Fn getfh system call returns a file handle for the specified file or directory in the file handle pointed to by .Fa fhp . .Pp The .Fn lgetfh system call is like .Fn getfh except in the case where the named file is a symbolic link, in which case .Fn lgetfh returns information about the link, while .Fn getfh returns information about the file the link references. .Pp The .Fn getfhat system call is equivalent to .Fn getfh and .Fn lgetfh except when the .Fa path specifies a relative path. For .Fn getfhat and relative .Fa path , the status is retrieved from a file relative to the directory associated with the file descriptor .Fa fd instead of the current working directory. .Pp The values for the .Fa flag are constructed by a bitwise-inclusive OR of flags from this list, defined in .In fcntl.h : .Bl -tag -width indent .It Dv AT_SYMLINK_NOFOLLOW If .Fa path names a symbolic link, the status of the symbolic link is returned. .It Dv AT_RESOLVE_BENEATH Only walk paths below the directory specified by the .Ar fd descriptor. See the description of the .Dv O_RESOLVE_BENEATH flag in the .Xr open 2 manual page. .El .Pp If .Fn getfhat is passed the special value .Dv AT_FDCWD in the .Fa fd parameter, the current working directory is used and the behavior is identical to a call to .Fn getfth or .Fn lgetfh respectively, depending on whether or not the .Dv AT_SYMLINK_NOFOLLOW bit is set in .Fa flag . .Pp When .Fn getfhat is called with an absolute .Fa path , it ignores the .Fa fd argument. .Pp These system calls are restricted to the superuser. .Sh RETURN VALUES .Rv -std .Sh ERRORS The .Fn getfh and .Fn lgetfh system calls fail if one or more of the following are true: .Bl -tag -width Er .It Bq Er EPERM The caller does not have appropriate privilege to perform the operation. .It Bq Er ENOTDIR A component of the path prefix of .Fa path is not a directory. .It Bq Er ENAMETOOLONG The length of a component of .Fa path exceeds 255 characters, or the length of .Fa path exceeds 1023 characters. .It Bq Er ENOENT The file referred to by .Fa path does not exist. .It Bq Er EACCES Search permission is denied for a component of the path prefix of .Fa path . .It Bq Er ELOOP Too many symbolic links were encountered in translating .Fa path . .It Bq Er EFAULT The .Fa fhp argument points to an invalid address. .It Bq Er EFAULT The .Fa path argument points to an invalid address. .It Bq Er EIO An .Tn I/O error occurred while reading from or writing to the file system. .It Bq Er EINTEGRITY Corrupted data was detected while reading from the file system. .It Bq Er ESTALE The file handle .Fa fhp is no longer valid. .El .Pp In addition to the errors returned by .Fn getfh , and .Fn lgetfh , the .Fn getfhat system call may fail if: .Bl -tag -width Er .It Bq Er EBADF The .Fa path argument does not specify an absolute path and the .Fa fd argument, is neither .Dv AT_FDCWD nor a valid file descriptor open for searching. .It Bq Er EINVAL The value of the .Fa flag argument is not valid. .It Bq Er ENOTDIR The .Fa path argument is not an absolute path and .Fa fd is neither .Dv AT_FDCWD nor a file descriptor associated with a directory. .Sh SEE ALSO .Xr fhopen 2 , .Xr open 2 , .Xr stat 2 .Sh HISTORY The .Fn getfh system call first appeared in .Bx 4.4 . +The +.Fn lgetfh +system call first appeared in +.Fx 5.3 . +The +.Fn getfhat +system call first appeared in +.Fx 12.1 .