release/man2/openat.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 .\"*******************************************************************
  26 .\"
  27 .\" This file was generated with po4a. Translate the source file.
  28 .\"
  29 .\"*******************************************************************
  30 .TH OPENAT 2 2012\-05\-04 Linux "Linux Programmer's Manual"
  31 .SH 名前
  32 openat \- ディレクトリファイルディスクリプタから相対的な位置にあるファイルをオープンする
  33 .SH 書式
  34 .nf
  35 \fB#include <fcntl.h>\fP
  36 .sp
  37 \fBint openat(int \fP\fIdirfd\fP\fB, const char *\fP\fIpathname\fP\fB, int \fP\fIflags\fP\fB);\fP
  38 \fBint openat(int \fP\fIdirfd\fP\fB, const char *\fP\fIpathname\fP\fB, int \fP\fIflags\fP\fB, mode_t \fP\fImode\fP\fB);\fP
  39 .fi
  40 .sp
  41 .in -4n
  42 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  43 .in
  44 .sp
  45 \fBopenat\fP():
  46 .PD 0
  47 .ad l
  48 .RS 4
  49 .TP  4
  50 glibc 2.10 以降:
  51 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  52 .TP
  53 glibc 2.10 より前:
  54 _ATFILE_SOURCE
  55 .RE
  56 .ad
  57 .PD
  58 .SH 説明
  59 \fBopenat\fP()  システムコールは、この man ページで説明している違いがある以外は、 \fBopen\fP(2)  と全く同じように動作する。
  60
  61 \fIpathname\fP で指定されるパス名が相対パスである場合、 ファイルディスクリプタ \fIdirfd\fP
  62 で参照されるディレクトリからの相対パス名として解釈される (\fBopen\fP(2)
  63 では、相対パスは呼び出し元プロセスのカレントワーキングディレクトリからの 相対パスとなる)。
  64
  65 \fIpathname\fP が相対パスであり、かつ \fIdirfd\fP が特別な値 \fBAT_FDCWD\fP である場合、 \fIpathname\fP は
  66 (\fBopen\fP(2)  と同じように) 呼び出し元プロセスの カレントワーキングディレクトリからの相対パス名として解釈される。
  67
  68 \fIpathname\fP が絶対パスである場合、 \fIdirfd\fP は無視される。
  69 .SH 返り値
  70 成功した場合、 \fBopenat\fP()  は新しいファイルディスクリプタを返す。 エラーの場合、\-1 が返されて、 \fIerrno\fP
  71 にはエラーを示す値が設定される。
  72 .SH エラー
  73 \fBopen\fP(2)  と同じエラーが \fBopenat\fP()  でも起こる。 \fBopenat\fP()  では、その他に以下のエラーが起こる:
  74 .TP
  75 \fBEBADF\fP
  76 \fIdirfd\fP が有効なファイルディスクリプタでない。
  77 .TP
  78 \fBENOTDIR\fP
  79 \fIpathname\fP が相対パスで、かつ \fIdirfd\fP がディレクトリ以外のファイルを参照するファイルディスクリプタである。
  80 .SH バージョン
  81 \fBopenat\fP()  は Linux カーネル 2.6.16 で追加された。
  82 ライブラリによるサポートは glibc バージョン 2.4 で追加された。
  83 .SH 準拠
  84 .\" The 'at' suffix in Solaris is actually double sensed.  It
  85 .\" primarily referred to "extended *at*tributes", which are
  86 .\" handled by Solaris' O_XATTR flag, but was also intended
  87 .\" to refer to the notion of "at a relative location".
  88 .\"
  89 .\" See the following for a discussion of the inconsistent
  90 .\" naming of the *at() functions:
  91 .\" http://www.opengroup.org/austin/mailarchives/ag/msg09103.html
  92 .\" Subject:    RE: The naming of at()s is a difficult matter
  93 .\" From:       Don Cragun
  94 .\" Date:       Tue, 14 Feb 2006 14:56:50 -0800 (PST)
  95 .\"
  96 POSIX.1\-2008.  Solaris には、これと同じようなシステムコールが存在する。
  97 .SH 注意
  98 \fBopenat\fP()  や "at" が後ろに付いたその他の同様のシステムコールは、 2 つの理由により提供されている。
  99
 100 1 つ目の理由は、 カレントワーキングディレクトリ以外のディレクトリにあるファイル群を \fBopen\fP(2)
 101 でオープンするときに起こる可能性がある競合状態 (race condition) を、 \fBopenat\fP()
 102 によってアプリケーションが回避できるためである。 これらの競合状態は、 \fBopen\fP(2)  に指定されたパスのディレクトリ部分の (/
 103 で区切られた) いくつかの構成要素 (をオープンする処理) が、 \fBopen\fP(2)  を並列に呼び出す処理に変換された場合に起こる。
 104 このような競合は、対象ディレクトリのファイルディスクリプタをオープンし、 そのファイルディスクリプタを \fBopenat\fP()  の \fIdirfd\fP
 105 引き数に指定することで回避できる。
 106
 107 2 つ目の理由は、 アプリケーションによって管理されるファイルディスクリプタ (群) を使うことで、 \fBopenat\fP()
 108 がスレッド毎のいわゆる「カレントワーキングディレクトリ」を実装できるためである。 (この機能は \fI/proc/self/fd/\fPdirfd
 109 を使った裏技でも実現できるが、あまり効率的ではない)。
 110 .SH 関連項目
 111 \fBfaccessat\fP(2), \fBfchmodat\fP(2), \fBfchownat\fP(2), \fBfstatat\fP(2),
 112 \fBfutimesat\fP(2), \fBlinkat\fP(2), \fBmkdirat\fP(2), \fBmknodat\fP(2), \fBopen\fP(2),
 113 \fBreadlinkat\fP(2), \fBrenameat\fP(2), \fBsymlinkat\fP(2), \fBunlinkat\fP(2),
 114 \fButimensat\fP(2), \fBmkfifoat\fP(3), \fBpath_resolution\fP(7)
 115 .SH この文書について
 116 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 117 である。プロジェクトの説明とバグ報告に関する情報は
 118 http://www.kernel.org/doc/man\-pages/ に書かれている。