nuttx/net/pkt/pkt_recvmsg.c

/****************************************************************************
 * net/pkt/pkt_recvmsg.c
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#ifdef CONFIG_NET

#include <sys/types.h>
#include <sys/socket.h>
#include <sys/time.h>
#include <stdint.h>
#include <string.h>
#include <errno.h>
#include <nuttx/debug.h>
#include <assert.h>

#include <arch/irq.h>

#include <nuttx/semaphore.h>
#include <nuttx/net/net.h>
#include <nuttx/net/netdev.h>

#include "netdev/netdev.h"
#include "devif/devif.h"
#include "pkt/pkt.h"
#include "socket/socket.h"
#include "utils/utils.h"
#include <netpacket/packet.h>

/****************************************************************************
 * Private Types
 ****************************************************************************/

struct pkt_recvfrom_s
{
  FAR struct pkt_conn_s       *pr_conn;    /* Connection associated with the socket */
  FAR struct devif_callback_s *pr_cb;      /* Reference to callback instance */
  FAR struct msghdr           *pr_msg;     /* Receive info and buffer */
  sem_t                        pr_sem;     /* Semaphore signals recv completion */
  ssize_t                      pr_recvlen; /* The received length */
  int                          pr_result;  /* Success:OK, failure:negated errno */
  uint8_t                      pr_type;    /* Protocol type */
};

/****************************************************************************
 * Private Functions
 ****************************************************************************/

/****************************************************************************
 * Name: pkt_store_cmsg_timestamp
 *
 * Description:
 *   Store the timestamp in the cmsg
 *
 * Input Parameters:
 *   pstate     Recicve state information
 *   timestamp  Timestamp  information
 *
 * Returned Value:
 *   None
 *
 ****************************************************************************/

#ifdef CONFIG_NET_TIMESTAMP
static void pkt_store_cmsg_timestamp(FAR struct pkt_recvfrom_s *pstate,
                                     FAR struct timespec *timestamp)
{
  FAR struct msghdr *msg = pstate->pr_msg;
  struct timeval tv;

  if (_SO_GETOPT(pstate->pr_conn->sconn.s_options, SO_TIMESTAMPNS))
    {
      cmsg_append(msg, SOL_SOCKET, SO_TIMESTAMPNS, timestamp,
                  sizeof(struct timespec));
    }
  else
    {
      TIMESPEC_TO_TIMEVAL(&tv, timestamp);
      cmsg_append(msg, SOL_SOCKET, SO_TIMESTAMP, &tv,
                  sizeof(struct timeval));
    }
}
#endif

/****************************************************************************
 * Name: pkt_add_recvlen
 *
 * Description:
 *   Update information about space available for new data and update size
 *   of data in buffer,  This logic accounts for the case where
 *   recvfrom_udpreadahead() sets state.pr_recvlen == -1 .
 *
 * Input Parameters:
 *   pstate   recvfrom state structure
 *   recvlen  size of new data appended to buffer
 *
 * Returned Value:
 *   None
 *
 ****************************************************************************/

static inline void pkt_add_recvlen(FAR struct pkt_recvfrom_s *pstate,
                                   size_t recvlen)
{
  if (pstate->pr_recvlen < 0)
    {
      pstate->pr_recvlen = 0;
    }

  pstate->pr_recvlen += recvlen;
}

/****************************************************************************
 * Name: pkt_recvfrom_newdata
 *
 * Description:
 *   Copy the read data from the packet
 *
 * Input Parameters:
 *   dev      The structure of the network driver that caused the event.
 *   pstate   recvfrom state structure
 *
 * Returned Value:
 *   None.
 *
 * Assumptions:
 *   The network is locked.
 *
 ****************************************************************************/

