original/man2/fstatat.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 .TH FSTATAT 2 2011-09-19 "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_NO_AUTOMOUNT " (since Linux 2.6.38)"
  95 Don't automount the terminal ("basename") component of
  96 .I pathname
  97 if it is a directory that is an automount point.
  98 This allows the caller to gather attributes of an automount point
  99 (rather than the location it would mount).
 100 This flag can be used in tools that scan directories
 101 to prevent mass-automounting of a directory of automount points.
 102 The
 103 .B AT_NO_AUTOMOUNT
 104 flag has no effect if the mount point has already been mounted over.
 105 .TP
 106 .B AT_SYMLINK_NOFOLLOW
 107 If
 108 .I pathname
 109 is a symbolic link, do not dereference it:
 110 instead return information about the link itself, like
 111 .BR lstat (2).
 112 (By default,
 113 .BR fstatat ()
 114 dereferences symbolic links, like
 115 .BR stat (2).)
 116 .SH "RETURN VALUE"
 117 On success,
 118 .BR fstatat ()
 119 returns 0.
 120 On error, \-1 is returned and
 121 .I errno
 122 is set to indicate the error.
 123 .SH ERRORS
 124 The same errors that occur for
 125 .BR stat (2)
 126 can also occur for
 127 .BR fstatat ().
 128 The following additional errors can occur for
 129 .BR fstatat ():
 130 .TP
 131 .B EBADF
 132 .I dirfd
 133 is not a valid file descriptor.
 134 .TP
 135 .B EINVAL
 136 Invalid flag specified in
 137 .IR flags .
 138 .TP
 139 .B ENOTDIR
 140 .I pathname
 141 is relative and
 142 .I dirfd
 143 is a file descriptor referring to a file other than a directory.
 144 .SH VERSIONS
 145 .BR fstatat ()
 146 was added to Linux in kernel 2.6.16.
 147 .SH "CONFORMING TO"
 148 POSIX.1-2008.
 149 A similar system call exists on Solaris.
 150 .SH NOTES
 151 See
 152 .BR openat (2)
 153 for an explanation of the need for
 154 .BR fstatat ().
 155
 156 The underlying system call employed by the glibc
 157 .BR fstatat ()
 158 wrapper function is actually called
 159 .BR fstatat64 ().
 160 .SH "SEE ALSO"
 161 .BR openat (2),
 162 .BR stat (2),
 163 .BR path_resolution (7),
 164 .BR symlink (7)