release/man3/readdir.3

   1 .\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk)
   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 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 16:09:49 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified 11 June 1995 by Andries Brouwer (aeb@cwi.nl)
  31 .\" Modified 22 July 1996 by Andries Brouwer (aeb@cwi.nl)
  32 .\" 2007-07-30 Ulrich Drepper <drepper@redhat.com>, mtk:
  33 .\"     Rework discussion of nonstandard structure fields.
  34 .\" 2008-09-11, mtk, Document readdir_r().
  35 .\"
  36 .\"*******************************************************************
  37 .\"
  38 .\" This file was generated with po4a. Translate the source file.
  39 .\"
  40 .\"*******************************************************************
  41 .TH READDIR 3 2013\-03\-24 "" "Linux Programmer's Manual"
  42 .SH 名前
  43 readdir, readdir_r \- ディレクトリを読み込む
  44 .SH 書式
  45 .nf
  46 \fB#include <dirent.h>\fP
  47 .sp
  48 \fBstruct dirent *readdir(DIR *\fP\fIdirp\fP\fB);\fP
  49 .sp
  50 \fBint readdir_r(DIR *\fP\fIdirp\fP\fB, struct dirent *\fP\fIentry\fP\fB, struct dirent **\fP\fIresult\fP\fB);\fP
  51 .fi
  52 .sp
  53 .in -4n
  54 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  55 .ad l
  56 .in
  57 .sp
  58 \fBreaddir_r\fP():
  59 .RS 4
  60 _POSIX_C_SOURCE\ >=\ 1 || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE
  61 || _POSIX_SOURCE
  62 .RE
  63 .ad b
  64 .SH 説明
  65 \fBreaddir\fP()  関数は、\fIdirp\fP が指すディレクトリストリームの中で、 次のディレクトリエントリを表す \fIdirent\fP
  66 構造体へのポインタを返す。 ディレクトリストリームの末尾に達した場合や、 エラーが発生した場合は、 NULL を返す。
  67 .PP
  68 Linux では \fIdirent\fP 構造体は以下のように定義されている。
  69 .PP
  70 .in +4n
  71 .nf
  72 struct dirent {
  73     ino_t          d_ino;       /* inode 番号 */
  74     off_t          d_off;       /* オフセットではない; 注意を参照 */
  75     unsigned short d_reclen;    /* このレコードの長さ */
  76     unsigned char  d_type;      /* ファイル種別。全ファイルシステム */
  77                                    でサポートされているわけではない */
  78     char           d_name[256]; /* ファイル名 */
  79 };
  80 .fi
  81 .in
  82 .PP
  83 \fIdirent\fP 構造体のフィールドで POSIX.1 で要求されているのは、 \fId_name\fP[] と (XSI 拡張での)  \fId_ino\fP
  84 だけである。 \fId_name\fP[] はその大きさも規定されておらず、 このフィールドには最大で \fBNAME_MAX\fP 個の文字と、それに続く終端の
  85 NULL バイトが格納される。 他のフィールドは非標準であり、全てのシステムに存在するわけではない。 詳細については、下記の「注意」を参照のこと。
  86 .PP
  87 \fBreaddir\fP()  によって返されるデータは、それ以降の同じストリームに対する \fBreaddir\fP()
  88 の呼び出しによって上書きされる可能性がある。
  89
  90 \fBreaddir_r\fP()  関数は \fBreaddir\fP()  のリエントラント版である。 この関数はディレクトリストリーム \fIdirp\fP
  91 から次のディレクトリエントリを読み込み、 \fIentry\fP が指す呼び出し元が割り当てたバッファにそのエントリを格納して返す
  92 (このバッファの割り当てについては「注意」の節を参照のこと)。 返されるエントリへのポインタが \fI*result\fP
  93 に格納される。ディレクトリストリームの末尾に達した場合は、 NULL が \fI*result\fP に格納される。
  94 .SH 返り値
  95 成功すると、 \fBreaddir\fP()  は \fIdirent\fP 構造体へのポインタを返す。 (この構造体は静的に割り当てられているかもしれない。
  96 このポインタを \fBfree\fP(3)  しようとしないこと。)  ディレクトリストリームの末尾に達した場合には、NULL が返され、 \fIerrno\fP
  97 は変化しない。 エラーが発生した場合、NULL が返され、 \fIerrno\fP が適切に設定される。
  98
  99 成功すると、 \fBreaddir_r\fP()  関数は 0 を返す。 エラーの場合、(「エラー」の節のリストに載っている) 正のエラー番号を返す。
 100 ディレクトリストリームの末尾に達した場合、 \fBreaddir_r\fP()  は返り値として 0 を返し、 \fI*result\fP に NULL
 101 を格納する。
 102 .SH エラー
 103 .TP
 104 \fBEBADF\fP
 105 ディレクトリストリームディスクリプタ \fIdirp\fP が無効である。
 106 .SH 準拠
 107 SVr4, 4.3BSD, POSIX.1\-2001.
 108 .SH 注意
 109 フィールド \fId_name\fP と \fId_ino\fP だけが POSIX.1\-2001 で規定されている。
 110 残りのフィールドは多くのシステムに存在するが、全てのシステムに 存在するわけではない。 glibc では、プログラムが POSIX.1
 111 で定義されていないフィールドが 利用できるかをチェックすることができる。 チェックするには、マクロ \fB_DIRENT_HAVE_D_NAMLEN\fP,
 112 \fB_DIRENT_HAVE_D_RECLEN\fP, \fB_DIRENT_HAVE_D_OFF\fP, \fB_DIRENT_HAVE_D_TYPE\fP
 113 が定義されているかをテストすればよい。
 114
 115 .\" https://lwn.net/Articles/544298/
 116 \fId_off\fP で返される値は \fBtelldir\fP(3) が返す値と同じで、ディレクトリストリーム内の現在の位置を示す。
 117 フィールドの型や名前はこうなっていますが、最近のファイルシステムでは \fId_off\fP
 118 フィールドが何らかのディレクトリオフセットであることはめったいにない。アプリケーションプログラムでは、必ずこの値を内容を意識せず単なる値として扱うべきであり、その内容について前提を持つべきではない。
 119
 120 \fId_type\fP フィールドは、Linux 以外では、 主に BSD 系のシステムにだけ存在する。 このフィールドを使うと、
 121 その後の動作がファイルの種別により決まる場合に、 \fBlstat\fP(2)  を呼び出すコストを避けることができる。 機能検査マクロ
 122 \fB_BSD_SOURCE\fP が定義された場合、glibc は \fId_type\fP で返される値として以下のマクロ定数を定義する。
 123 .TP  12
 124 \fBDT_BLK\fP
 125 ブロックデバイスである。
 126 .TP
 127 \fBDT_CHR\fP
 128 キャラクタデバイスである。
 129 .TP
 130 \fBDT_DIR\fP
 131 ディレクトリである。
 132 .TP
 133 \fBDT_FIFO\fP
 134 名前付きパイプ (FIFO) である。
 135 .TP
 136 \fBDT_LNK\fP
 137 シンボリックリンクである。
 138 .TP
 139 \fBDT_REG\fP
 140 通常のファイルである。
 141 .TP
 142 \fBDT_SOCK\fP
 143 UNIX ドメインソケットである。
 144 .TP
 145 \fBDT_UNKNOWN\fP
 146 .\" The glibc manual says that on some systems this is the only
 147 .\" value returned
 148 ファイルタイプが不明である。
 149 .PP
 150 ファイル種別を決定できなかった場合には、 \fId_type\fP に \fBDT_UNKNOWN\fP が入る。
 151
 152 .\" kernel 2.6.27
 153 .\" The same sentence is in getdents.2
 154 現在のところ、 \fId_type\fP でファイルタイプを返す機能が完全にサポートされているのは、 いくつかのファイルシステムにおいてのみである
 155 (Btrfs, ext2, ext3, ext4 はサポートしている)。 どのアプリケーションも、 \fBDT_UNKNOWN\fP
 156 が返された際に適切に処理できなければならない。
 157
 158 POSIX.1 では \fId_name\fP フィールドのサイズは規定されておらず、 \fIdirent\fP 構造体の \fId_name\fP
 159 の後ろに他の非標準のフィールドがあるかもしれないので、 移植性が必要なアプリケーションで \fBreaddir_r\fP()  を使う場合は \fIentry\fP
 160 に渡すバッファを次のようにして割り当てるべきである。
 161 .in +4n
 162 .nf
 163
 164 name_max = pathconf(dirpath, _PC_NAME_MAX);
 165 if (name_max == \-1)         /* 上限が定義されていない、またはエラー */
 166     name_max = 255;         /* 適当な値を入れる */
 167 len = offsetof(struct dirent, d_name) + name_max + 1;
 168 entryp = malloc(len);
 169
 170 .fi
 171 .in
 172 (POSIX.1 では \fIstruct dirent\fP の最後のフィールドが \fId_name\fP であることを要求している。)
 173 .SH 関連項目
 174 \fBgetdents\fP(2), \fBread\fP(2), \fBclosedir\fP(3), \fBdirfd\fP(3), \fBftw\fP(3),
 175 \fBoffsetof\fP(3), \fBopendir\fP(3), \fBrewinddir\fP(3), \fBscandir\fP(3),
 176 \fBseekdir\fP(3), \fBtelldir\fP(3)
 177 .SH この文書について
 178 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.51 の一部
 179 である。プロジェクトの説明とバグ報告に関する情報は
 180 http://www.kernel.org/doc/man\-pages/ に書かれている。