DOKK / manpages / debian 12 / freebsd-manpages / fhlinkat.2freebsd.en
FHLINK(2) System Calls Manual FHLINK(2)

fhlink, fhlinkat — make a hard file link

Standard C Library (libc, -lc)

#include <unistd.h>

int
fhlink(fhandle_t *fhp, const char *to);

int
fhlinkat(fhandle_t *fhp, int tofd, const char *to);

The () system call atomically creates the specified directory entry (hard link) to with the attributes of the underlying object pointed at by fhp. If the link is successful: the link count of the underlying object is incremented; fhp and to share equal access and rights to the underlying object.

If fhp is removed, the file to is not deleted and the link count of the underlying object is decremented.

The object pointed at by the fhp argument must exist for the hard link to succeed and both fhp and to must be in the same file system. The fhp argument may not be a directory.

The () system call is equivalent to fhlink except in the case where to is a relative paths. In this case a relative path to is interpreted relative to the directory associated with the file descriptor tofd instead of the current working directory.

Values for flag are constructed by a bitwise-inclusive OR of flags from the following list, defined in <fcntl.h>:

If fhp names a symbolic link, a new link for the target of the symbolic link is created.
Only allow to link to a file which is beneath of the topping directory. See the description of the O_BENEATH flag in the open(2) manual page.

If () is passed the special value AT_FDCWD in the tofd parameter, the current working directory is used for the to argument. If tofd has value AT_FDCWD, the behavior is identical to a call to (). Unless flag contains the AT_SYMLINK_FOLLOW flag, if fhp names a symbolic link, a new link is created for the symbolic link fhp and not its target.

The link() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

The fhlink() system call will fail and no link will be created if:

[]
A component of to prefix is not a directory.
[]
A component of to exceeded 255 characters, or entire length of to name exceeded 1023 characters.
[]
A component of to prefix does not exist.
[]
The file system containing the file pointed at by fhp does not support links.
The link count of the file pointed at by fhp would exceed 32767.
[]
A component of to prefix denies search permission.
[]
The requested link requires writing in a directory with a mode that denies write permission.
[]
Too many symbolic links were encountered in translating one of the pathnames.
[]
The file pointed at by fhp does not exist.
[]
The link named by to does exist.
[]
The file pointed at by fhp is a directory.
[]
The file pointed at by fhp has its immutable or append-only flag set, see the chflags(2) manual page for more information.
[]
The parent directory of the file named by to has its immutable flag set.
[]
The link named by to and the file pointed at by fhp are on different file systems.
[]
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.
[]
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.
[]
An I/O error occurred while reading from or writing to the file system to make the directory entry.
[]
Corrupted data was detected while reading from the file system.
[]
The requested link requires writing in a directory on a read-only file system.
[]
One of the pathnames specified is outside the process's allocated address space.
[]
The file handle fhp is no longer valid

In addition to the errors returned by the fhlink(), the fhlinkat() system call may fail if:

[]
The fhp or to argument does not specify an absolute path and the tofd argument, is not AT_FDCWD nor a valid file descriptor open for searching.
[]
The value of the flag argument is not valid.
[]
The fhp or to argument is not an absolute path and tofd is not AT_FDCWD nor a file descriptor associated with a directory.

fhstat(2), fhreadlink(2), fhopen(2),

March 30, 2020 Debian