1 .\" Copyright (C) 1995 Andries Brouwer (aeb@cwi.nl)
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.
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.
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
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" Written 11 June 1995 by Andries Brouwer <aeb@cwi.nl>
26 .\" Modified 22 July 1995 by Michael Chastain <mec@duracef.shout.net>:
27 .\" Derived from 'readdir.2'.
28 .\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
30 .\"*******************************************************************
32 .\" This file was generated with po4a. Translate the source file.
34 .\"*******************************************************************
36 .\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
37 .\" all rights reserved.
38 .\" Translated Sat Feb 22 20:15:56 JST 1997
39 .\" by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
40 .\" Updated Sun Oct 12 JST 2003 by Kentaro Shirakata <argrath@ub32.org>
41 .\" Updated Wed Jul 30 JST 2008 by Kentaro Shirakata <argrath@ub32.org>
42 .\" Updated 2009-02-12 by Kentaro Shirakata <argrath@ub32.org>
43 .\" Updated 2012-04-30, Akihiro MOTOKI <amotoki@gmail.com>
44 .\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
46 .TH GETDENTS 2 2012\-08\-03 Linux "Linux Programmer's Manual"
48 getdents \- ディレクトリ・エントリを取得する
51 \fBint getdents(unsigned int \fP\fIfd\fP\fB, struct linux_dirent *\fP\fIdirp\fP\fB,\fP
52 \fB unsigned int \fP\fIcount\fP\fB);\fP
55 \fI注\fP: このシステムコールには glibc のラッパー関数は存在しない。「注意」の節を参照。
57 これはあなたの関心を引くような関数ではない。 POSIX 準拠の C ライブラリインターフェースについては \fBreaddir\fP(3) を見ること。
58 このページは、カーネルシステムコールの生のインターフェースについて 記載したものである。
60 \fBgetdents\fP() システムコールは、オープン済みのファイルディスクリプタ \fIfd\fP で参照されるディレクトリから
61 \fIlinux_dirent\fP 構造体をいくつか読み出し、 \fIdirp\fP が指しているバッファに格納する。 \fIcount\fP
64 \fIlinux_dirent\fP 構造体は以下のように宣言されている:
69 unsigned long d_ino; /* Inode number */
70 unsigned long d_off; /* Offset to next \fIlinux_dirent\fP */
71 unsigned short d_reclen; /* Length of this \fIlinux_dirent\fP */
72 char d_name[]; /* Filename (null\-terminated) */
73 /* length is actually (d_reclen \- 2 \-
74 offsetof(struct linux_dirent, d_name)) */
76 char pad; // Zero padding byte
77 char d_type; // File type (only since Linux
78 // 2.6.4); offset is (d_reclen \- 1)
85 \fId_ino\fP は inode 番号である。 \fId_off\fP はディレクトリの先頭から次の \fIlinux_dirent\fP の先頭までの距離である。
86 \fId_reclen\fP はこの \fIlinux_dirent\fP 全体のサイズである。 \fId_name\fP はヌル文字で終わるファイル名である。
88 \fId_type\fP は、構造体の最後のバイトであり、ファイルタイプを示す。 \fId_type\fP は以下の値の一つを取る
89 (\fI<dirent.h>\fP で定義されている)。
115 \fId_type\fP フィールドは Linux 2.6.4 から実装されている。 これは \fIlinux_dirent\fP
116 構造体のうち、以前はゼロで埋められていた空間に配置されている。 従って、2.6.3 以前のカーネルでは、このフィールドにアクセスしようとすると 常に値
117 0 (\fBDT_UNKNOWN\fP) が返される。
120 .\" The same sentence is in readdir.2
121 現在のところ、 \fId_type\fP でファイルタイプを返す機能が完全にサポートされているのは、 いくつかのファイルシステムにおいてのみである
122 (Btrfs, ext2, ext3, ext4 はサポートしている)。 どのアプリケーションも、 \fBDT_UNKNOWN\fP
123 が返された際に適切に処理できなければならない。
125 成功した場合は、読み込んだバイト数が返される。 ディレクトリの終わりならば 0 が返される。 エラーの場合は \-1 を返され、 \fIerrno\fP
130 ファイルディスクリプタ \fIfd\fP が不正である。
133 引き数が呼び出したプロセスのアドレス空間外を指している。
142 ファイルディスクリプタがディレクトリを参照していない。
144 .\" SVr4 documents additional ENOLINK, EIO error conditions.
147 glibc はこのシステムコールに対するラッパー関数を提供していないので、 \fBsyscall\fP(2) を使って呼び出すこと。
148 \fIlinux_dirent\fP 構造体は自分で定義する必要がある。しかし、たいていはこのシステムコールではなく \fBreaddir\fP(3)
151 このシステムコールは \fBreaddir\fP(2) を置き換えるものである。
153 元々の Linux の \fBgetdents\fP() システムコールは、大きなファイルシステムと
154 大きなファイルオフセットを扱うことができなかった。
155 その結果、Linux 2.4 で \fBgetdents64\fP() が追加された。
156 \fBgetdents64\fP() では、\fIlinux_dirent\fP 構造体のフィールド \fId_ino\fP と
157 \fId_off\fP でビット幅の大きなデータ型が使われている。
159 .\" FIXME The example program needs to be revised, since it uses the older
160 .\" getdents() system call and the structure with smaller field widths.
161 下記のプログラムは \fBgetdents\fP() の使用例を示したものである。 以下は、このプログラムを ext2 ディレクトリで実行した際に得られる
166 $\fB ./a.out /testfs/\fP
167 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\- nread=120 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
168 inode# file type d_reclen d_off d_name
171 11 directory 24 44 lost+found
173 228929 directory 16 68 sub
174 16353 directory 16 80 sub2
175 130817 directory 16 4096 sub3
182 #include <dirent.h> /* Defines DT_* constants */
187 #include <sys/stat.h>
188 #include <sys/syscall.h>
190 #define handle_error(msg) \e
191 do { perror(msg); exit(EXIT_FAILURE); } while (0)
193 struct linux_dirent {
196 unsigned short d_reclen;
200 #define BUF_SIZE 1024
203 main(int argc, char *argv[])
207 struct linux_dirent *d;
211 fd = open(argc > 1 ? argv[1] : ".", O_RDONLY | O_DIRECTORY);
213 handle_error("open");
216 nread = syscall(SYS_getdents, fd, buf, BUF_SIZE);
218 handle_error("getdents");
223 printf("\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- nread=%d \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\en", nread);
224 printf("inode# file type d_reclen d_off d_name\en");
225 for (bpos = 0; bpos < nread;) {
226 d = (struct linux_dirent *) (buf + bpos);
227 printf("%8ld ", d\->d_ino);
228 d_type = *(buf + bpos + d\->d_reclen \- 1);
229 printf("%\-10s ", (d_type == DT_REG) ? "regular" :
230 (d_type == DT_DIR) ? "directory" :
231 (d_type == DT_FIFO) ? "FIFO" :
232 (d_type == DT_SOCK) ? "socket" :
233 (d_type == DT_LNK) ? "symlink" :
234 (d_type == DT_BLK) ? "block dev" :
235 (d_type == DT_CHR) ? "char dev" : "???");
236 printf("%4d %10lld %s\en", d\->d_reclen,
237 (long long) d\->d_off, d\->d_name);
238 bpos += d\->d_reclen;
246 \fBreaddir\fP(2), \fBreaddir\fP(3)
248 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.76 の一部
249 である。プロジェクトの説明とバグ報告に関する情報は
250 http://www.kernel.org/doc/man\-pages/ に書かれている。