2006-04-21 22:39:00 +00:00
|
|
|
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
|
|
.\"
|
|
|
|
.\" This manpage is Copyright (C) 2006, Michael Kerrisk
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-04-21 22:39:00 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-04-21 22:39:00 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
faccessat.2, fchmodat.2, fchownat.2, fstatat.2, futimesat.2, inotify_init.2, linkat.2, mkdirat.2, mknodat.2, openat.2, readlinkat.2, renameat.2, setns.2, splice.2, symlinkat.2, sync.2, tee.2, unlinkat.2, vmsplice.2: Global fix: note glibc version that added library support
Reported-by: Lauri Kasanen <curaga@operamail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-05-04 04:09:11 +00:00
|
|
|
.TH FSTATAT 2 2012-05-04 "Linux" "Linux Programmer's Manual"
|
2006-04-21 22:39:00 +00:00
|
|
|
.SH NAME
|
2006-04-21 22:53:05 +00:00
|
|
|
fstatat \- get file status relative to a directory file descriptor
|
2006-04-21 22:39:00 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
2007-10-08 18:45:41 +00:00
|
|
|
.B #include <fcntl.h> /* Definition of AT_* constants */
|
2006-04-21 23:12:01 +00:00
|
|
|
.B #include <sys/stat.h>
|
2006-04-21 22:39:00 +00:00
|
|
|
.sp
|
2006-08-09 09:08:01 +00:00
|
|
|
.BI "int fstatat(int " dirfd ", const char *" pathname ", struct stat *" \
|
2007-04-12 22:42:49 +00:00
|
|
|
buf ,
|
2007-04-03 14:04:54 +00:00
|
|
|
.BI " int " flags );
|
2006-04-21 22:39:00 +00:00
|
|
|
.fi
|
faccessat.2, fchmodat.2, fchownat.2, fstatat.2, futimesat.2, linkat.2, mkdirat.2, mknodat.2, openat.2, readlinkat.2, renameat.2, symlinkat.2, unlinkat.2, utimensat.2, mkfifoat.3: Update feature test macro requirements
Starting in glibc 2.10, defining _XOPEN_SOURCE >= 700,
or _POSIX_C_SOURCE >= 200809 exposes the declarations of
these functions.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2009-12-13 21:54:45 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.BR fstatat ():
|
2010-09-19 16:46:08 +00:00
|
|
|
.PD 0
|
|
|
|
.ad l
|
|
|
|
.RS 4
|
|
|
|
.TP 4
|
|
|
|
Since glibc 2.10:
|
|
|
|
_XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
|
|
|
|
.TP
|
faccessat.2, fchmodat.2, fchownat.2, fstatat.2, futimesat.2, linkat.2, mkdirat.2, mknodat.2, openat.2, readlinkat.2, renameat.2, symlinkat.2, unlinkat.2, utimensat.2, mkfifoat.3: Update feature test macro requirements
Starting in glibc 2.10, defining _XOPEN_SOURCE >= 700,
or _POSIX_C_SOURCE >= 200809 exposes the declarations of
these functions.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2009-12-13 21:54:45 +00:00
|
|
|
Before glibc 2.10:
|
|
|
|
_ATFILE_SOURCE
|
2010-09-19 16:46:08 +00:00
|
|
|
.RE
|
|
|
|
.ad
|
|
|
|
.PD
|
2006-04-21 22:39:00 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.BR fstatat ()
|
|
|
|
system call operates in exactly the same way as
|
|
|
|
.BR stat (2),
|
|
|
|
except for the differences described in this manual page.
|
|
|
|
|
2007-04-12 22:42:49 +00:00
|
|
|
If the pathname given in
|
2006-08-09 09:08:01 +00:00
|
|
|
.I pathname
|
2006-04-21 22:39:00 +00:00
|
|
|
is relative, then it is interpreted relative to the directory
|
|
|
|
referred to by the file descriptor
|
2007-09-20 16:26:31 +00:00
|
|
|
.I dirfd
|
2007-04-12 22:42:49 +00:00
|
|
|
(rather than relative to the current working directory of
|
2006-04-21 22:39:00 +00:00
|
|
|
the calling process, as is done by
|
|
|
|
.BR stat (2)
|
|
|
|
for a relative pathname).
|
|
|
|
|
2006-08-09 09:08:01 +00:00
|
|
|
If
|
|
|
|
.I pathname
|
2007-04-12 22:42:49 +00:00
|
|
|
is relative and
|
2006-04-21 22:39:00 +00:00
|
|
|
.I dirfd
|
|
|
|
is the special value
|
|
|
|
.BR AT_FDCWD ,
|
|
|
|
then
|
2006-08-09 09:08:01 +00:00
|
|
|
.I pathname
|
2007-04-12 22:42:49 +00:00
|
|
|
is interpreted relative to the current working
|
2006-04-21 22:39:00 +00:00
|
|
|
directory of the calling process (like
|
|
|
|
.BR stat (2)).
|
|
|
|
|
2006-08-09 09:08:01 +00:00
|
|
|
If
|
2007-09-20 16:26:31 +00:00
|
|
|
.I pathname
|
2007-04-12 22:42:49 +00:00
|
|
|
is absolute, then
|
|
|
|
.I dirfd
|
2006-04-21 22:39:00 +00:00
|
|
|
is ignored.
|
|
|
|
|
|
|
|
.I flags
|
2011-09-19 05:54:33 +00:00
|
|
|
can either be 0, or include one or more of the following flags ORed:
|
|
|
|
.TP
|
|
|
|
.BR AT_NO_AUTOMOUNT " (since Linux 2.6.38)"
|
|
|
|
Don't automount the terminal ("basename") component of
|
|
|
|
.I pathname
|
|
|
|
if it is a directory that is an automount point.
|
|
|
|
This allows the caller to gather attributes of an automount point
|
|
|
|
(rather than the location it would mount).
|
|
|
|
This flag can be used in tools that scan directories
|
|
|
|
to prevent mass-automounting of a directory of automount points.
|
2011-09-20 05:03:26 +00:00
|
|
|
The
|
|
|
|
.B AT_NO_AUTOMOUNT
|
|
|
|
flag has no effect if the mount point has already been mounted over.
|
2006-04-21 22:39:00 +00:00
|
|
|
.TP
|
|
|
|
.B AT_SYMLINK_NOFOLLOW
|
2007-04-12 22:42:49 +00:00
|
|
|
If
|
2006-08-09 09:08:01 +00:00
|
|
|
.I pathname
|
2007-04-12 22:42:49 +00:00
|
|
|
is a symbolic link, do not dereference it:
|
2006-04-21 22:39:00 +00:00
|
|
|
instead return information about the link itself, like
|
2007-04-12 22:42:49 +00:00
|
|
|
.BR lstat (2).
|
2006-04-21 22:39:00 +00:00
|
|
|
(By default,
|
|
|
|
.BR fstatat ()
|
2006-08-03 02:45:30 +00:00
|
|
|
dereferences symbolic links, like
|
2006-04-22 00:00:50 +00:00
|
|
|
.BR stat (2).)
|
2006-04-21 22:39:00 +00:00
|
|
|
.SH "RETURN VALUE"
|
|
|
|
On success,
|
2007-04-12 22:42:49 +00:00
|
|
|
.BR fstatat ()
|
|
|
|
returns 0.
|
2006-04-21 22:39:00 +00:00
|
|
|
On error, \-1 is returned and
|
|
|
|
.I errno
|
|
|
|
is set to indicate the error.
|
|
|
|
.SH ERRORS
|
|
|
|
The same errors that occur for
|
|
|
|
.BR stat (2)
|
|
|
|
can also occur for
|
|
|
|
.BR fstatat ().
|
2007-04-12 22:42:49 +00:00
|
|
|
The following additional errors can occur for
|
2006-04-21 22:39:00 +00:00
|
|
|
.BR fstatat ():
|
|
|
|
.TP
|
|
|
|
.B EBADF
|
|
|
|
.I dirfd
|
|
|
|
is not a valid file descriptor.
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
|
|
|
Invalid flag specified in
|
|
|
|
.IR flags .
|
|
|
|
.TP
|
|
|
|
.B ENOTDIR
|
2006-08-09 09:08:01 +00:00
|
|
|
.I pathname
|
2006-08-08 16:34:16 +00:00
|
|
|
is relative and
|
2006-04-21 22:39:00 +00:00
|
|
|
.I dirfd
|
|
|
|
is a file descriptor referring to a file other than a directory.
|
2007-05-18 16:06:42 +00:00
|
|
|
.SH VERSIONS
|
|
|
|
.BR fstatat ()
|
faccessat.2, fchmodat.2, fchownat.2, fstatat.2, futimesat.2, inotify_init.2, linkat.2, mkdirat.2, mknodat.2, openat.2, readlinkat.2, renameat.2, setns.2, splice.2, symlinkat.2, sync.2, tee.2, unlinkat.2, vmsplice.2: Global fix: note glibc version that added library support
Reported-by: Lauri Kasanen <curaga@operamail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-05-04 04:09:11 +00:00
|
|
|
was added to Linux in kernel 2.6.16;
|
|
|
|
library support was added to glibc in version 2.4.
|
2007-05-18 16:06:42 +00:00
|
|
|
.SH "CONFORMING TO"
|
2008-08-21 06:16:15 +00:00
|
|
|
POSIX.1-2008.
|
2007-05-18 16:06:42 +00:00
|
|
|
A similar system call exists on Solaris.
|
2006-04-21 22:39:00 +00:00
|
|
|
.SH NOTES
|
|
|
|
See
|
|
|
|
.BR openat (2)
|
|
|
|
for an explanation of the need for
|
|
|
|
.BR fstatat ().
|
2010-11-21 05:47:41 +00:00
|
|
|
|
|
|
|
The underlying system call employed by the glibc
|
2011-09-23 05:11:27 +00:00
|
|
|
.BR fstatat ()
|
2010-11-21 05:47:41 +00:00
|
|
|
wrapper function is actually called
|
|
|
|
.BR fstatat64 ().
|
2006-04-21 22:39:00 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR openat (2),
|
2007-05-26 12:41:39 +00:00
|
|
|
.BR stat (2),
|
2008-06-11 21:50:53 +00:00
|
|
|
.BR path_resolution (7),
|
|
|
|
.BR symlink (7)
|