share/man/man9/VOP_ACCESS.9

   1 .\" Copyright (c) 1996 Doug Rabson
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/VOP_ACCESS.9,v 1.7.2.4 2001/12/17 11:30:18 ru Exp $
  28 .\"
  29 .Dd October 8, 2014
  30 .Dt VOP_ACCESS 9
  31 .Os
  32 .Sh NAME
  33 .Nm VOP_ACCESS
  34 .Nd "check access permissions of a file or Unix domain socket"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .Ft int
  39 .Fn VOP_ACCESS "struct vnode *vp" "int mode" "struct ucred *cred"
  40 .Sh DESCRIPTION
  41 This entry point checks the access permissions of the file against the
  42 given credentials.
  43 .Pp
  44 Its arguments are:
  45 .Bl -tag -width mode
  46 .It Ar vp
  47 the vnode of the file to check
  48 .It Ar mode
  49 the type of access required
  50 .It Ar cred
  51 the user credentials to check
  52 .El
  53 .Pp
  54 The
  55 .Fa mode
  56 is a mask which can contain
  57 .Dv VREAD ,
  58 .Dv VWRITE
  59 or
  60 .Dv VEXEC .
  61 .Sh RETURN VALUES
  62 If the file is accessible in the specified way, then zero is returned,
  63 otherwise an appropriate error code is returned.
  64 .Sh ERRORS
  65 .Bl -tag -width Er
  66 .It Bq Er EPERM
  67 An attempt was made to change an immutable file
  68 .It Bq Er EACCES
  69 Permission denied
  70 .El
  71 .Sh SEE ALSO
  72 .Xr vnode 9
  73 .Sh AUTHORS
  74 This man page was written by
  75 .An Doug Rabson .