OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity
incubator-nuttx/net/udp/udp_txdrain.c

129 lines
3.7 KiB
C
Raw Normal View History

This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
/****************************************************************************
* net/udp/udp_txdrain.c
*
net: Author Gregory Nutt: update licenses to Apache Gregory Nutt has submitted the SGA and we can migrate the licenses to Apache. Signed-off-by: Alin Jerpelea <alin.jerpelea@sony.com>
2021-02-19 19:45:37 +08:00
* 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.
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <sched.h>
#include <assert.h>
#include <errno.h>
sched: Don't include nuttx/sched.h inside sched.h But let nuttx/sched.h include sched.h instead to avoid expose nuttx kernel API to userspace. Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-05-14 10:03:23 +08:00
#include <nuttx/net/net.h>
Replace #include <semaphore.h> to #include <nuttx/semaphore.h> Since the kernel side should call nxsem_xxx instead and remove the unused inclusion
2020-02-01 15:17:32 +08:00
#include <nuttx/semaphore.h>
sched: Don't include nuttx/sched.h inside sched.h But let nuttx/sched.h include sched.h instead to avoid expose nuttx kernel API to userspace. Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-05-14 10:03:23 +08:00
#include "utils/utils.h"
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
#include "udp/udp.h"
Squashed commit of the following: Author: Gregory Nutt <gnutt@nuttx.org> Run all .h and .c files modified in last PR through nxstyle. Author: Xiang Xiao <xiaoxiang@xiaomi.com> Net cleanup (#17) * Fix the semaphore usage issue found in tcp/udp 1. The count semaphore need disable priority inheritance 2. Loop again if net_lockedwait return -EINTR 3. Call nxsem_trywait to avoid the race condition 4. Call nxsem_post instead of sem_post * Put the work notifier into free list to avoid the heap fragment in the long run. Since the allocation strategy is encapsulated internally, we can even refine the implementation later. * Network stack shouldn't allocate memory in the poll implementation to avoid the heap fragment in the long run, other modification include: 1. Select MM_IOB automatically since ICMP[v6] socket can't work without the read ahead buffer 2. Remove the net lock since xxx_callback_free already do the same thing 3. TCP/UDP poll should work even the read ahead buffer isn't enabled at all * Add NET_ prefix for UDP_NOTIFIER and TCP_NOTIFIER option to align with other UDP/TCP option convention * Remove the unused _SF_[IDLE|ACCEPT|SEND|RECV|MASK] flags since there are code to set/clear these flags, but nobody check them.
2019-12-31 23:26:14 +08:00
#if defined(CONFIG_NET_UDP_WRITE_BUFFERS) && defined(CONFIG_NET_UDP_NOTIFIER)
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: txdrain_worker
*
* Description:
* Called with the write buffers have all been sent.
*
* Input Parameters:
net/tcp and udp: Fix errors in the new implementation of SO_LINGER. The tcp_drain() and udp_drain() functions were casting the working argument to the wrong type, resulting in hangs and abnormal behavior. There is a complexity in the tcp drain logic when the remote peer closes the socket before all Tx data has been flushed. Sometimes we are not notified of this case and wait the entire timeout unnecessarily. There is a workaround in place in tcp_txdrain(), but this really should be revisited.
2019-07-28 00:26:52 +08:00
* arg - The notifier entry.
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
*
* Returned Value:
* None.
*
****************************************************************************/
static void txdrain_worker(FAR void *arg)
{
Squashed commit of the following: Author: Gregory Nutt <gnutt@nuttx.org> Run all .h and .c files modified in last PR through nxstyle. Author: Xiang Xiao <xiaoxiang@xiaomi.com> Net cleanup (#17) * Fix the semaphore usage issue found in tcp/udp 1. The count semaphore need disable priority inheritance 2. Loop again if net_lockedwait return -EINTR 3. Call nxsem_trywait to avoid the race condition 4. Call nxsem_post instead of sem_post * Put the work notifier into free list to avoid the heap fragment in the long run. Since the allocation strategy is encapsulated internally, we can even refine the implementation later. * Network stack shouldn't allocate memory in the poll implementation to avoid the heap fragment in the long run, other modification include: 1. Select MM_IOB automatically since ICMP[v6] socket can't work without the read ahead buffer 2. Remove the net lock since xxx_callback_free already do the same thing 3. TCP/UDP poll should work even the read ahead buffer isn't enabled at all * Add NET_ prefix for UDP_NOTIFIER and TCP_NOTIFIER option to align with other UDP/TCP option convention * Remove the unused _SF_[IDLE|ACCEPT|SEND|RECV|MASK] flags since there are code to set/clear these flags, but nobody check them.
2019-12-31 23:26:14 +08:00
FAR sem_t *waitsem = (FAR sem_t *)arg;
net/tcp and udp: Fix errors in the new implementation of SO_LINGER. The tcp_drain() and udp_drain() functions were casting the working argument to the wrong type, resulting in hangs and abnormal behavior. There is a complexity in the tcp drain logic when the remote peer closes the socket before all Tx data has been flushed. Sometimes we are not notified of this case and wait the entire timeout unnecessarily. There is a workaround in place in tcp_txdrain(), but this really should be revisited.
2019-07-28 00:26:52 +08:00
Squashed commit of the following: Author: Gregory Nutt <gnutt@nuttx.org> Run all .h and .c files modified in last PR through nxstyle. Author: Xiang Xiao <xiaoxiang@xiaomi.com> Net cleanup (#17) * Fix the semaphore usage issue found in tcp/udp 1. The count semaphore need disable priority inheritance 2. Loop again if net_lockedwait return -EINTR 3. Call nxsem_trywait to avoid the race condition 4. Call nxsem_post instead of sem_post * Put the work notifier into free list to avoid the heap fragment in the long run. Since the allocation strategy is encapsulated internally, we can even refine the implementation later. * Network stack shouldn't allocate memory in the poll implementation to avoid the heap fragment in the long run, other modification include: 1. Select MM_IOB automatically since ICMP[v6] socket can't work without the read ahead buffer 2. Remove the net lock since xxx_callback_free already do the same thing 3. TCP/UDP poll should work even the read ahead buffer isn't enabled at all * Add NET_ prefix for UDP_NOTIFIER and TCP_NOTIFIER option to align with other UDP/TCP option convention * Remove the unused _SF_[IDLE|ACCEPT|SEND|RECV|MASK] flags since there are code to set/clear these flags, but nobody check them.
2019-12-31 23:26:14 +08:00
DEBUGASSERT(waitsem != NULL);
net/tcp and udp: Fix errors in the new implementation of SO_LINGER. The tcp_drain() and udp_drain() functions were casting the working argument to the wrong type, resulting in hangs and abnormal behavior. There is a complexity in the tcp drain logic when the remote peer closes the socket before all Tx data has been flushed. Sometimes we are not notified of this case and wait the entire timeout unnecessarily. There is a workaround in place in tcp_txdrain(), but this really should be revisited.
2019-07-28 00:26:52 +08:00
/* Then just post the semaphore, waking up tcp_txdrain() */
Squashed commit of the following: Author: Gregory Nutt <gnutt@nuttx.org> Run all .h and .c files modified in last PR through nxstyle. Author: Xiang Xiao <xiaoxiang@xiaomi.com> Net cleanup (#17) * Fix the semaphore usage issue found in tcp/udp 1. The count semaphore need disable priority inheritance 2. Loop again if net_lockedwait return -EINTR 3. Call nxsem_trywait to avoid the race condition 4. Call nxsem_post instead of sem_post * Put the work notifier into free list to avoid the heap fragment in the long run. Since the allocation strategy is encapsulated internally, we can even refine the implementation later. * Network stack shouldn't allocate memory in the poll implementation to avoid the heap fragment in the long run, other modification include: 1. Select MM_IOB automatically since ICMP[v6] socket can't work without the read ahead buffer 2. Remove the net lock since xxx_callback_free already do the same thing 3. TCP/UDP poll should work even the read ahead buffer isn't enabled at all * Add NET_ prefix for UDP_NOTIFIER and TCP_NOTIFIER option to align with other UDP/TCP option convention * Remove the unused _SF_[IDLE|ACCEPT|SEND|RECV|MASK] flags since there are code to set/clear these flags, but nobody check them.
2019-12-31 23:26:14 +08:00
nxsem_post(waitsem);
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: udp_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.
network: simplify the timeout process logic 1.Consolidate absolute to relative timeout conversion into one place(_net_timedwait) 2.Drive the wait timeout logic by net_timedwait instead of devif_timer This patch help us remove devif_timer(period tick) to save the power in the future. Change-Id: I534748a5d767ca6da8a7843c3c2f993ed9ea77d4 Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-01-04 18:37:46 +08:00
* timeout - The relative time when the timeout will occur
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
*
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned
* on any failure.
*
****************************************************************************/
network: simplify the timeout process logic 1.Consolidate absolute to relative timeout conversion into one place(_net_timedwait) 2.Drive the wait timeout logic by net_timedwait instead of devif_timer This patch help us remove devif_timer(period tick) to save the power in the future. Change-Id: I534748a5d767ca6da8a7843c3c2f993ed9ea77d4 Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-01-04 18:37:46 +08:00
int udp_txdrain(FAR struct socket *psock, unsigned int timeout)
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
{
FAR struct udp_conn_s *conn;
sem_t waitsem;
int ret;
DEBUGASSERT(psock->s_type == SOCK_DGRAM);
net: remove conn-related casts remove redundant casts associated with psock Signed-off-by: zhanghongyu <zhanghongyu@xiaomi.com>
2023-05-08 22:11:04 +08:00
conn = psock->s_conn;
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
/* Initialize the wait semaphore */
nxsem_init(&waitsem, 0, 0);
/* The following needs to be done with the network stable */
net_lock();
ret = udp_writebuffer_notifier_setup(txdrain_worker, conn, &waitsem);
if (ret > 0)
{
int key = ret;
/* There is pending write data.. wait for it to drain. */
net: consistent the net sem wait naming conversion to prepare the new mutex wait function Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2023-01-13 14:51:38 +08:00
ret = net_sem_timedwait_uninterruptible(&waitsem, timeout);
This commit implements a proper version of SO_LINGER. Not sufficiently tested on initial commit. 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.
2019-07-02 02:25:32 +08:00
/* Tear down the notifier (in case we timed out or were canceled) */
if (ret < 0)
{
udp_notifier_teardown(key);
}
}
net_unlock();
nxsem_destroy(&waitsem);
return ret;
}
Squashed commit of the following: Author: Gregory Nutt <gnutt@nuttx.org> Run all .h and .c files modified in last PR through nxstyle. Author: Xiang Xiao <xiaoxiang@xiaomi.com> Net cleanup (#17) * Fix the semaphore usage issue found in tcp/udp 1. The count semaphore need disable priority inheritance 2. Loop again if net_lockedwait return -EINTR 3. Call nxsem_trywait to avoid the race condition 4. Call nxsem_post instead of sem_post * Put the work notifier into free list to avoid the heap fragment in the long run. Since the allocation strategy is encapsulated internally, we can even refine the implementation later. * Network stack shouldn't allocate memory in the poll implementation to avoid the heap fragment in the long run, other modification include: 1. Select MM_IOB automatically since ICMP[v6] socket can't work without the read ahead buffer 2. Remove the net lock since xxx_callback_free already do the same thing 3. TCP/UDP poll should work even the read ahead buffer isn't enabled at all * Add NET_ prefix for UDP_NOTIFIER and TCP_NOTIFIER option to align with other UDP/TCP option convention * Remove the unused _SF_[IDLE|ACCEPT|SEND|RECV|MASK] flags since there are code to set/clear these flags, but nobody check them.
2019-12-31 23:26:14 +08:00
#endif /* CONFIG_NET_UDP_WRITE_BUFFERS && CONFIG_NET_UDP_NOTIFIER */