recvmmsg (2)
Leading comments
Copyright (c) 1983, 1990, 1991, 1993
The Regents of the University of California. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and t...
NAME
recv recvfrom recvmsg recvmmsg - receive message(s) from a socketLIBRARY
Lb libcSYNOPSIS
In sys/types.h In sys/socket.h Ft ssize_t Fn recv int s void *buf size_t len int flags Ft ssize_t Fn recvfrom int s void *buf size_t len int flags struct sockaddr * restrict from socklen_t * restrict fromlen Ft ssize_t Fn recvmsg int s struct msghdr *msg int flags Ft ssize_t Fn recvmmsg int s struct mmsghdr * restrict msgvec size_t vlen int flags const struct timespec * restrict timeoutDESCRIPTION
The Fn recvfrom , Fn recvmsg , and Fn recvmmsg system calls are used to receive messages from a socket, and may be used to receive data on a socket whether or not it is connection-oriented.If Fa from is not a null pointer and the socket is not connection-oriented, the source address of the message is filled in. The Fa fromlen argument is a value-result argument, initialized to the size of the buffer associated with Fa from , and modified on return to indicate the actual size of the address stored there.
The Fn recv function is normally used only on a connected socket (see connect(2)) and is identical to Fn recvfrom with a null pointer passed as its Fa from argument.
The Fn recvmmsg function is used to receive multiple messages at a call. Their number is supplied by Fa vlen . The messages are placed in the buffers described by Fa msgvec vector, after reception. The size of each received message is placed in the Fa msg_len field of each element of the vector. If Fa timeout is NULL the call blocks until the data is available for each supplied message buffer. Otherwise it waits for data for the specified amount of time. If the timeout expired and there is no data received, a value 0 is returned. The ppoll(2) system call is used to implement the timeout mechanism, before first receive is performed.
The Fn recv , Fn recvfrom and Fn recvmsg return the length of the message on successful completion, whereas Fn recvmmsg returns the number of received messages. If a message is too long to fit in the supplied buffer, excess bytes may be discarded depending on the type of socket the message is received from (see socket(2)).
If no messages are available at the socket, the receive call waits for a message to arrive, unless the socket is non-blocking (see fcntl(2)) in which case the value -1 is returned and the global variable errno is set to Er EAGAIN . The receive calls except Fn recvmmsg normally return any data available, up to the requested amount, rather than waiting for receipt of the full amount requested; this behavior is affected by the socket-level options SO_RCVLOWAT and SO_RCVTIMEO described in getsockopt(2). The Fn recvmmsg function implements this behaviour for each message in the vector.
The select(2) system call may be used to determine when more data arrives.
The Fa flags argument to a Fn recv function is formed by or Ap ing one or more of the values:
- MSG_OOB Ta process out-of-band data
- MSG_PEEK Ta peek at incoming message
- MSG_WAITALL Ta wait for full request or error
- MSG_DONTWAIT Ta do not block
- MSG_CMSG_CLOEXEC Ta set received fds close-on-exec
- MSG_WAITFORONE Ta do not block after receiving the first message
- (only for Fn recvmmsg )
The MSG_OOB flag requests receipt of out-of-band data that would not be received in the normal data stream. Some protocols place expedited data at the head of the normal data queue, and thus this flag cannot be used with such protocols. The MSG_PEEK flag causes the receive operation to return data from the beginning of the receive queue without removing that data from the queue. Thus, a subsequent receive call will return the same data. The MSG_WAITALL flag requests that the operation block until the full request is satisfied. However, the call may still return less data than requested if a signal is caught, an error or disconnect occurs, or the next data to be received is of a different type than that returned. The MSG_DONTWAIT flag requests the call to return when it would block otherwise. If no data is available, errno is set to Er EAGAIN . This flag is not available in strict ANSI or C99 compilation mode. The MSG_WAITFORONE flag sets MSG_DONTWAIT after the first message has been received. This flag is only relevant for Fn recvmmsg .
The Fn recvmsg system call uses a Fa msghdr structure to minimize the number of directly supplied arguments. This structure has the following form, as defined in In sys/socket.h :
struct msghdr {
void *msg_name; /* optional address */
socklen_t msg_namelen; /* size of address */
struct iovec *msg_iov; /* scatter/gather array */
int msg_iovlen; /* # elements in msg_iov */
void *msg_control; /* ancillary data, see below */
socklen_t msg_controllen;/* ancillary data buffer len */
int msg_flags; /* flags on received message */
};
Here Fa msg_name and Fa msg_namelen specify the destination address if the socket is unconnected; Fa msg_name may be given as a null pointer if no names are desired or required. The Fa msg_iov and Fa msg_iovlen arguments describe scatter gather locations, as discussed in read(2). The Fa msg_control argument, which has length Fa msg_controllen , points to a buffer for other protocol control related messages or other miscellaneous ancillary data. The messages are of the form:
struct cmsghdr {
socklen_t cmsg_len; /* data byte count, including hdr */
int cmsg_level; /* originating protocol */
int cmsg_type; /* protocol-specific type */
/* followed by
u_char cmsg_data[]; */
};
As an example, one could use this to learn of changes in the data-stream in XNS/SPP, or in ISO, to obtain user-connection-request data by requesting a Fn recvmsg with no data buffer provided immediately after an Fn accept system call.
Open file descriptors are now passed as ancillary data for AF_UNIX domain sockets, with Fa cmsg_level set to SOL_SOCKET and Fa cmsg_type set to SCM_RIGHTS The close-on-exec flag on received descriptors is set according to the MSG_CMSG_CLOEXEC flag passed to Fn recvmsg .
Process credentials can also be passed as ancillary data for AF_UNIX domain sockets using a Fa cmsg_type of SCM_CREDS In this case, Fa cmsg_data should be a structure of type Fa cmsgcred , which is defined in In sys/socket.h as follows:
struct cmsgcred {
pid_t cmcred_pid; /* PID of sending process */
uid_t cmcred_uid; /* real UID of sending process */
uid_t cmcred_euid; /* effective UID of sending process */
gid_t cmcred_gid; /* real GID of sending process */
short cmcred_ngroups; /* number or groups */
gid_t cmcred_groups[CMGROUP_MAX]; /* groups */
};
If a sender supplies ancillary data with enough space for the above struct tagged as SCM_CREDS control message type to the Fn sendmsg system call, then kernel will fill in the credential information of the sending process and deliver it to the receiver. Since receiver usually has no control over a sender, this method of retrieving credential information isn't reliable. For reliable retrieval of remote side credentials it is advised to use the LOCAL_CREDS socket option on the receiving socket. See unix(4) for details.
The Fa msg_flags field is set on return according to the message received. MSG_EOR indicates end-of-record; the data returned completed a record (generally used with sockets of type SOCK_SEQPACKET ) MSG_TRUNC indicates that the trailing portion of a datagram was discarded because the datagram was larger than the buffer supplied. MSG_CTRUNC indicates that some control data were discarded due to lack of space in the buffer for ancillary data. MSG_OOB is returned to indicate that expedited or out-of-band data were received.
The Fn recvmmsg system call uses the Fa mmsghdr structure, defined as follows in the In sys/socket.h header :
struct mmsghdr {
struct msghdr msg_hdr; /* message header */
ssize_t msg_len; /* message length */
};
On data reception the Fa msg_len field is updated to the length of the received message.
RETURN VALUES
These calls except Fn recvmmsg return the number of bytes received. Fn recvmmsg returns the number of messages received. A value of -1 is returned if an error occurred.ERRORS
The calls fail if:- Bq Er EBADF
- The argument Fa s is an invalid descriptor.
- Bq Er ECONNRESET
- The remote socket end is forcibly closed.
- Bq Er ENOTCONN
- The socket is associated with a connection-oriented protocol and has not been connected (see connect(2) and accept(2)).
- Bq Er ENOTSOCK
- The argument Fa s does not refer to a socket.
- Bq Er EMSGSIZE
- The Fn recvmsg system call was used to receive rights (file descriptors) that were in flight on the connection. However, the receiving program did not have enough free file descriptor slots to accept them. In this case the descriptors are closed, any pending data can be returned by another call to Fn recvmsg .
- Bq Er EAGAIN
- The socket is marked non-blocking and the receive operation would block, or a receive timeout had been set and the timeout expired before data were received.
- Bq Er EINTR
- The receive was interrupted by delivery of a signal before any data were available.
- Bq Er EFAULT
- The receive buffer pointer(s) point outside the process's address space.