draft/man2/sendfile.2

   1 .\" This man page is Copyright (C) 1998 Pawel Krawczyk.
   2 .\"
   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.
   8 .\" %%%LICENSE_END
   9 .\"
  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
  12 .\"
  13 .\" 2004-12-17, mtk
  14 .\"     updated description of in_fd and out_fd for 2.6
  15 .\"     Various wording and formatting changes
  16 .\"
  17 .\" 2005-03-31 Martin Pool <mbp@sourcefrog.net> mmap() improvements
  18 .\"
  19 .\"*******************************************************************
  20 .\"
  21 .\" This file was generated with po4a. Translate the source file.
  22 .\"
  23 .\"*******************************************************************
  24 .TH SENDFILE 2 2011\-09\-14 Linux "Linux Programmer's Manual"
  25 .SH 名前
  26 sendfile \- ファイル・ディスクリプタ間でデータを転送する
  27 .SH 書式
  28 \fB#include <sys/sendfile.h>\fP
  29 .sp
  30 .\" The below is too ugly. Comments about glibc versions belong
  31 .\" in the notes, not in the header.
  32 .\"
  33 .\" .B #include <features.h>
  34 .\" .br
  35 .\" .B #if (__GLIBC__==2 && __GLIBC_MINOR__>=1) || __GLIBC__>2
  36 .\" .br
  37 .\" .B #include <sys/sendfile.h>
  38 .\" .br
  39 .\" #else
  40 .\" .br
  41 .\" .B #include <sys/types.h>
  42 .\" .br
  43 .\" .B /* No system prototype before glibc 2.1. */
  44 .\" .br
  45 .\" .BI "ssize_t sendfile(int" " out_fd" ", int" " in_fd" ", off_t *" \
  46 .\"                       offset ", size_t" " count" )
  47 .\" .br
  48 .\" .B #endif
  49 .\"
  50 \fBssize_t sendfile(int\fP\fI out_fd\fP\fB, int\fP\fI in_fd\fP\fB, off_t *\fP\fIoffset\fP\fB,
  51 size_t\fP\fI count\fP\fB);\fP
  52 .SH 説明
  53 \fBsendfile\fP()  は、あるファイル・ディスクリプタから別の ファイル・ディスクリプタへのデータのコピーを行う。
  54 このコピーはカーネル内で行われるので、 \fBsendfile\fP()  は、 \fBread\fP(2)  と \fBwrite\fP(2)
  55 を組み合わせるよりも効率がよい。 \fBread\fP(2)  や \fBwrite\fP(2)  ではユーザ空間との間でデータの転送が必要となるからである。
  56
  57 \fIin_fd\fP は読み込みのためにオープンされたファイル・ディスクリプタ、 \fIout_fd\fP
  58 は書き込みのためにオープンされたディスクリプタでなければならない。
  59
  60 \fIoffset\fP が NULL でない場合、 \fIoffset\fP は \fBsendfile\fP()  が \fIin_fd\fP
  61 のどこからデータを読み始めるかを示すファイル・オフセットを保持する変数への ポインタである。 \fBsendfile\fP()
  62 は復帰する時、この変数に最後に読み込んだバイトの 次のバイトのオフセットを書き込む。 \fIoffset\fP が NULL でない場合、
  63 \fBsendfile\fP()  は \fIin_fd\fP のファイル・オフセットの現在値を変更しない。 NULL の場合は、ファイル・オフセットの現在値を
  64 \fIin_fd\fP から読み込んだバイト数を反映した位置に調整する。
  65
  66 \fIoffset\fP が NULL の場合、データは \fIin_fd\fP の現在のファイル・オフセットから読み出され、
  67 ファイル・オフセットはこの呼び出しで更新される。
  68
  69 \fIcount\fP は、ファイル・ディスクリプタ間でコピーするバイト数である。
  70
  71 \fIin_fd\fP 引き数は \fBmmap\fP(2) 風の操作ができるファイルを指していなければならな
  72 い (ソケットを指定することはできない)。
  73
  74 2.6.33 より前の Linux カーネルでは \fIout_fd\fP はソケットを参照していなければな
  75 らない。Linux 2.6.33 以降では、任意のファイルを参照することができる。
  76 通常のファイルの場合には \fBsendfile\fP() はファイルオフセットを適切に変更する。
  77 .SH 返り値
  78 転送に成功した場合、 \fIout_fd\fP に書き込まれたバイト数を返す。エラーの場合、\-1 を返し、 \fIerrno\fP に適切な値を設定する。
  79 .SH エラー
  80 .TP
  81 \fBEAGAIN\fP
  82 \fBO_NONBLOCK\fP を用いて非ブロック I/O が選択されたが、書き込みがブロックされた。
  83 .TP
  84 \fBEBADF\fP
  85 入力ファイルが読み込みのためにオープンされていないか、 出力ファイルが書き込みのためにオープンされていない。
  86 .TP
  87 \fBEFAULT\fP
  88 アドレスがおかしい。
  89 .TP
  90 \fBEINVAL\fP
  91 ディスクリプタが有効でないか、ロックされている。もしくは \fBmmap\fP(2)  風の操作が \fIin_fd\fP では利用できない。
  92 .TP
  93 \fBEIO\fP
  94 \fIin_fd\fP から読み込んでいるうちに予期しないエラーが起こった。
  95 .TP
  96 \fBENOMEM\fP
  97 \fIin_fd\fP から読み込むための十分なメモリがない。
  98 .SH バージョン
  99 \fBsendfile\fP は Linux 2.2 の新しい機能である。 インクルードファイル \fI<sys/sendfile.h>\fP は
 100 glibc 2.1 から存在している。
 101 .SH 準拠
 102 POSIX.1\-2001 や他の標準では規定されていない。
 103
 104 他の UNIX システムでは、異なった方式やプロトタイプで \fBsendfile\fP()
 105 を実装している。移植性を考慮したプログラムでは使用すべきではない。
 106 .SH 注意
 107 \fBsendfile\fP()  を使って TCP ソケットにファイルを送ろうとしていて、 ファイルの内容の前にヘッダ・データを付け加える必要がある場合は、
 108 パケット数を最小にして性能を上げるために \fBtcp\fP(7)  に記述されている \fBTCP_CORK\fP オプションを使うといいだろう。
 109
 110 Linux 2.4 とそれ以前のバージョンでも、 \fIout_fd\fP は通常のファイルを参照でき、
 111 \fBsendfile\fP() はそのファイルのオフセットの現在値を変更していた。
 112
 113 元々の Linux \fBsendfile\fP() システムコールは大きなファイルオフセットを
 114 扱えるように設計されていなかった。その結果、Linux 2.4 で、
 115 ビット幅の大きな \fIoffset\fP 引き数を持った \fBsendfile64\fP() が追加された。
 116 glibc の \fBsendfile\fP() のラッパー関数はカーネルによるこの違いを吸収している。
 117
 118 \fBsendfile\fP()  が \fBEINVAL\fP や \fBENOSYS\fP で失敗するような場合は、 アプリケーションは
 119 \fBread\fP(2)/\fBwrite\fP(2)  に戻すことを考えてもよいかもしれない。
 120
 121 Linux 固有の \fBsplice\fP(2) システムコールは、任意のファイル間 (例えば、
 122 ソケット同士) でのデータ転送をサポートしている。
 123 .SH 関連項目
 124 \fBmmap\fP(2), \fBopen\fP(2), \fBsocket\fP(2), \fBsplice\fP(2)
 125
 126 .SH この文書について
 127 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 128 である。プロジェクトの説明とバグ報告に関する情報は
 129 http://www.kernel.org/doc/man\-pages/ に書かれている。