nuttx/net/pkt/pkt_sendmsg_unbuffered.c

/****************************************************************************
 * net/pkt/pkt_sendmsg_unbuffered.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>
#if defined(CONFIG_NET) && defined(CONFIG_NET_PKT)

#include <sys/types.h>
#include <sys/socket.h>

#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <errno.h>
#include <debug.h>

#include <arch/irq.h>
#include <netpacket/packet.h>

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

#include "netdev/netdev.h"
#include "devif/devif.h"
#include "socket/socket.h"
#include "utils/utils.h"
#include "pkt/pkt.h"

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

/* This structure holds the state of the send operation until it can be
 * operated upon by the event handler.
 */

struct send_s
{
  FAR struct socket      *snd_sock;    /* Points to the parent socket structure */
  FAR struct devif_callback_s *snd_cb; /* Reference to callback instance */
  FAR struct pkt_conn_s  *snd_conn;    /* Reference to the packet connection */
  sem_t                   snd_sem;     /* Used to wake up the waiting thread */
  FAR const uint8_t      *snd_buffer;  /* Points to the buffer of data to send */
  size_t                  snd_buflen;  /* Number of bytes in the buffer to send */
  ssize_t                 snd_sent;    /* The number of bytes sent */
  FAR struct sockaddr_ll *addr;        /* The address of the destination */
};

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

/****************************************************************************
 * Name: psock_send_eventhandler
 ****************************************************************************/

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

  ninfo("flags: %" PRIx32 " sent: %zd\n", flags, pstate->snd_sent);

  if (pstate)
    {
      /* Check if the outgoing packet is available. It may have been claimed
       * by a send event handler serving a different thread -OR- if the
       * output buffer currently contains unprocessed incoming data. In
       * these cases we will just have to wait for the next polling cycle.
       */

      if (dev->d_sndlen > 0 || (flags & PKT_NEWDATA) != 0)
        {
          /* Another thread has beat us sending data or the buffer is busy,
           * Check for a timeout. If not timed out, wait for the next
           * polling cycle and check again.
           */

          /* No timeout. Just wait for the next polling cycle */

          return flags;
        }

      /* It looks like we are good to send the data */

      else
        {
          /* Copy the packet data into the device packet buffer and send it */

          int ret;
          int offset = -NET_LL_HDRLEN(dev);

          if (pstate->snd_sock->s_type == SOCK_DGRAM)
            {
              offset = 0;
            }

          ret = devif_send(dev, pstate->snd_buffer,
                           pstate->snd_buflen, offset);
          if (ret <= 0)
            {
              pstate->snd_sent = ret;
              goto end_wait;
            }

          dev->d_len                = dev->d_sndlen;
          pstate->snd_sent          = pstate->snd_buflen;
          pstate->snd_conn->pendiob = dev->d_iob;

          if (pstate->snd_sock->s_type == SOCK_DGRAM)
            {
              FAR struct eth_hdr_s *ethhdr = NETLLBUF;
              memcpy(ethhdr->dest, pstate->addr->sll_addr, ETHER_ADDR_LEN);
              memcpy(ethhdr->src, &dev->d_mac.ether, ETHER_ADDR_LEN);
              ethhdr->type = pstate->addr->sll_protocol;
              dev->d_len += NET_LL_HDRLEN(dev);
            }
        }

end_wait:

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

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

      /* Wake up the waiting thread */

      nxsem_post(&pstate->snd_sem);
    }

  return flags;
}

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

/****************************************************************************
 * Name: pkt_sendmsg
 *
 * Description:
 *   The pkt_sendmsg() call may be used only when the packet socket is in
 *   a connected state (so that the intended recipient is known).
 *
 * Input Parameters:
 *   psock    An instance of the internal socket structure.
 *   msg      Message to send
 *   flags    Send flags
 *
 * Returned Value:
 *   On success, returns the number of characters sent. On error, a negated
 *   errno value is returned (see sendmsg() for the complete list of return
 *   values.
 *
 ****************************************************************************/

ssize_t pkt_sendmsg(FAR struct socket *psock, FAR struct msghdr *msg,
                    int flags)
{
  FAR const void *buf = msg->msg_iov->iov_base;
  size_t len = msg->msg_iov->iov_len;
  FAR struct sockaddr_ll *addr = msg->msg_name;
  FAR struct net_driver_s *dev;
  FAR struct pkt_conn_s *conn;
  struct send_s state;
  int ret = OK;

  /* Validity check */

  ret = pkt_sendmsg_is_valid(psock, msg, &dev);
  if (ret != OK)
    {
      return ret;
    }

  conn = psock->s_conn;

  if (psock->s_type == SOCK_DGRAM)
    {
      /* Set the interface index for devif_poll can match the conn */

      conn->ifindex = addr->sll_ifindex;
    }

  /* Perform the send operation */

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

  conn_dev_lock(&conn->sconn, dev);
  memset(&state, 0, sizeof(struct send_s));
  nxsem_init(&state.snd_sem, 0, 0); /* Doesn't really fail */

  state.snd_sock   = psock;          /* Socket descriptor to use */
  state.snd_buflen = len;            /* Number of bytes to send */
  state.snd_buffer = buf;            /* Buffer to send from */
  state.snd_conn   = conn;           /* Connection info */
  state.addr       = addr;           /* Destination address */

  if (len > 0)
    {
      /* Allocate resource to receive a callback */

      state.snd_cb = pkt_callback_alloc(dev, conn);
      if (state.snd_cb)
        {
          /* Set up the callback in the connection */

          state.snd_cb->flags = PKT_POLL;
          state.snd_cb->priv  = (FAR void *)&state;
          state.snd_cb->event = psock_send_eventhandler;

          /* Notify the device driver that new TX data is available. */

          netdev_txnotify_dev(dev, PKT_POLL);

          /* Wait for the send to complete or an error to occur.
           * conn_dev_sem_timedwait will also terminate if a signal is
           * received.
           */

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

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

          pkt_callback_free(dev, conn, state.snd_cb);
        }
    }

  nxsem_destroy(&state.snd_sem);
  conn_dev_unlock(&conn->sconn, dev);

  /* Check for errors.  Errors are signalled by negative errno values
   * for the send length
   */

  if (state.snd_sent < 0)
    {
      return state.snd_sent;
    }

  /* 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 (ret < 0)
    {
      return ret;
    }

  /* Return the number of bytes actually sent */

  return state.snd_sent;
}

#endif /* CONFIG_NET && CONFIG_NET_PKT */