sendfileのヘルプ・マニュアル／リナックスコマンド

sendfileのヘルプ・マニュアル

help
man

sendfile --help

man sendfile

SENDFILE(2) Linux Programmer’s Manual SENDFILE(2) 名前 sendfile - ファイル・ディスクリプタ間でデータを転送する書式 #include ssize_t sendfile(int out_fd, int in_fd, off_t *offset, size_t count); 説明 sendfile() は、あるファイル・ディスクリプタから別のファイル・ディスクリプタへのデータのコピーを行う。このコピーはカーネル内で行われるので、 sendfile() は、 read(2) と write(2) を組み合わせるよりも効率がよい。 read(2) や write(2) ではユーザ空間との間でデータの転送が必要となるからである。 in_fd は読み込みのためにオープンされたファイル・ディスクリプタ、 out_fd は書き込みのためにオープンされたディスクリプタでなければならない。 offset が NULL でない場合、 offset は sendfile() が in_fd のどこからデータを読み始めるかを示すファイル・オフセットを保持する変数へのポインタである。 sendfile() は復帰する時、この変数に最後に読み込んだバイトの次のバイトのオフセットを書き込む。 offset が NULL でない場合、 sendfile() は in_fd のファイル・オフセットの現在値を変更しない。 NULL の場合は、ファイル・オフセットの現在値を in_fd から読み込んだバイト数を反映した位置に調整する。 count は、ファイル・ディスクリプタ間でコピーするバイト数である。今のところ (Linux 2.6.9 では)、 in_fd は mmap(2) 風の操作ができるファイルを指していなければならない (ソケットを指してはならない)。また、 out_fd はソケットを指していなければならない。 sendfile() が EINVAL や ENOSYS で失敗するような場合は、アプリケーションは read(2)/write(2) に戻すことを考えてもよいかもしれない。返り値転送に成功した場合、 out_fd に書き込まれたバイト数を返す。エラーの場合、-1 を返し、 errno に適切な値を設定する。エラー EAGAIN O_NONBLOCK を用いて非ブロック I/O が選択されたが、書き込みがブロックされた。 EBADF 入力ファイルが読み込みのためにオープンされていないか、出力ファイルが書き込みのためにオープンされていない。 EFAULT アドレスがおかしい。 EINVAL ディスクリプタが有効でないか、ロックされている。もしくは mmap(2) 風の操作が in_fd では利用できない。 EIO in_fd から読み込んでいるうちに予期しないエラーが起こった。 ENOMEM in_fd から読み込むための十分なメモリがない。バージョン sendfile は Linux 2.2 の新しい機能である。インクルードファイルは glibc 2.1 から存在している。準拠 POSIX.1-2001 や他の標準では規定されていない。他の Unix システムでは、異なった方式やプロトタイプで sendfile() を実装している。移植性を考慮したプログラムでは使用すべきではない。注意 sendfile() を使って TCP ソケットにファイルを送ろうとしていて、ファイルの内容の前にヘッダ・データを付け加える必要がある場合は、パケット数を最小にして性能を上げるために tcp(7) に記述されている TCP_CORK オプションを使うといいだろう。 Linux 2.4 とそれ以前のバージョンでは、 out_fd は通常のファイルを参照でき、 sendfile() はそのファイルのオフセットの現在値を変更していた。関連項目 mmap(2), open(2), socket(2), splice(2) Linux 2004-12-17 SENDFILE(2)

SENDFILE(2) Linux Programmer’s Manual SENDFILE(2) NAME sendfile - transfer data between file descriptors SYNOPSIS #include ssize_t sendfile(int out_fd, int in_fd, off_t *offset, size_t count); DESCRIPTION sendfile() copies data between one file descriptor and another. Because this copying is done within the kernel, sendfile() is more efficient than the combination of read(2) and write(2), which would require transferring data to and from user space. in_fd should be a file descriptor opened for reading and out_fd should be a descriptor opened for writing. If offset is not NULL, then it points to a variable holding the file offset from which sendfile() will start reading data from in_fd. When sendfile() returns, this variable will be set to the offset of the byte following the last byte that was read. If offset is not NULL, then sendfile() does not modify the current file offset of in_fd; otherwise the current file offset is adjusted to reflect the number of bytes read from in_fd. count is the number of bytes to copy between the file descriptors. Presently (Linux 2.6.9): in_fd, must correspond to a file which sup- ports mmap(2)-like operations (i.e., it cannot be a socket); and out_fd must refer to a socket. Applications may wish to fall back to read(2)/write(2) in the case where sendfile() fails with EINVAL or ENOSYS. RETURN VALUE If the transfer was successful, the number of bytes written to out_fd is returned. On error, -1 is returned, and errno is set appropriately. ERRORS EAGAIN Non-blocking I/O has been selected using O_NONBLOCK and the write would block. EBADF The input file was not opened for reading or the output file was not opened for writing. EFAULT Bad address. EINVAL Descriptor is not valid or locked, or an mmap(2)-like operation is not available for in_fd. EIO Unspecified error while reading from in_fd. ENOMEM Insufficient memory to read from in_fd. VERSIONS sendfile() is a new feature in Linux 2.2. The include file is present since glibc 2.1. CONFORMING TO Not specified in POSIX.1-2001, or other standards. Other Unix systems implement sendfile() with different semantics and prototypes. It should not be used in portable programs. NOTES If you plan to use sendfile() for sending files to a TCP socket, but need to send some header data in front of the file contents, you will find it useful to employ the TCP_CORK option, described in tcp(7), to minimize the number of packets and to tune performance. In Linux 2.4 and earlier, out_fd could refer to a regular file, and sendfile() changed the current offset of that file. SEE ALSO mmap(2), open(2), socket(2), splice(2) COLOPHON This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. Linux 2004-12-17 SENDFILE(2)

リナックスコマンド