draft/man2/recv.2

   1 .\" Copyright (c) 1983, 1990, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     $Id: recv.2,v 1.3 1999/05/13 11:33:38 freitag Exp $
  35 .\"
  36 .\" Modified Sat Jul 24 00:22:20 1993 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified Tue Oct 22 17:45:19 1996 by Eric S. Raymond <esr@thyrsus.com>
  38 .\" Modified 1998,1999 by Andi Kleen
  39 .\" 2001-06-19 corrected SO_EE_OFFENDER, bug report by James Hawtin
  40 .\"
  41 .\"*******************************************************************
  42 .\"
  43 .\" This file was generated with po4a. Translate the source file.
  44 .\"
  45 .\"*******************************************************************
  46 .\"
  47 .\" Japanese Version Copyright (c) 1996 Akira Yoshiyama
  48 .\"         all rights reserved.
  49 .\" Translated 1996-07-18, Akira Yoshiyama <yosshy@jedi.seg.kobe-u.ac.jp>
  50 .\" Modified 1997-12-14, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  51 .\" Modified 1999-08-14, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  52 .\" Updated & Modified 2000-10-12, HAYAKAWA Hitoshi <cz8cb01@linux.or.jp>
  53 .\"        and NAKANO Takeo <nakano@apm.seikei.ac.jp>
  54 .\" Updated & Modified 2001-02-09, NAKANO Takeo
  55 .\" Updated 2003-10-11, Kentaro Shirakata <argrath@ub32.org>
  56 .\" Updated 2005-03-14, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  57 .\" Updated 2006-04-15, Akihiro MOTOKI, Catch up to LDP v2.29
  58 .\" Updated 2007-10-12, Akihiro MOTOKI, LDP v2.66
  59 .\" Updated 2008-08-06, Akihiro MOTOKI, LDP v3.05
  60 .\" Updated 2009-04-13, Akihiro MOTOKI, LDP v3.20
  61 .\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
  62 .\" Updated 2013-07-22, Akihiro MOTOKI <amotoki@gmail.com>
  63 .\"
  64 .TH RECV 2 2013\-04\-19 Linux "Linux Programmer's Manual"
  65 .SH 名前
  66 recv, recvfrom, recvmsg \- ソケットからメッセージを受け取る
  67 .SH 書式
  68 .\" .B #include <sys/uio.h>
  69 .\" .br
  70 .nf
  71 \fB#include <sys/types.h>\fP
  72 .br
  73 \fB#include <sys/socket.h>\fP
  74 .sp
  75 \fBssize_t recv(int \fP\fIsockfd\fP\fB, void *\fP\fIbuf\fP\fB, size_t \fP\fIlen\fP\fB, int \fP\fIflags\fP\fB);\fP
  76 .sp
  77 \fBssize_t recvfrom(int \fP\fIsockfd\fP\fB, void *\fP\fIbuf\fP\fB, size_t \fP\fIlen\fP\fB, int \fP\fIflags\fP\fB,\fP
  78 \fB                 struct sockaddr *\fP\fIsrc_addr\fP\fB, socklen_t *\fP\fIaddrlen\fP\fB);\fP
  79 .sp
  80 \fBssize_t recvmsg(int \fP\fIsockfd\fP\fB, struct msghdr *\fP\fImsg\fP\fB, int \fP\fIflags\fP\fB);\fP
  81 .fi
  82 .SH 説明
  83 \fBrecvfrom\fP()  と \fBrecvmsg\fP()  コールは、ソケットからメッセージを受け取るのに使用する。
  84 またソケットのデータ受信にも使うことができ、 このときソケットは接続指向 (connection\-oriened) であってもなくてもよい。
  85 .PP
  86 .\" (Note: for datagram sockets in both the UNIX and Internet domains,
  87 .\" .I src_addr
  88 .\" is filled in.
  89 .\" .I src_addr
  90 .\" is also filled in for stream sockets in the UNIX domain, but is not
  91 .\" filled in for stream sockets in the Internet domain.)
  92 .\" [The above notes on AF_UNIX and AF_INET sockets apply as at
  93 .\" Kernel 2.4.18. (MTK, 22 Jul 02)]
  94 \fIsrc_addr\fP が NULL 以外で、下層のプロトコルから送信元アドレスが分かる場合、 \fIsrc_addr\fP
  95 にはこの送信元アドレスが入れられる。 \fIsrc_addr\fP が NULL の場合、 \fIsrc_addr\fP には何も入らない。この場合、
  96 \fIaddrlen\fP は使用されず、この引き数は NULL にしておくべきである。 引き数 \fIaddrlen\fP
  97 は入出力両用の引き数である。呼び出し時には、呼び出し元が \fIsrc_addr\fP に割り当てたバッファの大きさで初期化しておくべきである。
  98 返ってくる時には、送信元アドレスの実際の大きさに変更される。 渡されたバッファが小さ過ぎる場合には、返されるアドレスの末尾は
  99 切り詰められる。この場合には、 \fIaddrlen\fP では、呼び出し時に渡された値よりも大きな値が返される。
 100 .PP
 101 \fBrecv\fP()  コールは通常 \fI接続済みの (connected)\fP ソケット (\fBconnect\fP(2)  を参照) についてのみ使用され、
 102 \fIsrc_addr\fP 引き数に NULL を指定した \fBrecvfrom\fP()  と等価である。
 103 .PP
 104 これらの三つのルーチンはいずれも、成功した場合にはメッセージの長さを返す。 メッセージが長過ぎて指定されたバッファに入り切らなかった場合には、
 105 メッセージを受信したソケットの種類によっては余分のバイトが捨てられる かもしれない。
 106 .PP
 107 ソケットに受け取るメッセージが存在しなかった場合、 受信用のコールはメッセージが到着するまで待つ。 ただし、ソケットが非停止 (nonblocking)
 108 に設定されていた場合 (\fBfcntl\fP(2)  を参照) は \-1 を返し、外部変数 \fIerrno\fP に \fBEAGAIN\fP か
 109 \fBEWOULDBLOCK\fP を設定する。 これらの受信用のコールは、受信したデータのサイズが要求したサイズに
 110 達するまで待つのではなく、何らかのデータを受信すると復帰する (受信されるデータの最大サイズは要求したサイズである)。
 111 .PP
 112 \fBselect\fP(2)  や \fBpoll\fP(2)  コールを使って、次のデータがいつ届くかを判断できる。
 113 .PP
 114 \fBrecv\fP()  コールの \fIflags\fP 引き数には、以下の値を 1つ以上、ビット単位の論理和 を取ったものを指定する:
 115 .TP
 116 \fBMSG_CMSG_CLOEXEC\fP (\fBrecvmsg\fP() のみ; Linux 2.6.23)
 117 (\fBunix\fP(7)  で説明されている)  \fBSCM_RIGHTS\fP 操作を使って UNIX ドメインのファイルディスクリプタ経由で受信した
 118 ファイルディスクリプタについて close\-on\-exec フラグをセットする。 このフラグは、 \fBopen\fP(2)  の \fBO_CLOEXEC\fP
 119 フラグと同じ理由で有用である。
 120 .TP
 121 \fBMSG_DONTWAIT\fP (Linux 2.2 以降)
 122 非停止 (nonblocking) 操作を有効にする。 操作が停止するような場合にエラー \fBEAGAIN\fP か \fBEWOULDBLOCK\fP
 123 で呼び出しが失敗する (\fBfcntl\fP(2)  の \fBF_SETFL\fP で \fBO_NONBLOCK\fP
 124 フラグを指定することによっても有効にできる)。
 125 .TP
 126 \fBMSG_ERRQUEUE\fP (Linux 2.2 以降)
 127 このフラグを指定すると、 キューに入れられたエラーをソケットのエラーキューから取りだせるようになる。 このエラーは補助メッセージに組み込まれて渡され、
 128 この補助メッセージの種別はプロトコルに依存する (IPv4 の場合は \fBIP_RECVERR\fP)。
 129 ユーザは十分なサイズのバッファを用意しなければならない。 補助メッセージに関するより詳細な情報は \fBcmsg\fP(3)  および \fBip\fP(7)
 130 を参照のこと。 エラーの原因となったオリジナルパケットのペイロードは、 \fImsg_iovec\fP 経由で通常のデータとして渡される。
 131 エラーを起こしたデータグラムのオリジナルの宛先アドレスは、 \fImsg_name\fP 経由で参照できる。
 132 .IP
 133 ローカルなエラーの場合はアドレスは渡されない
 134 (これは \fIcmsghdr\fP の \fIcmsg_len\fP メンバーでチェックできる)。
 135 受信エラーの場合は \fBMSG_ERRQUIE\fP が \fImsghdr\fP にセットされる。
 136 エラーが渡された後には、キューに入っている次のエラーに基いて、
 137 処理待ちのソケット・エラーが再生成され、次のソケット操作の際に渡される。
 138
 139 このエラーは \fIsock_extended_err\fP 構造体で提供される:
 140 .in +4n
 141 .nf
 142
 143 #define SO_EE_ORIGIN_NONE    0
 144 #define SO_EE_ORIGIN_LOCAL   1
 145 #define SO_EE_ORIGIN_ICMP    2
 146 #define SO_EE_ORIGIN_ICMP6   3
 147
 148 struct sock_extended_err
 149 {
 150     uint32_t ee_errno;   /* error number */
 151     uint8_t  ee_origin;  /* where the error originated */
 152     uint8_t  ee_type;    /* type */
 153     uint8_t  ee_code;    /* code */
 154     uint8_t  ee_pad;     /* padding */
 155     uint32_t ee_info;    /* additional information */
 156     uint32_t ee_data;    /* other data */
 157     /* More data may follow */
 158 };
 159
 160 struct sockaddr *SO_EE_OFFENDER(struct sock_extended_err *);
 161 .fi
 162 .in
 163 .IP
 164 \fIee_errno\fP にはキューに入れられたエラーの \fIerrno\fP が入っている。 \fIee_origin\fP
 165 にはエラーが発生した場所のオリジン・コード (origin code) が入っている。 他のフィールドはプロトコル依存である。
 166 \fBSO_EE_OFFENDER\fP マクロは、この補助的なメッセージを引き数に取って、
 167 エラーの発生したネットワークオブジェクトのアドレスへのポインタを返す。 アドレスが不明の場合には、 \fIsockaddr\fP の \fIsa_family\fP
 168 メンバーが \fBAF_UNSPEC\fP になっている。 \fIsockaddr\fP の他のフィールドは不定である。
 169 エラーの発生したパケットのペイロードは通常のデータとして渡される。
 170 .IP
 171 ローカルなエラーの場合はアドレスは渡されない
 172 (これは \fIcmsghdr\fP の \fIcmsg_len\fP メンバーでチェックできる)。
 173 受信エラーの場合は \fBMSG_ERRQUIE\fP が \fImsghdr\fP にセットされる。
 174 エラーが渡された後には、キューに入っている次のエラーに基いて、
 175 処理待ちのソケット・エラーが再生成され、次のソケット操作の際に渡される。
 176 .TP
 177 \fBMSG_OOB\fP
 178 このフラグは、通常のデータ・ストリームでは受信できない 帯域外 (out\-of\-band) データの受信を要求する。 プロトコルによっては、
 179 通常のデータ・キューの先頭に速達データを置くものがあるが、 そのようなプロトコルではこのフラグは使用できない。
 180 .TP
 181 \fBMSG_PEEK\fP
 182 このフラグを指定すると、 受信キューの最初のデータを返すとき、キューからデータを削除しない。
 183 したがって、この後でもう一度受信コールを呼び出すと、同じデータが返ることになる。
 184 .TP
 185 \fBMSG_TRUNC\fP (Linux 2.2 以降)
 186 raw ソケット (\fBAF_PACKET\fP)、 Internet datagram ソケット (Linux 2.4.27/2.6.8 以降)、
 187 netlink (Linux 2.6.22 以降) ソケット、 UNIX datagram ソケット (Linux 3.4 以降)
 188 の場合、パケットやデータグラムの長さが渡したバッファよりも長かった場合にも、 パケットやデータグラムの実際の長さを返す。 UNIX ドメインソケット
 189 (\fBunix\fP(7))  ソケットについては実装されていない。
 190
 191 Internet ストリームソケットでの利用については \fBtcp\fP(7)  を参照。
 192 .TP
 193 \fBMSG_WAITALL\fP (Linux 2.2 以降)
 194 このフラグは、要求した量いっぱいのデータが到着するまで、 操作を停止 (block) するよう要求する。 但し、シグナルを受信したり、エラーや切断
 195 (disconnect) が発生したり、 次に受信されるデータが異なる型だったりした場合には、 要求した量よりデータが少なくても返ることがある。
 196 .PP
 197 \fBrecvmsg\fP()  コールは、直接渡す引き数の数を減らすために \fImsghdr\fP 構造体を使用する。この構造体は
 198 \fI<sys/socket.h>\fP で以下のように定義されている:
 199 .in +4n
 200 .nf
 201
 202 struct iovec {                    /* Scatter/gather array items */
 203     void  *iov_base;              /* Starting address */
 204     size_t iov_len;               /* Number of bytes to transfer */
 205 };
 206
 207 struct msghdr {
 208     void         *msg_name;       /* 追加のアドレス */
 209     socklen_t     msg_namelen;    /* アドレスのサイズ */
 210     struct iovec *msg_iov;        /* scatter/gather 配列 */
 211     size_t        msg_iovlen;     /* msg_iov の要素数 */
 212     void         *msg_control;    /* 補助データ (後述) */
 213     size_t        msg_controllen; /* 補助データバッファ長 */
 214     int           msg_flags;      /* 受信メッセージのフラグ */
 215 };
 216 .fi
 217 .in
 218 .PP
 219 \fImsg_name\fP と \fImsg_namelen\fP は、ソケットが接続されていない場合に送信元のアドレスを指定する。 名前が必要ない場合には
 220 \fImsg_name\fP に NULL ポインタを指定する。 \fImsg_iov\fP と \fImsg_iovlen\fP フィールドは \fBreadv\fP(2)
 221 に記述されているような分解/結合用のベクトル (scatter\-gather locations)  を指定する。 \fImsg_control\fP
 222 フィールドは \fImsg_controllen\fP の長さを持ち、他のプロトコル制御メッセージや 種々の補助データのためのバッファへのポインタである。
 223 \fBrecvmsg\fP()  を呼ぶ際には、 \fImsg_controllen\fP に \fImsg_control\fP
 224 のバッファの長さを入れておく必要がある。 コールが成功して返った場合、制御メッセージ列の長さが入っている。
 225 .PP
 226 メッセージの形式は以下の通り:
 227 .in +4n
 228 .nf
 229
 230 struct cmsghdr {
 231     socklen_t     cmsg_len;     /* data byte count, including hdr */
 232     int           cmsg_level;   /* originating protocol */
 233     int           cmsg_type;    /* protocol\-specific type */
 234 /* followed by
 235     unsigned char cmsg_data[]; */
 236 };
 237 .fi
 238 .in
 239 .PP
 240 補助データは、 \fBcmsg\fP(3)  に定義されたマクロ経由でのみアクセスすべきである。
 241 .PP
 242 例をあげると、 Linux はこの補助データのメカニズムを、 UNIX ドメインソケット上での拡張エラーや IP オプション、
 243 ファイル・ディスクリプタの受け渡しに利用している。
 244 .PP
 245 \fImsghdr\fP の \fImsg_flags\fP フィールドは \fBrecvmsg\fP()
 246 からのリターン時に設定される。ここにはいくつかのフラグが入る。
 247 .TP
 248 \fBMSG_EOR\fP
 249 これはレコードの終り (end\-of\-record) を示し、 返されたデータが完全なレコードであることを示す (一般的には
 250 \fBSOCK_SEQPACKET\fP 型のソケットで使用される)。
 251 .TP
 252 \fBMSG_TRUNC\fP
 253 データグラムが与えられたバッファより大きかったために、 データグラムのはみ出した部分が捨てられたことを示す。
 254 .TP
 255 \fBMSG_CTRUNC\fP
 256 補助データのためのバッファが不足したために、 制御データの一部が捨てられたことを示す。
 257 .TP
 258 \fBMSG_OOB\fP
 259 速達データや帯域外データを受信したことを示す。
 260 .TP
 261 \fBMSG_ERRQUEUE\fP
 262 データは受信しなかったが ソケットのエラー・キューから拡張エラーを受信したことを示す。
 263 .SH 返り値
 264 これらのコールは受信したバイト数を返す。 エラーの場合は \-1 を返し、 \fIerrno\fP にエラーを示す値を設定する。
 265 接続先が正しくシャットダウンを実行した場合は、返り値は 0 となる。
 266 .SH エラー
 267 これらはソケット層で発生する一般的なエラーである。 他のエラーが下層のプロトコル・モジュールで生成され、 返されるかもしれない。
 268 それらのマニュアルを参照すること。
 269 .TP
 270 \fBEAGAIN\fP または \fBEWOULDBLOCK\fP
 271 .\" Actually EAGAIN on Linux
 272 ソケットが非停止 (nonblocking) に設定されていて 受信操作が停止するような状況になったか、 受信に時間切れ (timeout)
 273 が設定されていて データを受信する前に時間切れになった。 POSIX.1\-2001 は、この場合にどちらのエラーを返すことも認めており、 これら 2
 274 つの定数が同じ値を持つことも求めていない。 したがって、移植性が必要なアプリケーションでは、両方の可能性を 確認すべきである。
 275 .TP
 276 \fBEBADF\fP
 277 引き数 \fIsockfd\fP が不正なディスクリプタである。
 278 .TP
 279 \fBECONNREFUSED\fP
 280 リモートのホストでネットワーク接続が拒否された (よくある理由としては、要求したサービスが起動されていないなどがある)。
 281 .TP
 282 \fBEFAULT\fP
 283 受信バッファへのポインタがプロセスのアドレス空間外を指している。
 284 .TP
 285 \fBEINTR\fP
 286 データを受信する前に、シグナルが配送されて割り込まれた。 \fBsignal\fP(7)  参照。
 287 .TP
 288 \fBEINVAL\fP
 289 .\" e.g., msg_namelen < 0 for recvmsg() or addrlen < 0 for recvfrom()
 290 不正な引き数が渡された。
 291 .TP
 292 \fBENOMEM\fP
 293 \fBrecvmsg\fP()  のためのメモリが確保できなかった。
 294 .TP
 295 \fBENOTCONN\fP
 296 ソケットに接続指向プロトコルが割り当てられており、 まだ接続されていない (\fBconnect\fP(2)  と \fBaccept\fP(2)
 297 を参照のこと)。
 298 .TP
 299 \fBENOTSOCK\fP
 300 引き数 \fIsockfd\fP がソケットを参照していない。
 301 .SH 準拠
 302 4.4BSD (これらの関数は 4.2BSD で現われた), POSIX.1\-2001。
 303 .LP
 304 POSIX.1\-2001 では、 \fBMSG_OOB\fP, \fBMSG_PEEK\fP, \fBMSG_WAITALL\fP フラグだけが記載されている。
 305 .SH 注意
 306 上記のプロトタイプは glibc2 にしたがっている。 Single UNIX Specification でも同様だが、 返り値の型が
 307 \fIssize_t\fP となっている (一方で 4.x BSD や libc4 や libc5 は全て \fIint\fP を使用している)。 \fIflags\fP
 308 引き数は 4.x BSD では \fIint\fP だが、libc4 と libc5 では \fIunsigned int\fP である。 \fIlen\fP 引き数は
 309 4.x BSD では \fIint\fP だが、 libc4 と libc5 では \fIsize_t\fP である。 \fIaddrlen\fP 引き数は 4.x
 310 BSD, libc4, libc5 では \fIint\ *\fP である。 現在の \fIsocklen_t\ *\fP は POSIX で発案された。
 311 \fBaccept\fP(2)  も参照すること。
 312
 313 .\" glibc bug raised 12 Mar 2006
 314 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=2448
 315 .\" The problem is an underlying kernel issue: the size of the
 316 .\" __kernel_size_t type used to type this field varies
 317 .\" across architectures, but socklen_t is always 32 bits.
 318 POSIX.1\-2001 では、構造体 \fImsghdr\fP のフィールド \fImsg_controllen\fP は \fIsocklen_t\fP
 319 型であるべきだとされているが、 現在の glibc では \fIsize_t\fP 型である。
 320
 321 \fBrecvmmsg\fP(2)  には、一度の呼び出しでの複数のデータグラムに使用できる Linux 固有の システムコールに関する情報が書かれている。
 322 .SH 例
 323 \fBrecvfrom\fP()  の利用例が \fBgetaddrinfo\fP(3)  に記載されている。
 324 .SH 関連項目
 325 \fBfcntl\fP(2), \fBgetsockopt\fP(2), \fBread\fP(2), \fBrecvmmsg\fP(2), \fBselect\fP(2),
 326 \fBshutdown\fP(2), \fBsocket\fP(2), \fBcmsg\fP(3), \fBsockatmark\fP(3), \fBsocket\fP(7)
 327 .SH この文書について
 328 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 329 である。プロジェクトの説明とバグ報告に関する情報は
 330 http://www.kernel.org/doc/man\-pages/ に書かれている。