manual/LDP_man-pages/original/man2/fstatat.2

   1 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH FSTATAT 2 2013-07-21 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 fstatat \- get file status relative to a directory file descriptor
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <fcntl.h>           /* Definition of AT_* constants */
  31 .B #include <sys/stat.h>
  32 .sp
  33 .BI "int fstatat(int " dirfd ", const char *" pathname ", struct stat *" \
  34 buf ,
  35 .BI "            int " flags );
  36 .fi
  37 .sp
  38 .in -4n
  39 Feature Test Macro Requirements for glibc (see
  40 .BR feature_test_macros (7)):
  41 .in
  42 .sp
  43 .BR fstatat ():
  44 .PD 0
  45 .ad l
  46 .RS 4
  47 .TP 4
  48 Since glibc 2.10:
  49 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  50 .TP
  51 Before glibc 2.10:
  52 _ATFILE_SOURCE
  53 .RE
  54 .ad
  55 .PD
  56 .SH DESCRIPTION
  57 The
  58 .BR fstatat ()
  59 system call operates in exactly the same way as
  60 .BR stat (2),
  61 except for the differences described in this manual page.
  62
  63 If the pathname given in
  64 .I pathname
  65 is relative, then it is interpreted relative to the directory
  66 referred to by the file descriptor
  67 .I dirfd
  68 (rather than relative to the current working directory of
  69 the calling process, as is done by
  70 .BR stat (2)
  71 for a relative pathname).
  72
  73 If
  74 .I pathname
  75 is relative and
  76 .I dirfd
  77 is the special value
  78 .BR AT_FDCWD ,
  79 then
  80 .I pathname
  81 is interpreted relative to the current working
  82 directory of the calling process (like
  83 .BR stat (2)).
  84
  85 If
  86 .I pathname
  87 is absolute, then
  88 .I dirfd
  89 is ignored.
  90
  91 .I flags
  92 can either be 0, or include one or more of the following flags ORed:
  93 .TP
  94 .BR AT_EMPTY_PATH " (since Linux 2.6.39)"
  95 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
  96 If
  97 .I pathname
  98 is an empty string, operate on the file referred to by
  99 in which case the call operates on the file referred to by
 100 .IR dirfd
 101 (which may have been obtained using the
 102 .BR open (2)
 103 .B O_PATH
 104 flag).
 105 In this case,
 106 .I dirfd
 107 can refer to any type of file, not just a directory.
 108
 109 .TP
 110 .BR AT_NO_AUTOMOUNT " (since Linux 2.6.38)"
 111 Don't automount the terminal ("basename") component of
 112 .I pathname
 113 if it is a directory that is an automount point.
 114 This allows the caller to gather attributes of an automount point
 115 (rather than the location it would mount).
 116 This flag can be used in tools that scan directories
 117 to prevent mass-automounting of a directory of automount points.
 118 The
 119 .B AT_NO_AUTOMOUNT
 120 flag has no effect if the mount point has already been mounted over.
 121 .TP
 122 .B AT_SYMLINK_NOFOLLOW
 123 If
 124 .I pathname
 125 is a symbolic link, do not dereference it:
 126 instead return information about the link itself, like
 127 .BR lstat (2).
 128 (By default,
 129 .BR fstatat ()
 130 dereferences symbolic links, like
 131 .BR stat (2).)
 132 .SH RETURN VALUE
 133 On success,
 134 .BR fstatat ()
 135 returns 0.
 136 On error, \-1 is returned and
 137 .I errno
 138 is set to indicate the error.
 139 .SH ERRORS
 140 The same errors that occur for
 141 .BR stat (2)
 142 can also occur for
 143 .BR fstatat ().
 144 The following additional errors can occur for
 145 .BR fstatat ():
 146 .TP
 147 .B EBADF
 148 .I dirfd
 149 is not a valid file descriptor.
 150 .TP
 151 .B EINVAL
 152 Invalid flag specified in
 153 .IR flags .
 154 .TP
 155 .B ENOTDIR
 156 .I pathname
 157 is relative and
 158 .I dirfd
 159 is a file descriptor referring to a file other than a directory.
 160 .SH VERSIONS
 161 .BR fstatat ()
 162 was added to Linux in kernel 2.6.16;
 163 library support was added to glibc in version 2.4.
 164 .SH CONFORMING TO
 165 POSIX.1-2008.
 166 A similar system call exists on Solaris.
 167 .SH NOTES
 168 See
 169 .BR openat (2)
 170 for an explanation of the need for
 171 .BR fstatat ().
 172
 173 The underlying system call employed by the glibc
 174 .BR fstatat ()
 175 wrapper function is actually called
 176 .BR fstatat64 ().
 177 .SH SEE ALSO
 178 .BR openat (2),
 179 .BR stat (2),
 180 .BR path_resolution (7),
 181 .BR symlink (7)