original/man2/recv.2

   1 .\" Copyright (c) 1983, 1990, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     $Id: recv.2,v 1.3 1999/05/13 11:33:38 freitag Exp $
  33 .\"
  34 .\" Modified Sat Jul 24 00:22:20 1993 by Rik Faith <faith@cs.unc.edu>
  35 .\" Modified Tue Oct 22 17:45:19 1996 by Eric S. Raymond <esr@thyrsus.com>
  36 .\" Modified 1998,1999 by Andi Kleen
  37 .\" 2001-06-19 corrected SO_EE_OFFENDER, bug report by James Hawtin
  38 .\"
  39 .TH RECV 2 2011-09-16 "Linux" "Linux Programmer's Manual"
  40 .SH NAME
  41 recv, recvfrom, recvmsg \- receive a message from a socket
  42 .SH SYNOPSIS
  43 .\" .B #include <sys/uio.h>
  44 .\" .br
  45 .nf
  46 .B #include <sys/types.h>
  47 .br
  48 .B #include <sys/socket.h>
  49 .sp
  50 .BI "ssize_t recv(int " sockfd ", void *" buf ", size_t " len ", int " flags );
  51 .sp
  52 .BI "ssize_t recvfrom(int " sockfd ", void *" buf ", size_t " len ", int " flags ,
  53 .BI "                 struct sockaddr *" src_addr ", socklen_t *" addrlen );
  54 .sp
  55 .BI "ssize_t recvmsg(int " sockfd ", struct msghdr *" msg ", int " flags );
  56 .fi
  57 .SH DESCRIPTION
  58 The
  59 .BR recvfrom ()
  60 and
  61 .BR recvmsg ()
  62 calls are used to receive messages from a socket, and may be used
  63 to receive data on a socket whether or not it is connection-oriented.
  64 .PP
  65 If
  66 .I src_addr
  67 is not NULL, and the underlying protocol provides the source address,
  68 this source address is filled in.
  69 When
  70 .I src_addr
  71 is NULL, nothing is filled in; in this case,
  72 .I addrlen
  73 is not used, and should also be NULL.
  74 .\" (Note: for datagram sockets in both the UNIX and Internet domains,
  75 .\" .I src_addr
  76 .\" is filled in.
  77 .\" .I src_addr
  78 .\" is also filled in for stream sockets in the UNIX domain, but is not
  79 .\" filled in for stream sockets in the Internet domain.)
  80 .\" [The above notes on AF_UNIX and AF_INET sockets apply as at
  81 .\" Kernel 2.4.18. (MTK, 22 Jul 02)]
  82 The argument
  83 .I addrlen
  84 is a value-result argument,
  85 which the caller should initialize before the call to
  86 the size of the buffer associated with
  87 .IR src_addr ,
  88 and modified on return to indicate the actual size of the source address.
  89 The returned address is truncated if the buffer provided is too small;
  90 in this case,
  91 .I addrlen
  92 will return a value greater than was supplied to the call.
  93 .PP
  94 The
  95 .BR recv ()
  96 call is normally used only on a
  97 .I connected
  98 socket (see
  99 .BR connect (2))
 100 and is identical to
 101 .BR recvfrom ()
 102 with a NULL
 103 .I src_addr
 104 argument.
 105 .PP
 106 All three routines return the length of the message on successful
 107 completion.
 108 If a message is too long to fit in the supplied buffer, excess
 109 bytes may be discarded depending on the type of socket the message is
 110 received from.
 111 .PP
 112 If no messages are available at the socket, the receive calls wait for a
 113 message to arrive, unless the socket is nonblocking (see
 114 .BR fcntl (2)),
 115 in which case the value \-1 is returned and the external variable
 116 .I errno
 117 is set to
 118 .BR EAGAIN " or " EWOULDBLOCK .
 119 The receive calls normally return any data available, up to the requested
 120 amount, rather than waiting for receipt of the full amount requested.
 121 .PP
 122 The
 123 .BR select (2)
 124 or
 125 .BR poll (2)
 126 call may be used to determine when more data arrives.
 127 .PP
 128 The
 129 .I flags
 130 argument to a
 131 .BR recv ()
 132 call is formed by
 133 .IR OR 'ing
 134 one or more of the following values:
 135 .TP
 136 .BR MSG_CMSG_CLOEXEC " (" recvmsg "() only; since Linux 2.6.23)"
 137 Set the close-on-exec flag for the file descriptor received
 138 via a UNIX domain file descriptor using the
 139 .B SCM_RIGHTS
 140 operation (described in
 141 .BR unix (7)).
 142 This flag is useful for the same reasons as the
 143 .B O_CLOEXEC
 144 flag of
 145 .BR open (2).
 146 .TP
 147 .BR MSG_DONTWAIT " (since Linux 2.2)"
 148 Enables nonblocking operation; if the operation would block,
 149 the call fails with the error
 150 .BR EAGAIN " or " EWOULDBLOCK
 151 (this can also be enabled using the
 152 .B O_NONBLOCK
 153 flag with the
 154 .B F_SETFL
 155 .BR fcntl (2)).
 156 .TP
 157 .BR MSG_ERRQUEUE " (since Linux 2.2)"
 158 This flag
 159 specifies that queued errors should be received from the socket error queue.
 160 The error is passed in
 161 an ancillary message with a type dependent on the protocol (for IPv4
 162 .BR IP_RECVERR ).
 163 The user should supply a buffer of sufficient size.
 164 See
 165 .BR cmsg (3)
 166 and
 167 .BR ip (7)
 168 for more information.
 169 The payload of the original packet that caused the error
 170 is passed as normal data via
 171 .IR msg_iovec .
 172 The original destination address of the datagram that caused the error
 173 is supplied via
 174 .IR msg_name .
 175 .IP
 176 For local errors, no address is passed (this can be checked with the
 177 .I cmsg_len
 178 member of the
 179 .IR cmsghdr ).
 180 For error receives, the
 181 .B MSG_ERRQUEUE
 182 is set in the
 183 .IR msghdr .
 184 After an error has been passed, the pending socket error
 185 is regenerated based on the next queued error and will be passed
 186 on the next socket operation.
 187
 188 The error is supplied in a
 189 .I sock_extended_err
 190 structure:
 191 .in +4n
 192 .nf
 193
 194 #define SO_EE_ORIGIN_NONE    0
 195 #define SO_EE_ORIGIN_LOCAL   1
 196 #define SO_EE_ORIGIN_ICMP    2
 197 #define SO_EE_ORIGIN_ICMP6   3
 198
 199 struct sock_extended_err
 200 {
 201     uint32_t ee_errno;   /* error number */
 202     uint8_t  ee_origin;  /* where the error originated */
 203     uint8_t  ee_type;    /* type */
 204     uint8_t  ee_code;    /* code */
 205     uint8_t  ee_pad;     /* padding */
 206     uint32_t ee_info;    /* additional information */
 207     uint32_t ee_data;    /* other data */
 208     /* More data may follow */
 209 };
 210
 211 struct sockaddr *SO_EE_OFFENDER(struct sock_extended_err *);
 212 .fi
 213 .in
 214 .IP
 215 .I ee_errno
 216 contains the
 217 .I errno
 218 number of the queued error.
 219 .I ee_origin
 220 is the origin code of where the error originated.
 221 The other fields are protocol-specific.
 222 The macro
 223 .B SOCK_EE_OFFENDER
 224 returns a pointer to the address of the network object
 225 where the error originated from given a pointer to the ancillary message.
 226 If this address is not known, the
 227 .I sa_family
 228 member of the
 229 .I sockaddr
 230 contains
 231 .B AF_UNSPEC
 232 and the other fields of the
 233 .I sockaddr
 234 are undefined.
 235 The payload of the packet that caused the error is passed as normal data.
 236 .IP
 237 For local errors, no address is passed (this
 238 can be checked with the
 239 .I cmsg_len
 240 member of the
 241 .IR cmsghdr ).
 242 For error receives,
 243 the
 244 .B MSG_ERRQUEUE
 245 is set in the
 246 .IR msghdr .
 247 After an error has been passed, the pending socket error
 248 is regenerated based on the next queued error and will be passed
 249 on the next socket operation.
 250 .TP
 251 .B MSG_OOB
 252 This flag requests receipt of out-of-band data that would not be received
 253 in the normal data stream.
 254 Some protocols place expedited data
 255 at the head of the normal data queue, and thus this flag cannot
 256 be used with such protocols.
 257 .TP
 258 .B MSG_PEEK
 259 This flag causes the receive operation to
 260 return data from the beginning of the
 261 receive queue without removing that data from the queue.
 262 Thus, a
 263 subsequent receive call will return the same data.
 264 .TP
 265 .BR MSG_TRUNC " (since Linux 2.2)"
 266 For raw
 267 .RB ( AF_PACKET ),
 268 Internet datagram (since Linux 2.4.27/2.6.8),
 269 and netlink (since Linux 2.6.22) sockets:
 270 return the real length of the packet or datagram,
 271 even when it was longer than the passed buffer.
 272 Not implemented for UNIX domain
 273 .RB ( unix (7))
 274 sockets.
 275
 276 For use with Internet stream sockets, see
 277 .BR tcp (7).
 278 .TP
 279 .BR MSG_WAITALL " (since Linux 2.2)"
 280 This flag requests that the operation block until the full request is
 281 satisfied.
 282 However, the call may still return less data than requested if
 283 a signal is caught, an error or disconnect occurs, or the next data to be
 284 received is of a different type than that returned.
 285 .PP
 286 The
 287 .BR recvmsg ()
 288 call uses a
 289 .I msghdr
 290 structure to minimize the number of directly supplied arguments.
 291 This structure is defined as follows in
 292 .IR <sys/socket.h> :
 293 .in +4n
 294 .nf
 295
 296 struct iovec {                    /* Scatter/gather array items */
 297     void  *iov_base;              /* Starting address */
 298     size_t iov_len;               /* Number of bytes to transfer */
 299 };
 300
 301 struct msghdr {
 302     void         *msg_name;       /* optional address */
 303     socklen_t     msg_namelen;    /* size of address */
 304     struct iovec *msg_iov;        /* scatter/gather array */
 305     size_t        msg_iovlen;     /* # elements in msg_iov */
 306     void         *msg_control;    /* ancillary data, see below */
 307     size_t        msg_controllen; /* ancillary data buffer len */
 308     int           msg_flags;      /* flags on received message */
 309 };
 310 .fi
 311 .in
 312 .PP
 313 Here
 314 .I msg_name
 315 and
 316 .I msg_namelen
 317 specify the source address if the socket is unconnected;
 318 .I msg_name
 319 may be given as a null pointer if no names are desired or required.
 320 The fields
 321 .I msg_iov
 322 and
 323 .I msg_iovlen
 324 describe scatter-gather locations, as discussed in
 325 .BR readv (2).
 326 The field
 327 .IR msg_control ,
 328 which has length
 329 .IR msg_controllen ,
 330 points to a buffer for other protocol control-related messages or
 331 miscellaneous ancillary data.
 332 When
 333 .BR recvmsg ()
 334 is called,
 335 .I msg_controllen
 336 should contain the length of the available buffer in
 337 .IR msg_control ;
 338 upon return from a successful call it will contain the length
 339 of the control message sequence.
 340 .PP
 341 The messages are of the form:
 342 .in +4n
 343 .nf
 344
 345 struct cmsghdr {
 346     socklen_t     cmsg_len;     /* data byte count, including hdr */
 347     int           cmsg_level;   /* originating protocol */
 348     int           cmsg_type;    /* protocol-specific type */
 349 /* followed by
 350     unsigned char cmsg_data[]; */
 351 };
 352 .fi
 353 .in
 354 .PP
 355 Ancillary data should only be accessed by the macros defined in
 356 .BR cmsg (3).
 357 .PP
 358 As an example, Linux uses this ancillary data mechanism to pass extended
 359 errors, IP options, or file descriptors over UNIX domain sockets.
 360 .PP
 361 The
 362 .I msg_flags
 363 field in the
 364 .I msghdr
 365 is set on return of
 366 .BR recvmsg ().
 367 It can contain several flags:
 368 .TP
 369 .B MSG_EOR
 370 indicates end-of-record; the data returned completed a record (generally
 371 used with sockets of type
 372 .BR SOCK_SEQPACKET ).
 373 .TP
 374 .B MSG_TRUNC
 375 indicates that the trailing portion of a datagram was discarded because the
 376 datagram was larger than the buffer supplied.
 377 .TP
 378 .B MSG_CTRUNC
 379 indicates that some control data were discarded due to lack of space in the
 380 buffer for ancillary data.
 381 .TP
 382 .B MSG_OOB
 383 is returned to indicate that expedited or out-of-band data were received.
 384 .TP
 385 .B MSG_ERRQUEUE
 386 indicates that no data was received but an extended error from the socket
 387 error queue.
 388 .SH "RETURN VALUE"
 389 These calls return the number of bytes received, or \-1
 390 if an error occurred.
 391 The return value will be 0 when the
 392 peer has performed an orderly shutdown.
 393 .SH ERRORS
 394 These are some standard errors generated by the socket layer.
 395 Additional errors
 396 may be generated and returned from the underlying protocol modules;
 397 see their manual pages.
 398 .TP
 399 .BR EAGAIN " or " EWOULDBLOCK
 400 .\" Actually EAGAIN on Linux
 401 The socket is marked nonblocking and the receive operation
 402 would block, or a receive timeout had been set and the timeout expired
 403 before data was received.
 404 POSIX.1-2001 allows either error to be returned for this case,
 405 and does not require these constants to have the same value,
 406 so a portable application should check for both possibilities.
 407 .TP
 408 .B EBADF
 409 The argument
 410 .I sockfd
 411 is an invalid descriptor.
 412 .TP
 413 .B ECONNREFUSED
 414 A remote host refused to allow the network connection (typically
 415 because it is not running the requested service).
 416 .TP
 417 .B EFAULT
 418 The receive buffer pointer(s) point outside the process's
 419 address space.
 420 .TP
 421 .B EINTR
 422 The receive was interrupted by delivery of a signal before
 423 any data were available; see
 424 .BR signal (7).
 425 .TP
 426 .B EINVAL
 427 Invalid argument passed.
 428 .\" e.g., msg_namelen < 0 for recvmsg() or addrlen < 0 for recvfrom()
 429 .TP
 430 .B ENOMEM
 431 Could not allocate memory for
 432 .BR recvmsg ().
 433 .TP
 434 .B ENOTCONN
 435 The socket is associated with a connection-oriented protocol
 436 and has not been connected (see
 437 .BR connect (2)
 438 and
 439 .BR accept (2)).
 440 .TP
 441 .B ENOTSOCK
 442 The argument
 443 .I sockfd
 444 does not refer to a socket.
 445 .SH "CONFORMING TO"
 446 4.4BSD (these function calls first appeared in 4.2BSD),
 447 POSIX.1-2001.
 448 .LP
 449 POSIX.1-2001 only describes the
 450 .BR MSG_OOB ,
 451 .BR MSG_PEEK ,
 452 and
 453 .B MSG_WAITALL
 454 flags.
 455 .SH NOTES
 456 The prototypes given above follow glibc2.
 457 The Single UNIX Specification agrees, except that it has return values
 458 of type \fIssize_t\fP (while 4.x BSD and libc4 and libc5 all have \fIint\fP).
 459 The
 460 .I flags
 461 argument is \fIint\fP in 4.x BSD, but \fIunsigned int\fP in libc4 and libc5.
 462 The
 463 .I len
 464 argument is \fIint\fP in 4.x BSD, but \fIsize_t\fP in libc4 and libc5.
 465 The
 466 .I addrlen
 467 argument is \fIint\ *\fP in 4.x BSD, libc4 and libc5.
 468 The present  \fIsocklen_t\ *\fP was invented by POSIX.
 469 See also
 470 .BR accept (2).
 471
 472 According to POSIX.1-2001, the
 473 .I msg_controllen
 474 field of the
 475 .I msghdr
 476 structure should be typed as
 477 .IR socklen_t ,
 478 but glibc currently types it as
 479 .IR size_t .
 480 .\" glibc bug raised 12 Mar 2006
 481 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=2448
 482 .\" The problem is an underlying kernel issue: the size of the
 483 .\" __kernel_size_t type used to type this field varies
 484 .\" across architectures, but socklen_t is always 32 bits.
 485 .SH EXAMPLE
 486 An example of the use of
 487 .BR recvfrom ()
 488 is shown in
 489 .BR getaddrinfo (3).
 490 .SH "SEE ALSO"
 491 .BR fcntl (2),
 492 .BR getsockopt (2),
 493 .BR read (2),
 494 .BR select (2),
 495 .BR shutdown (2),
 496 .BR socket (2),
 497 .BR cmsg (3),
 498 .BR sockatmark (3),
 499 .BR socket (7)