2006-03-06 04:36:54 +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-03-06 04:36:54 +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-03-06 04:36:54 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\"
|
|
|
|
.TH OPENAT 2 2006-03-06 "Linux 2.6.16" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
2006-04-06 05:19:00 +00:00
|
|
|
openat \- open a file relative to a directory file descriptor
|
2006-03-06 04:36:54 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
2007-03-01 02:31:08 +00:00
|
|
|
.B #define _ATFILE_SOURCE
|
2006-03-06 04:36:54 +00:00
|
|
|
.B #include <fcntl.h>
|
|
|
|
.sp
|
|
|
|
.BI "int openat(int " dirfd ", const char *" pathname ", int " flags );
|
|
|
|
.BI "int openat(int " dirfd ", const char *" pathname ", int " flags \
|
|
|
|
", mode_t " mode );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.BR openat ()
|
|
|
|
system call operates in exactly the same way as
|
|
|
|
.BR open (2),
|
|
|
|
except for the differences described in this manual page.
|
|
|
|
|
2007-04-12 22:42:49 +00:00
|
|
|
If the pathname given in
|
2006-03-06 04:36:54 +00:00
|
|
|
.I pathname
|
|
|
|
is relative, then it is interpreted relative to the directory
|
|
|
|
referred to by the file descriptor
|
2007-04-12 22:42:49 +00:00
|
|
|
.IR dirfd
|
|
|
|
(rather than relative to the current working directory of
|
2006-03-06 04:36:54 +00:00
|
|
|
the calling process, as is done by
|
|
|
|
.BR open (2)
|
|
|
|
for a relative pathname).
|
|
|
|
|
2006-08-09 09:08:01 +00:00
|
|
|
If
|
2006-03-06 04:36:54 +00:00
|
|
|
.I pathname
|
2007-04-12 22:42:49 +00:00
|
|
|
is relative and
|
2006-03-06 04:36:54 +00:00
|
|
|
.I dirfd
|
|
|
|
is the special value
|
|
|
|
.BR AT_FDCWD ,
|
2006-04-05 05:43:00 +00:00
|
|
|
then
|
|
|
|
.I pathname
|
2007-04-12 22:42:49 +00:00
|
|
|
is interpreted relative to the current working
|
2006-03-06 04:36:54 +00:00
|
|
|
directory of the calling process (like
|
|
|
|
.BR open (2)).
|
|
|
|
|
2006-08-09 09:08:01 +00:00
|
|
|
If
|
2006-03-06 04:36:54 +00:00
|
|
|
.IR pathname
|
2007-04-12 22:42:49 +00:00
|
|
|
is absolute, then
|
|
|
|
.I dirfd
|
2006-03-06 04:36:54 +00:00
|
|
|
is ignored.
|
|
|
|
.SH "RETURN VALUE"
|
2006-04-05 05:43:00 +00:00
|
|
|
On success,
|
2007-04-12 22:42:49 +00:00
|
|
|
.BR openat ()
|
2006-04-05 05:43:00 +00:00
|
|
|
returns a new file descriptor.
|
|
|
|
On error, \-1 is returned and
|
2006-03-06 04:36:54 +00:00
|
|
|
.I errno
|
2006-04-05 05:43:00 +00:00
|
|
|
is set to indicate the error.
|
2006-03-06 04:36:54 +00:00
|
|
|
.SH ERRORS
|
|
|
|
The same errors that occur for
|
|
|
|
.BR open (2)
|
|
|
|
can also occur for
|
2006-04-05 05:43:00 +00:00
|
|
|
.BR openat ().
|
2007-04-12 22:42:49 +00:00
|
|
|
The following additional errors can occur for
|
2006-03-06 04:36:54 +00:00
|
|
|
.BR openat ():
|
|
|
|
.TP
|
|
|
|
.B EBADF
|
|
|
|
.I dirfd
|
|
|
|
is not a valid file descriptor.
|
|
|
|
.TP
|
|
|
|
.B ENOTDIR
|
2006-04-06 05:19:00 +00:00
|
|
|
.I pathname
|
2006-08-08 16:34:16 +00:00
|
|
|
is relative and
|
2006-03-06 04:36:54 +00:00
|
|
|
.I dirfd
|
|
|
|
is a file descriptor referring to a file other than a directory.
|
|
|
|
.SH NOTES
|
|
|
|
.BR openat ()
|
2006-04-05 05:43:00 +00:00
|
|
|
and other similar system calls suffixed "at" are supported
|
|
|
|
for two reasons.
|
|
|
|
|
|
|
|
First,
|
|
|
|
.BR openat ()
|
2007-04-12 22:42:49 +00:00
|
|
|
allows an application to avoid race conditions that could
|
2006-04-05 05:43:00 +00:00
|
|
|
occur when using
|
|
|
|
.BR open (2)
|
|
|
|
to open files in directories other than the current working directory.
|
|
|
|
These race conditions result from the fact that some component
|
|
|
|
of the directory prefix given to
|
2007-05-11 23:07:02 +00:00
|
|
|
.BR open (2)
|
2007-04-12 22:42:49 +00:00
|
|
|
could be changed in parallel with the call to
|
2007-05-11 23:07:02 +00:00
|
|
|
.BR open (2).
|
2006-04-05 05:43:00 +00:00
|
|
|
Such races can be avoided by
|
|
|
|
opening a file descriptor for the target directory,
|
2007-04-12 22:42:49 +00:00
|
|
|
and then specifying that file descriptor as the
|
2006-04-05 05:43:00 +00:00
|
|
|
.I dirfd
|
|
|
|
argument of
|
|
|
|
.BR openat ().
|
|
|
|
|
|
|
|
Second,
|
|
|
|
.BR openat ()
|
2007-04-12 22:42:49 +00:00
|
|
|
allows the implementation of a per-thread "current working
|
2006-03-06 04:36:54 +00:00
|
|
|
directory", via file descriptor(s) maintained by the application.
|
|
|
|
(This functionality can also be obtained by tricks based
|
|
|
|
on the use of
|
2007-04-12 22:42:49 +00:00
|
|
|
.IR /proc/self/fd/ dirfd,
|
2006-03-06 04:36:54 +00:00
|
|
|
but less efficiently.)
|
|
|
|
.SH "CONFORMING TO"
|
2006-04-05 05:43:00 +00:00
|
|
|
This system call is non-standard but is proposed
|
|
|
|
for inclusion in a future revision of POSIX.1.
|
2006-03-06 04:36:54 +00:00
|
|
|
A similar system call exists on Solaris.
|
|
|
|
.\" The 'at' suffix in Solaris is actually double sensed. It
|
|
|
|
.\" primarily referred to "extended *at*tributes", which are
|
|
|
|
.\" handled by Solaris' O_XATTR flag, but was also intended
|
|
|
|
.\" to refer to the notion of "at a relative location".
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2006-04-05 05:43:00 +00:00
|
|
|
.\" See the following for a discussion of the inconsistent
|
2006-04-04 19:48:23 +00:00
|
|
|
.\" naming of the *at() functions:
|
|
|
|
.\" http://www.opengroup.org/austin/mailarchives/ag/msg09103.html
|
|
|
|
.\" Subject: RE: The naming of at()s is a difficult matter
|
|
|
|
.\" From: Don Cragun
|
|
|
|
.\" Date: Tue, 14 Feb 2006 14:56:50 -0800 (PST)
|
|
|
|
.\"
|
2006-03-06 04:36:54 +00:00
|
|
|
.SH VERSIONS
|
|
|
|
.BR openat ()
|
|
|
|
was added to Linux in kernel 2.6.16.
|
|
|
|
.SH "SEE ALSO"
|
2006-05-02 00:03:35 +00:00
|
|
|
.BR faccessat (2),
|
|
|
|
.BR fchmodat (2),
|
|
|
|
.BR fchownat (2),
|
2006-04-21 22:39:00 +00:00
|
|
|
.BR fstatat (2),
|
2006-05-02 00:03:35 +00:00
|
|
|
.BR futimesat (2),
|
2006-04-06 08:48:43 +00:00
|
|
|
.BR linkat (2),
|
2006-04-05 05:43:00 +00:00
|
|
|
.BR mkdirat (2),
|
|
|
|
.BR mknodat (2),
|
2006-03-06 04:36:54 +00:00
|
|
|
.BR open (2),
|
2006-04-05 05:43:00 +00:00
|
|
|
.BR path_resolution (2),
|
2006-07-21 14:38:06 +00:00
|
|
|
.BR readlinkat (2),
|
2006-04-06 08:48:43 +00:00
|
|
|
.BR renameat (2),
|
|
|
|
.BR symlinkat (2),
|
|
|
|
.BR unlinkat (2),
|
2006-04-05 05:43:00 +00:00
|
|
|
.BR mkfifoat (3).
|