static void pkt_recvfrom_newdata(FAR struct net_driver_s *dev,
                                 FAR struct pkt_recvfrom_s *pstate)
{
  int offset = 0;
  size_t recvlen;

#ifdef CONFIG_NET_TIMESTAMP
  /* Unpack stored timestamp if SO_TIMESTAMP socket option is enabled */

  if (_SO_GETOPT(pstate->pr_conn->sconn.s_options, SO_TIMESTAMP) ||
      _SO_GETOPT(pstate->pr_conn->sconn.s_options, SO_TIMESTAMPNS))
    {
      pkt_store_cmsg_timestamp(pstate, &dev->d_rxtime);
    }
#endif

  recvlen = MIN(pstate->pr_msg->msg_iov->iov_len, dev->d_len);

  /* Copy the new packet data into the user buffer */

  if (pstate->pr_type == SOCK_RAW)
    {
      offset = -NET_LL_HDRLEN(dev);
    }

  recvlen = iob_copyout(pstate->pr_msg->msg_iov->iov_base,
                        dev->d_iob, recvlen, offset);

  ninfo("Received %d bytes (of %d)\n", (int)recvlen, (int)dev->d_len);

  /* Update the accumulated size of the data read */

  pkt_add_recvlen(pstate, recvlen);
}

/****************************************************************************
 * Name: pkt_recvfrom_sender
 *
 * Description:
 *
 * Input Parameters:
 *
 * Returned Value:
 *
 * Assumptions:
 *
 ****************************************************************************/

static inline void pkt_recvfrom_sender(FAR struct net_driver_s *dev,
                                       FAR struct pkt_recvfrom_s *pstate)
{
}

/****************************************************************************
 * Name: pkt_recvfrom_eventhandler
 *
 * Description:
 *
 * Input Parameters:
 *
 * Returned Value:
 *
 * Assumptions:
 *
 ****************************************************************************/

static uint32_t pkt_recvfrom_eventhandler(FAR struct net_driver_s *dev,
                                          FAR void *pvpriv, uint32_t flags)
{
  struct pkt_recvfrom_s *pstate = pvpriv;

  ninfo("flags: %" PRIx32 "\n", flags);

  /* 'priv' might be null in some race conditions (?) */

  if (pstate)
    {
      /* If a new packet is available, then complete the read action. */

      if ((flags & PKT_NEWDATA) != 0)
        {
          /* Copy the packet */

          pkt_recvfrom_newdata(dev, pstate);

          /* We are finished. */

          ninfo("PKT done\n");

          /* Don't allow any further call backs. */

          pstate->pr_cb->flags   = 0;
          pstate->pr_cb->priv    = NULL;
          pstate->pr_cb->event   = NULL;

          /* Save the sender's address in the caller's 'from' location */

          pkt_recvfrom_sender(dev, pstate);

          /* indicate that the data has been consumed */

          flags &= ~PKT_NEWDATA;

          /* Wake up the waiting thread, returning the number of bytes
           * actually read.
           */

          nxsem_post(&pstate->pr_sem);
        }
    }

  return flags;
}

/****************************************************************************
 * Name: pkt_recvfrom_initialize
 *
 * Description:
 *   Initialize the state structure
 *
 * Input Parameters:
 *   conn     The PKT connection of interest
 *   msg      Receive info and buffer for receive data
 *   pstate   A pointer to the state structure to be initialized
 *   type     Protocol type
 *
 * Returned Value:
 *   None
 *
 * Assumptions:
 *
 ****************************************************************************/

static void pkt_recvfrom_initialize(FAR struct pkt_conn_s *conn,
                                    FAR struct msghdr *msg,
                                    FAR struct pkt_recvfrom_s *pstate,
                                    uint8_t type)
{
  /* Initialize the state structure. */

  memset(pstate, 0, sizeof(struct pkt_recvfrom_s));
  nxsem_init(&pstate->pr_sem, 0, 0); /* Doesn't really fail */

  pstate->pr_conn = conn;
  pstate->pr_msg  = msg;
  pstate->pr_type = type;
}

/* The only un-initialization that has to be performed is destroying the
 * semaphore.
 */

#define pkt_recvfrom_uninitialize(s) nxsem_destroy(&(s)->pr_sem)

