READ

Section: System Calls (2)
索引 jman

BSD mandoc

索引

名称

read readv pread - 入力を読み取る

索引

ライブラリ

Lb libc

索引

書式

In sys/types.h In sys/uio.h In unistd.h Ft ssize_t Fn read int d void *buf size_t nbytes Ft ssize_t Fn readv int d const struct iovec *iov int iovcnt Ft ssize_t Fn pread int d void *buf size_t nbytes off_t offset

索引

解説

Fn read システムコールは、記述子 Fa d で参照されたオブジェクトから Fa buf が指すバッファへ Fa nbytes のデータを読み取ろうとします。 Fn readv システムコールは同様の処理を実行しますが、配列 Fa iov : iov[0], iov[1], ..., iov[iovcnt-1] のメンバで指定される Fa iovcnt 個のバッファに入力データを分散させます。 Fn pread システムコールは同様の機能を実行しますが、ファイル内の指定の位置から読み取った後、ファイルポインタを変更しません。

Fn readv に対する Fa iovec 構造体は次のように定義されます:

struct iovec {
        void   *iov_base;  /* ベースアドレス */
        size_t iov_len;    /* 長さ */
};

Fa iovec の各エントリは、データを配置するべきメモリ領域のベースアドレスと長さを指定しています。 Fn readv システムコールは、次のエントリに進む前に必ず領域を完全に満たします。

シーク可能なオブジェクト上では Fn read は Fa d に結び付けられたポインタが指定する位置から開始します ( lseek(2) を参照)。 Fn read からの戻り時に、ポインタは実際に読み取られたバイト数だけ増加させられます。

シークできないオブジェクトは必ず現在の位置から読み取られます。そのようなオブジェクトに結び付けられたポインタの値は未定義です。

処理が成功すると、 Fn read , Fn readv および Fn pread は、実際に読み取られバッファ内に配置されたバイト数を返します。記述子が通常ファイルを参照しており、ファイルの終端までに十分な量のバイトがあれば、システムは要求されたバイト数を読み取ることを保証しますが、他のケースではそうではありません。

索引

戻り値

正常に完了すると、実際に読み取られたバイト数が返されます。ファイル終了 (EOF) が読み取られると 0 が返されます。そうでない場合は -1 が返され、エラーを示すためにグローバル変数 errno が設定されます。

索引

エラー

Fn read , Fn readv および Fn pread システムコールは次の場合を除いて正常に完了します:

Bq Er EBADF: Fa d 引数は読取り用にオープンされた有効なファイルまたはソケットの記述子ではありません。
Bq Er EFAULT: Fa buf 引数は、プロセスに割り当てられたアドレス空間の範囲外を指しています。
Bq Er EIO: ファイルシステムから読み取っている間に入出力エラーが発生しました。
Bq Er EINTR: データが到着する前に、シグナルの配送により低速デバイスからの読取りが割り込まれました。
Bq Er EINVAL: Fa d に結び付けられたポインタが負でした。
Bq Er EAGAIN: ファイルは非ブロッキング入出力とマークされており、読取りの準備ができたデータがありません。
Bq Er EISDIR: ファイル記述子が、ディレクトリ上での普通の読み込み操作を許可していないファイルシステム (例えば NFS) に属しているディレクトリに関連付けられています。
Bq Er EOPNOTSUPP: ファイル記述子が、普通の読み込み操作を許可していないファイルシステムおよびファイルタイプに関連付けられています。
Bq Er EOVERFLOW: ファイル記述子が普通のファイルに関連付けられていて、 Fa nbytes が 0 よりも大きく、 Fa offset がファイルの末尾の前にあり、かつ Fa offset がこのファイルシステムに収まるオフセットの最大値以上です。