1 .\" Copyright (c) 1989, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
3 .\" Copyright (c) 2018 Gandi
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\" 3. Neither the name of the University nor the names of its contributors
14 .\" may be used to endorse or promote products derived from this software
15 .\" without specific prior written permission.
17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" @(#)getfh.2 8.1 (Berkeley) 6/9/93
46 .Fn getfh "const char *path" "fhandle_t *fhp"
48 .Fn lgetfh "const char *path" "fhandle_t *fhp"
50 .Fn getfhat "int fd" "const char *path" "fhandle_t *fhp" "int flag"
55 returns a file handle for the specified file or directory
56 in the file handle pointed to by
63 except in the case where the named file is a symbolic link,
66 returns information about the link,
69 returns information about the file the link references.
73 system call is equivalent to
79 specifies a relative path.
84 the status is retrieved from a file relative to
85 the directory associated with the file descriptor
87 instead of the current working directory.
91 are constructed by a bitwise-inclusive OR of flags from this list,
94 .Bl -tag -width indent
95 .It Dv AT_SYMLINK_NOFOLLOW
98 names a symbolic link, the status of the symbolic link is returned.
99 .It Dv AT_RESOLVE_BENEATH
100 Only walk paths below the directory specified by the
103 See the description of the
104 .Dv O_RESOLVE_BENEATH
112 is passed the special value
116 parameter, the current working directory is used and the behavior is
117 identical to a call to
121 respectively, depending on whether or not the
122 .Dv AT_SYMLINK_NOFOLLOW
128 is called with an absolute
133 These system calls are restricted to the superuser.
142 fail if one or more of the following are true:
145 A component of the path prefix of
148 .It Bq Er ENAMETOOLONG
149 The length of a component of
151 exceeds 255 characters,
154 exceeds 1023 characters.
156 The file referred to by
160 Search permission is denied for a component of the path prefix of
163 Too many symbolic links were encountered in translating
169 points to an invalid address.
174 points to an invalid address.
178 error occurred while reading from or writing to the file system.
180 Corrupted data was detected while reading from the file system.
187 In addition to the errors returned by
193 system call may fail if:
198 argument does not specify an absolute path and the
202 nor a valid file descriptor open for searching.
206 argument is not valid.
210 argument is not an absolute path and
214 nor a file descriptor associated with a directory.
222 system call first appeared in