/****************************************************************************
 * Name: pkt_recvfrom_result
 *
 * Description:
 *   Evaluate the result of the recv operations
 *
 * Input Parameters:
 *   result   The result of the conn_dev_sem_timedwait operation
 *            (may indicate EINTR)
 *   pstate   A pointer to the state structure to be initialized
 *
 * Returned Value:
 *   The result of the recv operation with errno set appropriately
 *
 * Assumptions:
 *
 ****************************************************************************/

static ssize_t pkt_recvfrom_result(int result,
                                   FAR struct pkt_recvfrom_s *pstate)
{
  /* Check for a error/timeout detected by the event handler.  Errors are
   * signaled by negative errno values for the rcv length
   */

  if (pstate->pr_result < 0)
    {
      /* This might return EAGAIN on a timeout or ENOTCONN on loss of
       * connection (TCP only)
       */

      return pstate->pr_result;
    }

  /* If conn_dev_sem_timedwait failed, then we were probably reawakened by a
   * signal. In this case, conn_dev_sem_timedwait will have returned negated
   * errno appropriately.
   */

  if (result < 0)
    {
      return result;
    }

  return pstate->pr_recvlen;
}

/****************************************************************************
 * Name: pkt_readahead
 *
 * Description:
 *   Copy the buffered read-ahead data to the user buffer.
 *
 * Input Parameters:
 *   pstate       The state structure of the recv operation
 *
 * Returned Value:
 *   None
 *
 * Assumptions:
 *   The network is locked.
 *
 ****************************************************************************/

static inline void pkt_readahead(FAR struct pkt_recvfrom_s *pstate)
{
  FAR struct pkt_conn_s *conn = pstate->pr_conn;
  FAR struct iob_s *iob;
  int recvlen;
  int offset = 0;

  /* Check there is any packets already buffered in a read-ahead buffer. */

  pstate->pr_recvlen = -ENODATA;

  if ((iob = iob_peek_queue(&conn->readahead)) != NULL)
    {
      DEBUGASSERT(iob->io_pktlen > 0);

#ifdef CONFIG_NET_TIMESTAMP
      /* Unpack stored timestamp if SO_TIMESTAMP/SO_TIMESTAMPNS socket option
       * is enabled
       */

      if (_SO_GETOPT(conn->sconn.s_options, SO_TIMESTAMP) ||
          _SO_GETOPT(conn->sconn.s_options, SO_TIMESTAMPNS))
        {
          struct timespec ts;
          recvlen = iob_copyout((FAR uint8_t *)&ts, iob,
                                sizeof(struct timespec),
                                -sizeof(struct timespec));
          DEBUGASSERT(recvlen == sizeof(struct timespec));

          pkt_store_cmsg_timestamp(pstate, &ts);
        }
#endif

      /* Copy to user */

      if (pstate->pr_type == SOCK_DGRAM)
        {
          FAR struct net_driver_s *dev = pkt_find_device(conn);
          if (dev != NULL)
            {
              /* For SOCK_DGRAM, we need skip the l2 header */

              offset = NET_LL_HDRLEN(dev);
            }
          else
            {
              offset = sizeof(struct eth_hdr_s);
            }
        }

      recvlen = iob_copyout(pstate->pr_msg->msg_iov->iov_base, iob,
                            pstate->pr_msg->msg_iov->iov_len, offset);

      /* Update the accumulated size of the data read */

      pstate->pr_recvlen = recvlen;

      ninfo("Received %d bytes (of %u)\n", recvlen, iob->io_pktlen);

      /* Remove the I/O buffer chain from the head of the read-ahead
       * buffer queue.
       */

      iob_remove_queue(&conn->readahead);

      /* And free the I/O buffer chain */

      iob_free_chain(iob);
    }
}

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name: pkt_recvmsg
 *
 * Description:
 *   Implements the socket recvmsg interface for the case of the AF_INET
 *   and AF_INET6 address families.  pkt_recvmsg() receives messages from
 *   a socket, and may be used to receive data on a socket whether or not it
 *   is connection-oriented.
 *
 *   If 'msg_name' is not NULL, and the underlying protocol provides the
 *   source address, this source address is filled in.  The argument
 *   'msg_namelen' is initialized to the size of the buffer associated with
 *   msg_name, and modified on return to indicate the actual size of the
 *   address stored there.
 *
 * Input Parameters:
 *   psock    A pointer to a NuttX-specific, internal socket structure
 *   msg      Buffer to receive the message
 *   flags    Receive flags
 *
 * Returned Value:
 *   On success, returns the number of characters received. If no data is
 *   available to be received and the peer has performed an orderly shutdown,
 *   recvmsg() will return 0.  Otherwise, on errors, a negated errno value is
 *   returned (see recvmsg() for the list of appropriate error values).
 *
 ****************************************************************************/

