release/man2/getdents.2

   1 .\" Copyright (C) 1995 Andries Brouwer (aeb@cwi.nl)
   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 .\" 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>
  29 .\"
  30 .\"*******************************************************************
  31 .\"
  32 .\" This file was generated with po4a. Translate the source file.
  33 .\"
  34 .\"*******************************************************************
  35 .\"
  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>
  45 .\"
  46 .TH GETDENTS 2 2012\-08\-03 Linux "Linux Programmer's Manual"
  47 .SH 名前
  48 getdents \- ディレクトリエントリーを取得する
  49 .SH 書式
  50 .nf
  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
  53 .fi
  54
  55 \fI注\fP: このシステムコールには glibc のラッパー関数は存在しない。「注意」の節を参照。
  56 .SH 説明
  57 これはあなたの関心を引くような関数ではない。 POSIX 準拠の C ライブラリインターフェースについては \fBreaddir\fP(3)  を見ること。
  58 このページは、カーネルシステムコールの生のインターフェースについて 記載したものである。
  59 .PP
  60 \fBgetdents\fP()  システムコールは、オープン済みのファイルディスクリプター \fIfd\fP で参照されるディレクトリから
  61 \fIlinux_dirent\fP 構造体をいくつか読み出し、 \fIdirp\fP が指しているバッファーに格納する。 \fIcount\fP
  62 引き数はそのバッファーのサイズを示す。
  63 .PP
  64 \fIlinux_dirent\fP 構造体は以下のように宣言されている:
  65 .PP
  66 .in +4n
  67 .nf
  68 struct linux_dirent {
  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)) */
  75     /*
  76     char           pad;       // Zero padding byte
  77     char           d_type;    // File type (only since Linux
  78                               // 2.6.4); offset is (d_reclen \- 1)
  79     */
  80
  81 }
  82 .fi
  83 .in
  84 .PP
  85 \fId_ino\fP は inode 番号である。 \fId_off\fP はディレクトリの先頭から次の \fIlinux_dirent\fP の先頭までの距離である。
  86 \fId_reclen\fP はこの \fIlinux_dirent\fP 全体のサイズである。 \fId_name\fP はヌル文字で終わるファイル名である。
  87
  88 \fId_type\fP は、構造体の最後のバイトであり、ファイルタイプを示す。 \fId_type\fP は以下の値の一つを取る
  89 (\fI<dirent.h>\fP で定義されている)。
  90 .TP  12
  91 \fBDT_BLK\fP
  92 ブロックデバイスである。
  93 .TP
  94 \fBDT_CHR\fP
  95 キャラクターデバイスである。
  96 .TP
  97 \fBDT_DIR\fP
  98 ディレクトリである。
  99 .TP
 100 \fBDT_FIFO\fP
 101 名前付きパイプ (FIFO) である。
 102 .TP
 103 \fBDT_LNK\fP
 104 シンボリックリンクである。
 105 .TP
 106 \fBDT_REG\fP
 107 通常のファイルである。
 108 .TP
 109 \fBDT_SOCK\fP
 110 UNIX ドメインソケットである。
 111 .TP
 112 \fBDT_UNKNOWN\fP
 113 ファイルタイプが不明である。
 114 .PP
 115 \fId_type\fP フィールドは Linux 2.6.4 から実装されている。 これは \fIlinux_dirent\fP
 116 構造体のうち、以前はゼロで埋められていた空間に配置されている。 従って、2.6.3 以前のカーネルでは、このフィールドにアクセスしようとすると 常に値
 117 0 (\fBDT_UNKNOWN\fP)  が返される。
 118 .PP
 119 .\" kernel 2.6.27
 120 .\" The same sentence is in readdir.2
 121 現在のところ、 \fId_type\fP でファイルタイプを返す機能が完全にサポートされているのは、 いくつかのファイルシステムにおいてのみである
 122 (Btrfs, ext2, ext3, ext4 はサポートしている)。 どのアプリケーションも、 \fBDT_UNKNOWN\fP
 123 が返された際に適切に処理できなければならない。
 124 .SH 返り値
 125 成功した場合は、読み込んだバイト数が返される。 ディレクトリの終わりならば 0 が返される。 エラーの場合は \-1 を返され、 \fIerrno\fP
 126 に適切な値が設定される。
 127 .SH エラー
 128 .TP
 129 \fBEBADF\fP
 130 ファイルディスクリプター \fIfd\fP が不正である。
 131 .TP
 132 \fBEFAULT\fP
 133 引き数が呼び出したプロセスのアドレス空間外を指している。
 134 .TP
 135 \fBEINVAL\fP
 136 結果用のバッファーが小さすぎる。
 137 .TP
 138 \fBENOENT\fP
 139 そのようなディレクトリは存在しない。
 140 .TP
 141 \fBENOTDIR\fP
 142 ファイルディスクリプターがディレクトリを参照していない。
 143 .SH 準拠
 144 .\" SVr4 documents additional ENOLINK, EIO error conditions.
 145 SVr4.
 146 .SH 注意
 147 glibc はこのシステムコールに対するラッパー関数を提供していないので、 \fBsyscall\fP(2)  を使って呼び出すこと。
 148 \fIlinux_dirent\fP 構造体は自分で定義する必要がある。しかし、たいていはこのシステムコールではなく \fBreaddir\fP(3)
 149 を使うべき場面のことが多い。
 150
 151 このシステムコールは \fBreaddir\fP(2)  を置き換えるものである。
 152
 153 元々の Linux の \fBgetdents\fP() システムコールは、大きなファイルシステムと
 154 大きなファイルオフセットを扱うことができなかった。
 155 その結果、Linux 2.4 で \fBgetdents64\fP() が追加された。
 156 \fBgetdents64\fP() では、\fIlinux_dirent\fP 構造体のフィールド \fId_ino\fP と
 157 \fId_off\fP でビット幅の大きなデータ型が使われている。
 158 .SH 例
 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 ディレクトリで実行した際に得られる
 162 出力の例である。
 163
 164 .in +4n
 165 .nf
 166 $\fB ./a.out /testfs/\fP
 167 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\- nread=120 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 168 inode#    file type  d_reclen  d_off   d_name
 169        2  directory    16         12  .
 170        2  directory    16         24  ..
 171       11  directory    24         44  lost+found
 172       12  regular      16         56  a
 173   228929  directory    16         68  sub
 174    16353  directory    16         80  sub2
 175   130817  directory    16       4096  sub3
 176 .fi
 177 .in
 178 .SS プログラムのソース
 179 \&
 180 .nf
 181 #define _GNU_SOURCE
 182 #include <dirent.h>     /* Defines DT_* constants */
 183 #include <fcntl.h>
 184 #include <stdio.h>
 185 #include <unistd.h>
 186 #include <stdlib.h>
 187 #include <sys/stat.h>
 188 #include <sys/syscall.h>
 189
 190 #define handle_error(msg) \e
 191         do { perror(msg); exit(EXIT_FAILURE); } while (0)
 192
 193 struct linux_dirent {
 194     long           d_ino;
 195     off_t          d_off;
 196     unsigned short d_reclen;
 197     char           d_name[];
 198 };
 199
 200 #define BUF_SIZE 1024
 201
 202 int
 203 main(int argc, char *argv[])
 204 {
 205     int fd, nread;
 206     char buf[BUF_SIZE];
 207     struct linux_dirent *d;
 208     int bpos;
 209     char d_type;
 210
 211     fd = open(argc > 1 ? argv[1] : ".", O_RDONLY | O_DIRECTORY);
 212     if (fd == \-1)
 213         handle_error("open");
 214
 215     for ( ; ; ) {
 216         nread = syscall(SYS_getdents, fd, buf, BUF_SIZE);
 217         if (nread == \-1)
 218             handle_error("getdents");
 219
 220         if (nread == 0)
 221             break;
 222
 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;
 239         }
 240     }
 241
 242     exit(EXIT_SUCCESS);
 243 }
 244 .fi
 245 .SH 関連項目
 246 \fBreaddir\fP(2), \fBreaddir\fP(3)
 247 .SH この文書について
 248 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部
 249 である。プロジェクトの説明とバグ報告に関する情報は
 250 http://www.kernel.org/doc/man\-pages/ に書かれている。