original/man2/faccessat.2

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\"
  26 .TH FACCESSAT 2 2012-05-04 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 faccessat \- check user's permissions of a file relative to a \
  29 directory file descriptor
  30 .SH SYNOPSIS
  31 .nf
  32 .B #include <fcntl.h>           /* Definition of AT_* constants */
  33 .B #include <unistd.h>
  34 .sp
  35 .BI "int faccessat(int " dirfd ", const char *" pathname ", int " \
  36 mode ", int " flags );
  37 .fi
  38 .sp
  39 .in -4n
  40 Feature Test Macro Requirements for glibc (see
  41 .BR feature_test_macros (7)):
  42 .in
  43 .sp
  44 .BR faccessat ():
  45 .PD 0
  46 .ad l
  47 .RS 4
  48 .TP 4
  49 Since glibc 2.10:
  50 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  51 .TP
  52 Before glibc 2.10:
  53 _ATFILE_SOURCE
  54 .RE
  55 .ad
  56 .PD
  57 .SH DESCRIPTION
  58 The
  59 .BR faccessat ()
  60 system call operates in exactly the same way as
  61 .BR access (2),
  62 except for the differences described in this manual page.
  63
  64 If the pathname given in
  65 .I pathname
  66 is relative, then it is interpreted relative to the directory
  67 referred to by the file descriptor
  68 .I dirfd
  69 (rather than relative to the current working directory of
  70 the calling process, as is done by
  71 .BR access (2)
  72 for a relative pathname).
  73
  74 If
  75 .I pathname
  76 is relative and
  77 .I dirfd
  78 is the special value
  79 .BR AT_FDCWD ,
  80 then
  81 .I pathname
  82 is interpreted relative to the current working
  83 directory of the calling process (like
  84 .BR access (2)).
  85
  86 If
  87 .I pathname
  88 is absolute, then
  89 .I dirfd
  90 is ignored.
  91
  92 .I flags
  93 is constructed by ORing together zero or more of the following values:
  94 .TP
  95 .B AT_EACCESS
  96 Perform access checks using the effective user and group IDs.
  97 By default,
  98 .BR faccessat ()
  99 uses the real IDs (like
 100 .BR access (2)).
 101 .TP
 102 .B AT_SYMLINK_NOFOLLOW
 103 If
 104 .I pathname
 105 is a symbolic link, do not dereference it:
 106 instead return information about the link itself.
 107 .SH "RETURN VALUE"
 108 On success, (all requested permissions granted)
 109 .BR faccessat ()
 110 returns 0.
 111 On error, \-1 is returned and
 112 .I errno
 113 is set to indicate the error.
 114 .SH ERRORS
 115 The same errors that occur for
 116 .BR access (2)
 117 can also occur for
 118 .BR faccessat ().
 119 The following additional errors can occur for
 120 .BR faccessat ():
 121 .TP
 122 .B EBADF
 123 .I dirfd
 124 is not a valid file descriptor.
 125 .TP
 126 .B EINVAL
 127 Invalid flag specified in
 128 .IR flags .
 129 .TP
 130 .B ENOTDIR
 131 .I pathname
 132 is relative and
 133 .I dirfd
 134 is a file descriptor referring to a file other than a directory.
 135 .SH VERSIONS
 136 .BR faccessat ()
 137 was added to Linux in kernel 2.6.16;
 138 library support was added to glibc in version 2.4.
 139 .SH "CONFORMING TO"
 140 POSIX.1-2008.
 141 .SH NOTES
 142 See
 143 .BR openat (2)
 144 for an explanation of the need for
 145 .BR faccessat ().
 146
 147 .IR Warning :
 148 .BR faccessat ()
 149 is subject to the same kinds of races as
 150 .BR access (2)
 151 and
 152 .BR euidaccess (3).
 153 .SS Glibc Notes
 154 The
 155 .B AT_EACCESS
 156 and
 157 .B AT_SYMLINK_NOFOLLOW
 158 flags are actually implemented within the glibc wrapper function for
 159 .BR faccessat ().
 160 If either of these flags are specified, then the wrapper function employs
 161 .BR fstatat (2)
 162 to determine access permissions.
 163 .SH "SEE ALSO"
 164 .BR access (2),
 165 .BR openat (2),
 166 .BR euidaccess (3),
 167 .BR credentials (7),
 168 .BR path_resolution (7),
 169 .BR symlink (7)