ssize_t pkt_recvmsg(FAR struct socket *psock, FAR struct msghdr *msg,
                    int flags)
{
  FAR struct sockaddr *from = msg->msg_name;
  FAR socklen_t *fromlen = &msg->msg_namelen;
  FAR struct pkt_conn_s *conn = psock->s_conn;
  FAR struct net_driver_s *dev;
  struct pkt_recvfrom_s state;
  ssize_t ret = 0;

  /* If a 'from' address has been provided, verify that it is large
   * enough to hold this address family.
   */

  if (from != NULL && *fromlen < sizeof(sa_family_t))
    {
      return -EINVAL;
    }

  if (msg->msg_iovlen != 1)
    {
      return -ENOTSUP;
    }

  if (psock->s_type != SOCK_DGRAM && psock->s_type != SOCK_RAW)
    {
      nerr("ERROR: Unsupported socket type: %d\n", psock->s_type);
      return -ENOSYS;
    }

  /* Get the device driver that will service this transfer */

  dev  = pkt_find_device(conn);
  if (dev == NULL)
    {
      return -ENODEV;
    }

  /* Perform the packet recvfrom() operation */

  /* Initialize the state structure.  This is done with the network
   * locked because we don't want anything to happen until we are ready.
   */

  pkt_recvfrom_initialize(conn, msg, &state, psock->s_type);

  conn_dev_lock(&conn->sconn, dev);

  /* Check if there is buffered read-ahead data for this socket.  We may have
   * already received the response to previous command.
   */

  if (!IOB_QEMPTY(&conn->readahead))
    {
      pkt_readahead(&state);
      ret = pkt_recvfrom_result(ret, &state);
    }
  else if (_SS_ISNONBLOCK(conn->sconn.s_flags) ||
           (flags & MSG_DONTWAIT) != 0)
    {
      /* Handle non-blocking PKT sockets */

      ret = -EAGAIN;
    }
  else
    {
      /* TODO pkt_recvfrom_initialize() expects from to be of type
       * sockaddr_in, but in our case is sockaddr_ll
       */

#if 0
      ret = pkt_connect(conn, NULL);
      if (ret < 0)
        {
          goto errout_with_state;
        }
#endif

      /* Set up the callback in the connection */

      state.pr_cb = pkt_callback_alloc(dev, conn);
      if (state.pr_cb)
        {
          state.pr_cb->flags  = (PKT_NEWDATA | PKT_POLL);
          state.pr_cb->priv   = (FAR void *)&state;
          state.pr_cb->event  = pkt_recvfrom_eventhandler;

          /* Wait for either the receive to complete or for an error/timeout
           * to occur. NOTES:  (1) conn_dev_sem_timedwait will also terminate
           * if a signal is received, (2) the network is locked!  It will be
           * un-locked while the task sleeps and automatically re-locked when
           * the task restarts.
           */

          ret = conn_dev_sem_timedwait(&state.pr_sem, true, UINT_MAX,
                                       &conn->sconn, dev);

          /* Make sure that no further events are processed */

          pkt_callback_free(dev, conn, state.pr_cb);
          ret = pkt_recvfrom_result(ret, &state);
        }
      else
        {
          ret = -EBUSY;
        }
    }

  conn_dev_unlock(&conn->sconn, dev);

  pkt_recvfrom_uninitialize(&state);

  return ret;
}

#endif /* CONFIG_NET */