lib/libcr/sys/recv.2

   1 .\" Copyright (c) 1983, 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\"     @(#)recv.2      8.3 (Berkeley) 2/21/94
  33 .\" $FreeBSD: src/lib/libc/sys/recv.2,v 1.8.2.8 2001/12/14 18:34:01 ru Exp $
  34 .\"
  35 .Dd February 21, 1994
  36 .Dt RECV 2
  37 .Os
  38 .Sh NAME
  39 .Nm recv ,
  40 .Nm recvfrom ,
  41 .Nm recvmsg
  42 .Nd receive a message from a socket
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In sys/socket.h
  48 .Ft ssize_t
  49 .Fn recv "int s" "void *buf" "size_t len" "int flags"
  50 .Ft ssize_t
  51 .Fn recvfrom "int s" "void *buf" "size_t len" "int flags" "struct sockaddr *from" "socklen_t *fromlen"
  52 .Ft ssize_t
  53 .Fn recvmsg "int s" "struct msghdr *msg" "int flags"
  54 .Sh DESCRIPTION
  55 .Fn Recvfrom
  56 and
  57 .Fn recvmsg
  58 are used to receive messages from a socket,
  59 and may be used to receive data on a socket whether or not
  60 it is connection-oriented.
  61 .Pp
  62 If
  63 .Fa from
  64 is non-nil, and the socket is not connection-oriented,
  65 the source address of the message is filled in.
  66 .Fa Fromlen
  67 is a value-result parameter, initialized to the size of
  68 the buffer associated with
  69 .Fa from ,
  70 and modified on return to indicate the actual size of the
  71 address stored there.
  72 .Pp
  73 The
  74 .Fn recv
  75 call is normally used only on a
  76 .Em connected
  77 socket (see
  78 .Xr connect 2 )
  79 and is identical to
  80 .Fn recvfrom
  81 with a nil
  82 .Fa from
  83 parameter.
  84 As it is redundant, it may not be supported in future releases.
  85 .Pp
  86 All three routines return the length of the message on successful
  87 completion.
  88 If a message is too long to fit in the supplied buffer,
  89 excess bytes may be discarded depending on the type of socket
  90 the message is received from (see
  91 .Xr socket 2 ) .
  92 .Pp
  93 If no messages are available at the socket, the
  94 receive call waits for a message to arrive, unless
  95 the socket is nonblocking (see
  96 .Xr fcntl 2 )
  97 in which case the value
  98 -1 is returned and the external variable
  99 .Va errno
 100 set to
 101 .Er EAGAIN .
 102 The receive calls normally return any data available,
 103 up to the requested amount,
 104 rather than waiting for receipt of the full amount requested;
 105 this behavior is affected by the socket-level options
 106 .Dv SO_RCVLOWAT
 107 and
 108 .Dv SO_RCVTIMEO
 109 described in
 110 .Xr getsockopt 2 .
 111 .Pp
 112 The
 113 .Xr select 2
 114 call may be used to determine when more data arrive.
 115 .Pp
 116 The
 117 .Fa flags
 118 argument to a recv call is formed by
 119 .Em or Ap ing
 120 one or more of the values:
 121 .Bl -column MSG_WAITALL -offset indent
 122 .It Dv MSG_OOB Ta process out-of-band data
 123 .It Dv MSG_PEEK Ta peek at incoming message
 124 .It Dv MSG_WAITALL Ta wait for full request or error
 125 .El
 126 .Pp
 127 The
 128 .Dv MSG_OOB
 129 flag requests receipt of out-of-band data
 130 that would not be received in the normal data stream.
 131 Some protocols place expedited data at the head of the normal
 132 data queue, and thus this flag cannot be used with such protocols.
 133 The MSG_PEEK flag causes the receive operation to return data
 134 from the beginning of the receive queue without removing that
 135 data from the queue.
 136 Thus, a subsequent receive call will return the same data.
 137 The MSG_WAITALL flag requests that the operation block until
 138 the full request is satisfied.
 139 However, the call may still return less data than requested
 140 if a signal is caught, an error or disconnect occurs,
 141 or the next data to be received is of a different type than that returned.
 142 .Pp
 143 The
 144 .Fn recvmsg
 145 call uses a
 146 .Fa msghdr
 147 structure to minimize the number of directly supplied parameters.
 148 This structure has the following form, as defined in
 149 .Ao Pa sys/socket.h Ac :
 150 .Pp
 151 .Bd -literal
 152 struct msghdr {
 153         caddr_t msg_name;       /* optional address */
 154         u_int   msg_namelen;    /* size of address */
 155         struct  iovec *msg_iov; /* scatter/gather array */
 156         u_int   msg_iovlen;     /* # elements in msg_iov */
 157         caddr_t msg_control;    /* ancillary data, see below */
 158         u_int   msg_controllen; /* ancillary data buffer len */
 159         int     msg_flags;      /* flags on received message */
 160 };
 161 .Ed
 162 .Pp
 163 Here
 164 .Fa msg_name
 165 and
 166 .Fa msg_namelen
 167 specify the destination address if the socket is unconnected;
 168 .Fa msg_name
 169 may be given as a null pointer if no names are desired or required.
 170 .Fa Msg_iov
 171 and
 172 .Fa msg_iovlen
 173 describe scatter gather locations, as discussed in
 174 .Xr read 2 .
 175 .Fa Msg_control ,
 176 which has length
 177 .Fa msg_controllen ,
 178 points to a buffer for other protocol control related messages
 179 or other miscellaneous ancillary data.
 180 The messages are of the form:
 181 .Bd -literal
 182 struct cmsghdr {
 183         u_int   cmsg_len;       /* data byte count, including hdr */
 184         int     cmsg_level;     /* originating protocol */
 185         int     cmsg_type;      /* protocol-specific type */
 186 /* followed by
 187         u_char  cmsg_data[]; */
 188 };
 189 .Pp
 190 .Ed
 191 As an example, one could use this to learn of changes in the data-stream
 192 in XNS/SPP, or in ISO, to obtain user-connection-request data by requesting
 193 a recvmsg with no data buffer provided immediately after an
 194 .Fn accept
 195 call.
 196 .Pp
 197 Open file descriptors are now passed as ancillary data for
 198 .Dv AF_UNIX
 199 domain sockets, with
 200 .Fa cmsg_level
 201 set to
 202 .Dv SOL_SOCKET
 203 and
 204 .Fa cmsg_type
 205 set to
 206 .Dv SCM_RIGHTS .
 207 .Pp
 208 Process credentials can also be passed as ancillary data for
 209 .Dv AF_UNIX
 210 domain sockets using a
 211 .Fa cmsg_type
 212 of
 213 .Dv SCM_CREDS .
 214 In this case,
 215 .Fa cmsg_data
 216 should be a structure of type
 217 .Fa cmsgcred ,
 218 which is defined in
 219 .Ao Pa sys/socket.h Ac
 220 as follows:
 221 .Pp
 222 .Bd -literal
 223 struct cmsgcred {
 224         pid_t   cmcred_pid;             /* PID of sending process */
 225         uid_t   cmcred_uid;             /* real UID of sending process */
 226         uid_t   cmcred_euid;            /* effective UID of sending process */
 227         gid_t   cmcred_gid;             /* real GID of sending process */
 228         short   cmcred_ngroups;         /* number or groups */
 229         gid_t   cmcred_groups[CMGROUP_MAX];     /* groups */
 230 };
 231 .Ed
 232 .Pp
 233 The kernel will fill in the credential information of the sending process
 234 and deliver it to the receiver.
 235 .Pp
 236 The
 237 .Fa msg_flags
 238 field is set on return according to the message received.
 239 .Dv MSG_EOR
 240 indicates end-of-record;
 241 the data returned completed a record (generally used with sockets of type
 242 .Dv SOCK_SEQPACKET ) .
 243 .Dv MSG_TRUNC
 244 indicates that
 245 the trailing portion of a datagram was discarded because the datagram
 246 was larger than the buffer supplied.
 247 .Dv MSG_CTRUNC
 248 indicates that some
 249 control data were discarded due to lack of space in the buffer
 250 for ancillary data.
 251 .Dv MSG_OOB
 252 is returned to indicate that expedited or out-of-band data were received.
 253 .Sh RETURN VALUES
 254 These calls return the number of bytes received, or -1
 255 if an error occurred.
 256 .Sh ERRORS
 257 The calls fail if:
 258 .Bl -tag -width Er
 259 .It Bq Er EBADF
 260 The argument
 261 .Fa s
 262 is an invalid descriptor.
 263 .It Bq Er ENOTCONN
 264 The socket is associated with a connection-oriented protocol
 265 and has not been connected (see
 266 .Xr connect 2
 267 and
 268 .Xr accept 2 ) .
 269 .It Bq Er ENOTSOCK
 270 The argument
 271 .Fa s
 272 does not refer to a socket.
 273 .It Bq Er EAGAIN
 274 The socket is marked non-blocking, and the receive operation
 275 would block, or
 276 a receive timeout had been set,
 277 and the timeout expired before data were received.
 278 .It Bq Er EINTR
 279 The receive was interrupted by delivery of a signal before
 280 any data were available.
 281 .It Bq Er EFAULT
 282 The receive buffer pointer(s) point outside the process's
 283 address space.
 284 .El
 285 .Sh SEE ALSO
 286 .Xr fcntl 2 ,
 287 .Xr getsockopt 2 ,
 288 .Xr read 2 ,
 289 .Xr select 2 ,
 290 .Xr socket 2
 291 .Sh HISTORY
 292 The
 293 .Fn recv
 294 function call appeared in
 295 .Bx 4.2 .