git.saurik.com Git - apple/xnu.git/blob

1 .\"

3 .\"

4 .\" @APPLE_LICENSE_HEADER_START@

5 .\"

6 .\" This file contains Original Code and/or Modifications of Original Code

7 .\" as defined in and that are subject to the Apple Public Source License

8 .\" Version 2.0 (the 'License'). You may not use this file except in

9 .\" compliance with the License. Please obtain a copy of the License at

10 .\" http://www.opensource.apple.com/apsl/ and read it before using this

11 .\" file.

12 .\"

13 .\" The Original Code and all software distributed under the License are

14 .\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

15 .\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,

16 .\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

17 .\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.

18 .\" Please see the License for the specific language governing rights and

19 .\" limitations under the License.

20 .\"

21 .\" @APPLE_LICENSE_HEADER_END@

22 .\"

23 .Dd January 9, 2007

24 .Dt FHOPEN 2

25 .Os

26 .Sh NAME

27 .Nm fhopen

28 .Nd open a file by file handle

29 .Sh SYNOPSIS

30 .Fd #include <sys/types.h>

31 .Fd #include <sys/mount.h>

32 .Ft int

33 .Fn fhopen "const struct fhandle *fhp" "int flags"

34 .Sh DESCRIPTION

35 The file specified by the given file handle is opened for reading and/or

36 writing, as specified by the argument

37 .Fa flags ;

38 the file descriptor is returned to the calling process.

39 .Pp

40 This system call is restricted to the super-user and is used by an

41 NFS server's

42 .Xr rpc.lockd 8

43 daemon to open a file in order to perform locking operations on it.

44 .Sh RETURN VALUES

45 Upon successful completion, a value of 0 is returned.

46 Otherwise, -1 is returned and the global variable

47 .Va errno

48 is set to indicate the error.

49 .Sh ERRORS

50 .Fn fhopen

51 fails if one or more of the following are true:

52 .Bl -tag -width Er

53 .It Bq ESTALE

54 The file handle no longer refers to a valid, NFS-exported object.

55 .It Bq EPERM

56 The caller is not the super-user.

57 .It Bq EINVAL

58 There was a problem with the value of one of the arguments.

59 .It Bq EFAULT

60 .Fa fhp

61 points to an invalid address.

62 .El

63 .Sh SEE ALSO

64 .Xr rpc.lockd 8