123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244 |
- /****************************************************************************
- * net/socket/recvmsg.c
- *
- * Copyright (C) 2007-2009, 2011-2017, 2019 Gregory Nutt. All rights
- * reserved.
- * Author: Gregory Nutt <gnutt@nuttx.org>
- *
- * 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 the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- * 3. Neither the name NuttX nor the names of its contributors may be
- * used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- ****************************************************************************/
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <assert.h>
- #include <errno.h>
- #include <nuttx/cancelpt.h>
- #include <nuttx/net/net.h>
- #include "socket/socket.h"
- #ifdef CONFIG_NET_CMSG
- /****************************************************************************
- * Public Functions
- ****************************************************************************/
- /****************************************************************************
- * Name: psock_recvmsg
- *
- * Description:
- * psock_recvfrom() receives messages from a socket, and may be used to
- * receive data on a socket whether or not it is connection-oriented.
- * This is an internal OS interface. It is functionally equivalent to
- * recvfrom() except that:
- *
- * - It is not a cancellation point,
- * - It does not modify the errno variable, and
- * - I accepts the internal socket structure as an input rather than an
- * task-specific socket descriptor.
- *
- * Input Parameters:
- * psock - A pointer to a NuttX-specific, internal socket structure
- * msg Buffer to receive msg
- * len - Length of buffer
- * flags - Receive flags
- *
- * Returned Value:
- * On success, returns the number of characters sent. If no data is
- * available to be received and the peer has performed an orderly shutdown,
- * recv() will return 0. Otherwise, on any failure, a negated errno value
- * is returned (see comments with send() for a list of appropriate errno
- * values).
- *
- ****************************************************************************/
- ssize_t psock_recvmsg(FAR struct socket *psock, FAR struct msghdr *msg,
- int flags)
- {
- /* Verify that non-NULL pointers were passed */
- if (msg == NULL)
- {
- return -EINVAL;
- }
- if (msg->msg_iovlen != 1)
- {
- return -ENOTSUP;
- }
- /* Verify that the sockfd corresponds to valid, allocated socket */
- if (psock == NULL || psock->s_crefs <= 0)
- {
- return -EBADF;
- }
- /* Let logic specific to this address family handle the recvfrom()
- * operation.
- */
- DEBUGASSERT(psock->s_sockif != NULL &&
- (psock->s_sockif->si_recvmsg != NULL ||
- psock->s_sockif->si_recvfrom != NULL));
- if (psock->s_sockif->si_recvmsg != NULL)
- {
- return psock->s_sockif->si_recvmsg(psock, msg, flags);
- }
- else
- {
- /* Socket doesn't implement si_recvmsg fallback to si_recvfrom */
- FAR void *buf = msg->msg_iov->iov_base;
- FAR struct sockaddr *from = msg->msg_name;
- FAR socklen_t *fromlen = (FAR socklen_t *)&msg->msg_namelen;
- size_t len = msg->msg_iov->iov_len;
- return psock->s_sockif->si_recvfrom(psock, buf, len, flags, from,
- fromlen);
- }
- }
- /****************************************************************************
- * Name: nx_recvfrom
- *
- * Description:
- * nx_recvfrom() receives messages from a socket, and may be used to
- * receive data on a socket whether or not it is connection-oriented.
- * This is an internal OS interface. It is functionally equivalent to
- * recvfrom() except that:
- *
- * - It is not a cancellation point, and
- * - It does not modify the errno variable.
- *
- * Input Parameters:
- * sockfd - Socket descriptor of socket
- * msg Buffer to receive msg
- * len - Length of buffer
- * flags - Receive flags
- *
- * Returned Value:
- * On success, returns the number of characters sent. If no data is
- * available to be received and the peer has performed an orderly shutdown,
- * recv() will return 0. Otherwise, on any failure, a negated errno value
- * is returned (see comments with send() for a list of appropriate errno
- * values).
- *
- ****************************************************************************/
- ssize_t nx_recvmsg(int sockfd, FAR struct msghdr *msg, int flags)
- {
- FAR struct socket *psock;
- /* Get the underlying socket structure */
- psock = sockfd_socket(sockfd);
- /* Then let psock_recvmsg() do all of the work */
- return psock_recvmsg(psock, msg, flags);
- }
- /****************************************************************************
- * Function: recvmsg
- *
- * Description:
- * The recvmsg() call is identical to recvfrom() with a NULL from
- * parameter.
- *
- * Parameters:
- * sockfd Socket descriptor of socket
- * msg Buffer to receive msg
- * len Length of buffer
- * flags Receive flags
- *
- * Returned Value:
- * On success, returns the number of characters received. On error,
- * -1 is returned, and errno is set appropriately:
- *
- * 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 was received.
- * EBADF
- * The argument sockfd is an invalid descriptor.
- * ECONNREFUSED
- * A remote host refused to allow the network connection (typically
- * because it is not running the requested service).
- * EFAULT
- * The receive buffer pointer(s) point outside the process's address
- * space.
- * EINTR
- * The receive was interrupted by delivery of a signal before any data
- * were available.
- * EINVAL
- * Invalid argument passed.
- * ENOMEM
- * Could not allocate memory.
- * ENOTCONN
- * The socket is associated with a connection-oriented protocol and has
- * not been connected.
- * ENOTSOCK
- * The argument sockfd does not refer to a socket.
- *
- ****************************************************************************/
- ssize_t recvmsg(int sockfd, FAR struct msghdr *msg, int flags)
- {
- FAR struct socket *psock;
- ssize_t ret;
- /* recvfrom() is a cancellation point */
- enter_cancellation_point();
- /* Get the underlying socket structure */
- psock = sockfd_socket(sockfd);
- /* Let psock_recvfrom() do all of the work */
- ret = psock_recvmsg(psock, msg, flags);
- if (ret < 0)
- {
- set_errno(-ret);
- ret = ERROR;
- }
- leave_cancellation_point();
- return ret;
- }
- #endif /* CONFIG_NET_CMSG */
|