de5a6163d5
Squashed commit of the following:
net/: Fix some naming inconsistencies, Fix final compilation issies.
net/inet/inet_close(): Now that we have logic to drain the buffered TX data, we can implement a proper lingering close.
net/inet,tcp,udp: Add functions to wait for write buffers to drain.
net/udp: Add support for notification when the UDP write buffer becomes empty.
net/tcp: Add support for notification when the TCP write buffer becomes empty.
147 lines
4.6 KiB
C
147 lines
4.6 KiB
C
/****************************************************************************
|
|
* net/tcp/tcp_txdrain.c
|
|
*
|
|
* Copyright (C) 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 <sys/types.h>
|
|
#include <semaphore.h>
|
|
#include <sched.h>
|
|
#include <time.h>
|
|
#include <assert.h>
|
|
#include <errno.h>
|
|
|
|
#include <nuttx/wqueue.h>
|
|
#include <nuttx/net/net.h>
|
|
|
|
#include "tcp/tcp.h"
|
|
|
|
#if defined(CONFIG_NET_TCP_WRITE_BUFFERS) && defined(CONFIG_TCP_NOTIFIER)
|
|
|
|
/****************************************************************************
|
|
* Private Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: txdrain_worker
|
|
*
|
|
* Description:
|
|
* Called with the write buffers have all been sent.
|
|
*
|
|
* Input Parameters:
|
|
* arg - The semaphore that will wake up tcp_txdrain
|
|
*
|
|
* Returned Value:
|
|
* None.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static void txdrain_worker(FAR void *arg)
|
|
{
|
|
FAR sem_t *waitsem = (FAR sem_t *)arg;
|
|
DEBUGASSERT(waitsem != NULL);
|
|
sem_post(waitsem);
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Public Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: tcp_txdrain
|
|
*
|
|
* Description:
|
|
* Wait for all write buffers to be sent (or for a timeout to occur).
|
|
*
|
|
* Input Parameters:
|
|
* psock - An instance of the internal socket structure.
|
|
* abstime - The absolute time when the timeout will occur
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) is returned on success; a negated errno value is returned
|
|
* on any failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int tcp_txdrain(FAR struct socket *psock,
|
|
FAR const struct timespec *abstime)
|
|
{
|
|
FAR struct tcp_conn_s *conn;
|
|
sem_t waitsem;
|
|
int ret;
|
|
|
|
DEBUGASSERT(psock != NULL && psock->s_crefs > 0 && psock->s_conn != NULL);
|
|
DEBUGASSERT(psock->s_type == SOCK_DGRAM);
|
|
|
|
conn = (FAR struct tcp_conn_s *)psock->s_conn;
|
|
|
|
/* Initialize the wait semaphore */
|
|
|
|
nxsem_init(&waitsem, 0, 0);
|
|
|
|
/* The following needs to be done with the network stable */
|
|
|
|
net_lock();
|
|
ret = tcp_writebuffer_notifier_setup(txdrain_worker, conn, &waitsem);
|
|
if (ret > 0)
|
|
{
|
|
int key = ret;
|
|
|
|
/* There is pending write data.. wait for it to drain. */
|
|
|
|
do
|
|
{
|
|
ret = net_timedwait(&waitsem, abstime);
|
|
}
|
|
while (ret == EINTR);
|
|
|
|
/* Tear down the notifier (in case we timed out or were canceled) */
|
|
|
|
if (ret < 0)
|
|
{
|
|
tcp_notifier_teardown(key);
|
|
}
|
|
}
|
|
|
|
net_unlock();
|
|
nxsem_destroy(&waitsem);
|
|
return ret;
|
|
}
|
|
|
|
#endif /* CONFIG_NET_TCP_WRITE_BUFFERS && CONFIG_TCP_NOTIFIER */
|