1 .\" This man page is Copyright (C) 1998 Pawel Krawczyk.
3 .\" %%%LICENSE_START(VERBATIM_ONE_PARA)
4 .\" Permission is granted to distribute possibly modified copies
5 .\" of this page provided the header is included verbatim,
6 .\" and in case of nontrivial modification author and date
7 .\" of the modification is added to the header.
10 .\" $Id: sendfile.2,v 1.5 1999/05/18 11:54:11 freitag Exp $
11 .\" 2000-11-19 bert hubert <ahu@ds9a.nl>: in_fd cannot be socket
14 .\" updated description of in_fd and out_fd for 2.6
15 .\" Various wording and formatting changes
17 .\" 2005-03-31 Martin Pool <mbp@sourcefrog.net> mmap() improvements
19 .\"*******************************************************************
21 .\" This file was generated with po4a. Translate the source file.
23 .\"*******************************************************************
25 .\" Japanese Version Copyright (c) 1999 HANATAKA Shinya
26 .\" all rights reserved.
27 .\" Translated 1999-06-26, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
28 .\" Updated 2001-02-16, Kentaro Shirakata <argrath@ub32.org>
29 .\" Updated 2003-09-08, Kentaro Shirakata <argrath@ub32.org>
30 .\" Updated 2005-03-14, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
31 .\" Updated 2005-04-17, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
32 .\" Updated 2010-04-18, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.24
33 .\" Updated 2012-04-30, Akihiro MOTOKI <amotoki@gmail.com>
35 .TH SENDFILE 2 2011\-09\-14 Linux "Linux Programmer's Manual"
37 sendfile \- ファイルディスクリプター間でデータを転送する
39 \fB#include <sys/sendfile.h>\fP
41 .\" The below is too ugly. Comments about glibc versions belong
42 .\" in the notes, not in the header.
44 .\" .B #include <features.h>
46 .\" .B #if (__GLIBC__==2 && __GLIBC_MINOR__>=1) || __GLIBC__>2
48 .\" .B #include <sys/sendfile.h>
52 .\" .B #include <sys/types.h>
54 .\" .B /* No system prototype before glibc 2.1. */
56 .\" .BI "ssize_t sendfile(int" " out_fd" ", int" " in_fd" ", off_t *" \
57 .\" offset ", size_t" " count" )
61 \fBssize_t sendfile(int\fP\fI out_fd\fP\fB, int\fP\fI in_fd\fP\fB, off_t *\fP\fIoffset\fP\fB,
62 size_t\fP\fI count\fP\fB);\fP
64 \fBsendfile\fP() は、あるファイルディスクリプターから別の ファイルディスクリプターへのデータのコピーを行う。
65 このコピーはカーネル内で行われるので、 \fBsendfile\fP() は、 \fBread\fP(2) と \fBwrite\fP(2)
66 を組み合わせるよりも効率がよい。 \fBread\fP(2) や \fBwrite\fP(2) ではユーザー空間との間でデータの転送が必要となるからである。
68 \fIin_fd\fP は読み込みのためにオープンされたファイルディスクリプター、 \fIout_fd\fP
69 は書き込みのためにオープンされたディスクリプターでなければならない。
71 \fIoffset\fP が NULL でない場合、 \fIoffset\fP は \fBsendfile\fP() が \fIin_fd\fP
72 のどこからデータを読み始めるかを示すファイルオフセットを保持する変数への ポインターである。 \fBsendfile\fP()
73 は復帰する時、この変数に最後に読み込んだバイトの 次のバイトのオフセットを書き込む。 \fIoffset\fP が NULL でない場合、
74 \fBsendfile\fP() は \fIin_fd\fP のファイルオフセットの現在値を変更しない。 NULL の場合は、ファイルオフセットの現在値を
75 \fIin_fd\fP から読み込んだバイト数を反映した位置に調整する。
77 \fIoffset\fP が NULL の場合、データは \fIin_fd\fP の現在のファイルオフセットから読み出され、
78 ファイルオフセットはこの呼び出しで更新される。
80 \fIcount\fP は、ファイルディスクリプター間でコピーするバイト数である。
82 \fIin_fd\fP 引き数は \fBmmap\fP(2) 風の操作ができるファイルを指していなければならな
85 2.6.33 より前の Linux カーネルでは \fIout_fd\fP はソケットを参照していなければな
86 らない。Linux 2.6.33 以降では、任意のファイルを参照することができる。
87 通常のファイルの場合には \fBsendfile\fP() はファイルオフセットを適切に変更する。
89 転送に成功した場合、 \fIout_fd\fP に書き込まれたバイト数を返す。エラーの場合、\-1 を返し、 \fIerrno\fP に適切な値を設定する。
93 \fBO_NONBLOCK\fP を用いて非ブロック I/O が選択されたが、書き込みがブロックされた。
96 入力ファイルが読み込みのためにオープンされていないか、 出力ファイルが書き込みのためにオープンされていない。
102 ディスクリプターが有効でないか、ロックされている。もしくは \fBmmap\fP(2) 風の操作が \fIin_fd\fP では利用できない。
105 \fIin_fd\fP から読み込んでいるうちに予期しないエラーが起こった。
108 \fIin_fd\fP から読み込むための十分なメモリーがない。
110 \fBsendfile\fP は Linux 2.2 の新しい機能である。 インクルードファイル \fI<sys/sendfile.h>\fP は
113 POSIX.1\-2001 や他の標準では規定されていない。
115 他の UNIX システムでは、異なった方式やプロトタイプで \fBsendfile\fP()
116 を実装している。移植性を考慮したプログラムでは使用すべきではない。
118 \fBsendfile\fP() を使って TCP ソケットにファイルを送ろうとしていて、 ファイルの内容の前にヘッダーデータを付け加える必要がある場合は、
119 パケット数を最小にして性能を上げるために \fBtcp\fP(7) に記述されている \fBTCP_CORK\fP オプションを使うといいだろう。
121 Linux 2.4 とそれ以前のバージョンでも、 \fIout_fd\fP は通常のファイルを参照でき、
122 \fBsendfile\fP() はそのファイルのオフセットの現在値を変更していた。
124 元々の Linux \fBsendfile\fP() システムコールは大きなファイルオフセットを
125 扱えるように設計されていなかった。その結果、Linux 2.4 で、
126 ビット幅の大きな \fIoffset\fP 引き数を持った \fBsendfile64\fP() が追加された。
127 glibc の \fBsendfile\fP() のラッパー関数はカーネルによるこの違いを吸収している。
129 \fBsendfile\fP() が \fBEINVAL\fP や \fBENOSYS\fP で失敗するような場合は、 アプリケーションは
130 \fBread\fP(2)/\fBwrite\fP(2) に戻すことを考えてもよいかもしれない。
132 Linux 固有の \fBsplice\fP(2) システムコールは、任意のファイル間 (例えば、
133 ソケット同士) でのデータ転送をサポートしている。
135 \fBmmap\fP(2), \fBopen\fP(2), \fBsocket\fP(2), \fBsplice\fP(2)
138 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.78 の一部
139 である。プロジェクトの説明とバグ報告に関する情報は
140 http://www.kernel.org/doc/man\-pages/ に書かれている。