forked from Archive/PX4-Autopilot
373 lines
9.9 KiB
C
373 lines
9.9 KiB
C
/****************************************************************************
|
|
* net/net_poll.c
|
|
*
|
|
* Copyright (C) 2008-2009, 2011-2012 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>
|
|
#if defined(CONFIG_NET) && !defined(CONFIG_DISABLE_POLL)
|
|
|
|
#include <sys/socket.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <stdlib.h>
|
|
#include <poll.h>
|
|
#include <errno.h>
|
|
#include <debug.h>
|
|
|
|
#include <nuttx/net/uip/uip.h>
|
|
#include <nuttx/net/net.h>
|
|
#include <nuttx/arch.h>
|
|
|
|
#include <uip/uip_internal.h>
|
|
|
|
#include "net_internal.h"
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Network polling can only be supported on TCP and only if read-ahead buffering
|
|
* is enabled (it could be supported on UDP as will if it also had read-ahead
|
|
* buffering.
|
|
*/
|
|
|
|
#if !defined(CONFIG_DISABLE_POLL) && CONFIG_NSOCKET_DESCRIPTORS > 0 && \
|
|
defined(CONFIG_NET_TCP) && CONFIG_NET_NTCP_READAHEAD_BUFFERS > 0
|
|
# define HAVE_NETPOLL 1
|
|
#else
|
|
# undef HAVE_NETPOLL
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Private Types
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Private Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Function: poll_interrupt
|
|
*
|
|
* Description:
|
|
* This function is called from the interrupt level to perform the actual
|
|
* TCP receive operation via by the uIP layer.
|
|
*
|
|
* Parameters:
|
|
* dev The structure of the network driver that caused the interrupt
|
|
* conn The connection structure associated with the socket
|
|
* flags Set of events describing why the callback was invoked
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
* Assumptions:
|
|
* Running at the interrupt level
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef HAVE_NETPOLL
|
|
static uint16_t poll_interrupt(struct uip_driver_s *dev, FAR void *conn,
|
|
FAR void *pvpriv, uint16_t flags)
|
|
{
|
|
FAR struct pollfd *fds = (FAR struct pollfd *)pvpriv;
|
|
|
|
nllvdbg("flags: %04x\n", flags);
|
|
|
|
/* 'priv' might be null in some race conditions (?) */
|
|
|
|
if (fds)
|
|
{
|
|
pollevent_t eventset = 0;
|
|
|
|
/* Check for data or connection availability events. */
|
|
|
|
if ((flags & (UIP_NEWDATA|UIP_BACKLOG)) != 0)
|
|
{
|
|
eventset |= POLLIN & fds->events;
|
|
}
|
|
|
|
/* A poll is a sign that we are free to send data. */
|
|
|
|
if ((flags & UIP_POLL) != 0)
|
|
{
|
|
eventset |= (POLLOUT & fds->events);
|
|
}
|
|
|
|
/* Check for a loss of connection events.
|
|
*
|
|
* REVISIT: Need to call net_lostconnection() here, but don't have
|
|
* the psock instance. What should we do?
|
|
*/
|
|
|
|
if ((flags & (UIP_CLOSE|UIP_ABORT|UIP_TIMEDOUT)) != 0)
|
|
{
|
|
eventset |= (POLLERR | POLLHUP);
|
|
}
|
|
|
|
/* Awaken the caller of poll() is requested event occurred. */
|
|
|
|
if (eventset)
|
|
{
|
|
fds->revents |= eventset;
|
|
sem_post(fds->sem);
|
|
}
|
|
}
|
|
|
|
return flags;
|
|
}
|
|
#endif /* HAVE_NETPOLL */
|
|
|
|
/****************************************************************************
|
|
* Function: net_pollsetup
|
|
*
|
|
* Description:
|
|
* Setup to monitor events on one TCP/IP socket
|
|
*
|
|
* Input Parameters:
|
|
* conn - The TCP/IP connection of interest
|
|
* fds - The structure describing the events to be monitored, OR NULL if
|
|
* this is a request to stop monitoring events.
|
|
*
|
|
* Returned Value:
|
|
* 0: Success; Negated errno on failure
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef HAVE_NETPOLL
|
|
static inline int net_pollsetup(FAR struct socket *psock, struct pollfd *fds)
|
|
{
|
|
FAR struct uip_conn *conn = psock->s_conn;
|
|
FAR struct uip_callback_s *cb;
|
|
uip_lock_t flags;
|
|
int ret;
|
|
|
|
/* Sanity check */
|
|
|
|
#ifdef CONFIG_DEBUG
|
|
if (!conn || !fds)
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
#endif
|
|
|
|
/* Some of the following must be atomic */
|
|
|
|
flags = uip_lock();
|
|
|
|
/* Allocate a TCP/IP callback structure */
|
|
|
|
cb = uip_tcpcallbackalloc(conn);
|
|
if (!cb)
|
|
{
|
|
ret = -EBUSY;
|
|
goto errout_with_irq;
|
|
}
|
|
|
|
/* Initialize the callback structure */
|
|
|
|
cb->flags = (UIP_NEWDATA|UIP_BACKLOG|UIP_POLL|UIP_CLOSE|UIP_ABORT|UIP_TIMEDOUT);
|
|
cb->priv = (FAR void *)fds;
|
|
cb->event = poll_interrupt;
|
|
|
|
/* Save the nps reference in the poll structure for use at teardown as well */
|
|
|
|
fds->priv = (FAR void *)cb;
|
|
|
|
#ifdef CONFIG_NET_TCPBACKLOG
|
|
/* Check for read data or backlogged connection availability now */
|
|
|
|
if (!sq_empty(&conn->readahead) || uip_backlogavailable(conn))
|
|
#else
|
|
/* Check for read data availability now */
|
|
|
|
if (!sq_empty(&conn->readahead))
|
|
#endif
|
|
{
|
|
fds->revents |= (POLLOUT & fds->events);
|
|
}
|
|
|
|
/* Check for a loss of connection events */
|
|
|
|
if (!_SS_ISCONNECTED(psock->s_flags))
|
|
{
|
|
fds->revents |= (POLLERR | POLLHUP);
|
|
}
|
|
|
|
/* Check if any requested events are already in effect */
|
|
|
|
if (fds->revents != 0)
|
|
{
|
|
/* Yes.. then signal the poll logic */
|
|
|
|
sem_post(fds->sem);
|
|
}
|
|
|
|
uip_unlock(flags);
|
|
return OK;
|
|
|
|
errout_with_irq:
|
|
uip_unlock(flags);
|
|
return ret;
|
|
}
|
|
#endif /* HAVE_NETPOLL */
|
|
|
|
/****************************************************************************
|
|
* Function: net_pollteardown
|
|
*
|
|
* Description:
|
|
* Teardown monitoring of events on an TCP/IP socket
|
|
*
|
|
* Input Parameters:
|
|
* conn - The TCP/IP connection of interest
|
|
*
|
|
* Returned Value:
|
|
* 0: Success; Negated errno on failure
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef HAVE_NETPOLL
|
|
static inline int net_pollteardown(FAR struct socket *psock, struct pollfd *fds)
|
|
{
|
|
FAR struct uip_conn *conn = psock->s_conn;
|
|
FAR struct uip_callback_s *cb;
|
|
uip_lock_t flags;
|
|
|
|
/* Sanity check */
|
|
|
|
#ifdef CONFIG_DEBUG
|
|
if (!conn || !fds->priv)
|
|
{
|
|
return -EINVAL;
|
|
}
|
|
#endif
|
|
|
|
/* Recover the socket descriptor poll state info from the poll structure */
|
|
|
|
cb = (FAR struct uip_callback_s *)fds->priv;
|
|
if (cb)
|
|
{
|
|
/* Release the callback */
|
|
|
|
flags = uip_lock();
|
|
uip_tcpcallbackfree(conn, cb);
|
|
uip_unlock(flags);
|
|
|
|
/* Release the poll/select data slot */
|
|
|
|
fds->priv = NULL;
|
|
}
|
|
|
|
return OK;
|
|
}
|
|
#endif /* HAVE_NETPOLL */
|
|
|
|
/****************************************************************************
|
|
* Public Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Function: net_poll
|
|
*
|
|
* Description:
|
|
* The standard poll() operation redirects operations on socket descriptors
|
|
* to this function.
|
|
*
|
|
* Input Parameters:
|
|
* fd - The socket descriptor of interest
|
|
* fds - The structure describing the events to be monitored, OR NULL if
|
|
* this is a request to stop monitoring events.
|
|
* setup - true: Setup up the poll; false: Teardown the poll
|
|
*
|
|
* Returned Value:
|
|
* 0: Success; Negated errno on failure
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef CONFIG_DISABLE_POLL
|
|
int net_poll(int sockfd, struct pollfd *fds, bool setup)
|
|
{
|
|
#ifndef HAVE_NETPOLL
|
|
return -ENOSYS;
|
|
#else
|
|
FAR struct socket *psock;
|
|
int ret;
|
|
|
|
/* Get the underlying socket structure and verify that the sockfd
|
|
* corresponds to valid, allocated socket
|
|
*/
|
|
|
|
psock = sockfd_socket(sockfd);
|
|
if (!psock || psock->s_crefs <= 0)
|
|
{
|
|
ret = -EBADF;
|
|
goto errout;
|
|
}
|
|
|
|
#ifdef CONFIG_NET_UDP
|
|
/* poll() not supported for UDP */
|
|
|
|
if (psock->s_type != SOCK_STREAM)
|
|
{
|
|
ret = -ENOSYS;
|
|
goto errout;
|
|
}
|
|
#endif
|
|
|
|
/* Check if we are setting up or tearing down the poll */
|
|
|
|
if (setup)
|
|
{
|
|
/* Perform the TCP/IP poll() setup */
|
|
|
|
ret = net_pollsetup(psock, fds);
|
|
}
|
|
else
|
|
{
|
|
/* Perform the TCP/IP poll() teardown */
|
|
|
|
ret = net_pollteardown(psock, fds);
|
|
}
|
|
|
|
errout:
|
|
return ret;
|
|
#endif /* HAVE_NETPOLL */
|
|
}
|
|
#endif /* !CONFIG_DISABLE_POLL */
|
|
|
|
#endif /* CONFIG_NET && !CONFIG_DISABLE_POLL */
|