2017-07-04 18:19:52 +02:00
|
|
|
/****************************************************************************
|
2017-07-08 02:45:58 +02:00
|
|
|
* net/ipforward/ipforward.h
|
2017-07-04 18:19:52 +02:00
|
|
|
*
|
2024-09-11 14:39:39 +02:00
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
*
|
2021-02-19 12:45:37 +01: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
|
2017-07-04 18:19:52 +02:00
|
|
|
*
|
2021-02-19 12:45:37 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2017-07-04 18:19:52 +02:00
|
|
|
*
|
2021-02-19 12:45:37 +01:00
|
|
|
* 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.
|
2017-07-04 18:19:52 +02:00
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
2017-07-08 02:45:58 +02:00
|
|
|
#ifndef __NET_IPFORWARD_IPFORWARD_H
|
|
|
|
|
#define __NET_IPFORWARD_IPFORWARD_H
|
2017-07-04 18:19:52 +02:00
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
|
* Included Files
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
|
|
2022-12-08 10:06:54 +01:00
|
|
|
#include <assert.h>
|
2017-07-04 18:19:52 +02:00
|
|
|
#include <stdint.h>
|
|
|
|
|
|
|
|
|
|
#undef HAVE_FWDALLOC
|
2017-07-06 15:26:01 +02:00
|
|
|
#ifdef CONFIG_NET_IPFORWARD
|
|
|
|
|
|
2017-07-04 18:19:52 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Pre-processor Definitions
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#define HAVE_FWDALLOC 1
|
|
|
|
|
|
|
|
|
|
#ifndef CONFIG_NET_IPFORWARD_NSTRUCT
|
|
|
|
|
# define CONFIG_NET_IPFORWARD_NSTRUCT 4
|
|
|
|
|
#endif
|
|
|
|
|
|
2022-12-08 10:06:54 +01:00
|
|
|
static_assert(CONFIG_IOB_NBUFFERS > CONFIG_NET_IPFORWARD_NSTRUCT,
|
|
|
|
|
"IP forward may consume all the IOB and break netdev logic");
|
|
|
|
|
|
2017-07-08 17:56:08 +02:00
|
|
|
/* Allocate a new IP forwarding data callback */
|
|
|
|
|
|
net/devif/devif_callback.c: corrected the connection event list to work as FIFO instead of LIFO.
In case of enabled packet forwarding mode, packets were forwarded in a reverse order
because of LIFO behavior of the connection event list.
The issue exposed only during high network traffic. Thus the event list started to grow
that resulted in changing the order of packets inside of groups of several packets
like the following: 3, 2, 1, 6, 5, 4, 8, 7 etc.
Remarks concerning the connection event list implementation:
* Now the queue (list) is FIFO as it should be.
* The list is singly linked.
* The list has a head pointer (inside of outer net_driver_s structure),
and a tail pointer is added into outer net_driver_s structure.
* The list item is devif_callback_s structure.
It still has two pointers to two different list chains (*nxtconn and *nxtdev).
* As before the first argument (*dev) of the list functions can be NULL,
while the other argument (*list) is effective (not NULL).
* An extra (*tail) argument is added to devif_callback_alloc()
and devif_conn_callback_free() functions.
* devif_callback_alloc() time complexity is O(1) (i.e. O(n) to fill the whole list).
* devif_callback_free() time complexity is O(n) (i.e. O(n^2) to empty the whole list).
* devif_conn_event() time complexity is O(n).
2021-08-29 22:57:26 +02:00
|
|
|
#define ipfwd_callback_alloc(dev) devif_callback_alloc(dev, \
|
|
|
|
|
&(dev)->d_conncb, \
|
|
|
|
|
&(dev)->d_conncb_tail)
|
2017-07-08 17:56:08 +02:00
|
|
|
#define ipfwd_callback_free(dev,cb) devif_dev_callback_free(dev, cb)
|
|
|
|
|
|
2017-07-04 18:19:52 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Public Types
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
/* This is the send state structure */
|
|
|
|
|
|
2020-02-22 19:31:14 +01:00
|
|
|
struct devif_callback_s; /* Forward reference */
|
2017-07-05 19:01:16 +02:00
|
|
|
struct net_driver_s; /* Forward reference */
|
|
|
|
|
struct iob_s; /* Forward reference */
|
2017-07-04 18:19:52 +02:00
|
|
|
|
|
|
|
|
struct forward_s
|
|
|
|
|
{
|
2017-07-05 19:01:16 +02:00
|
|
|
FAR struct forward_s *f_flink; /* Supports a singly linked list */
|
|
|
|
|
FAR struct net_driver_s *f_dev; /* Forwarding device */
|
2017-07-07 00:19:10 +02:00
|
|
|
FAR struct iob_s *f_iob; /* IOB chain containing the packet */
|
2017-07-05 19:01:16 +02:00
|
|
|
FAR struct devif_callback_s *f_cb; /* Reference to callback instance */
|
2017-07-08 02:33:06 +02:00
|
|
|
#if defined(CONFIG_NET_IPv4) && defined(CONFIG_NET_IPv6)
|
|
|
|
|
uint8_t f_domain; /* Domain: PF_INET or PF_INET6 */
|
|
|
|
|
#endif
|
2017-07-04 18:19:52 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
|
* Public Function Prototypes
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
2017-07-08 05:32:10 +02:00
|
|
|
struct ipv4_hdr_s; /* Forward reference */
|
|
|
|
|
struct ipv6_hdr_s; /* Forward reference */
|
|
|
|
|
|
2017-07-04 18:19:52 +02:00
|
|
|
/****************************************************************************
|
2017-07-08 02:45:58 +02:00
|
|
|
* Name: ipfwd_initialize
|
2017-07-04 18:19:52 +02:00
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Initialize the struct forward_s allocator.
|
|
|
|
|
*
|
|
|
|
|
* Assumptions:
|
|
|
|
|
* Called early in system initialization.
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
2017-07-08 02:45:58 +02:00
|
|
|
void ipfwd_initialize(void);
|
2017-07-04 18:19:52 +02:00
|
|
|
|
|
|
|
|
/****************************************************************************
|
2017-07-08 02:45:58 +02:00
|
|
|
* Name: ipfwd_alloc
|
2017-07-04 18:19:52 +02:00
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Allocate a forwarding structure by removing a pre-allocated entry from
|
|
|
|
|
* a free list.
|
|
|
|
|
*
|
|
|
|
|
* Assumptions:
|
|
|
|
|
* Caller holds the network lock. Mutually excluvive access to the free
|
|
|
|
|
* list is assured by this lock.
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
2017-07-08 02:45:58 +02:00
|
|
|
FAR struct forward_s *ipfwd_alloc(void);
|
2017-07-04 18:19:52 +02:00
|
|
|
|
|
|
|
|
/****************************************************************************
|
2017-07-08 02:45:58 +02:00
|
|
|
* Name: ipfwd_free
|
2017-07-04 18:19:52 +02:00
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Free a forwarding structure by adding it to a free list.
|
|
|
|
|
*
|
|
|
|
|
* Assumptions:
|
|
|
|
|
* Caller holds the network lock. Mutually excluvive access to the free
|
|
|
|
|
* list is assured by this lock.
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
2017-07-08 02:45:58 +02:00
|
|
|
void ipfwd_free(FAR struct forward_s *fwd);
|
2017-07-04 18:19:52 +02:00
|
|
|
|
2017-07-06 15:26:01 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipv4_forward_broadcast
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* This function is called from ipv4_input when a broadcast or multicast
|
|
|
|
|
* packet is received. If CONFIG_NET_IPFORWARD_BROADCAST is enabled, this
|
|
|
|
|
* function will forward the broadcast packet to other networks through
|
|
|
|
|
* other network devices.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* dev - The device on which the packet was received and which contains
|
|
|
|
|
* the IPv4 packet.
|
|
|
|
|
* ipv4 - A convenience pointer to the IPv4 header in within the IPv4
|
|
|
|
|
* packet
|
|
|
|
|
*
|
|
|
|
|
* On input:
|
|
|
|
|
* - dev->d_buf holds the received packet.
|
|
|
|
|
* - dev->d_len holds the length of the received packet MINUS the
|
|
|
|
|
* size of the L1 header. That was subtracted out by ipv4_input.
|
|
|
|
|
* - ipv4 points to the IPv4 header with dev->d_buf.
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* None
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_NET_IPFORWARD_BROADCAST
|
|
|
|
|
void ipv4_forward_broadcast(FAR struct net_driver_s *dev,
|
|
|
|
|
FAR struct ipv4_hdr_s *ipv4);
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipv6_forward_broadcast
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* This function is called from ipv6_input when a broadcast or multicast
|
|
|
|
|
* packet is received. If CONFIG_NET_IPFORWARD_BROADCAST is enabled, this
|
|
|
|
|
* function will forward the broadcast packet to other networks through
|
|
|
|
|
* other network devices.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* dev - The device on which the packet was received and which contains
|
|
|
|
|
* the IPv6 packet.
|
|
|
|
|
* ipv6 - A convenience pointer to the IPv6 header in within the IPv6
|
|
|
|
|
* packet
|
|
|
|
|
*
|
|
|
|
|
* On input:
|
|
|
|
|
* - dev->d_buf holds the received packet.
|
|
|
|
|
* - dev->d_len holds the length of the received packet MINUS the
|
|
|
|
|
* size of the L1 header. That was subtracted out by ipv6_input.
|
|
|
|
|
* - ipv6 points to the IPv6 header with dev->d_buf.
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* None
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_NET_IPFORWARD_BROADCAST
|
|
|
|
|
void ipv6_forward_broadcast(FAR struct net_driver_s *dev,
|
|
|
|
|
FAR struct ipv6_hdr_s *ipv6);
|
|
|
|
|
#endif
|
|
|
|
|
|
2017-07-05 19:01:16 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: devif_forward
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Called from protocol-specific IP forwarding logic to re-send a packet.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* fwd - An initialized instance of the common forwarding structure that
|
|
|
|
|
* includes everything needed to perform the forwarding operation.
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* None
|
|
|
|
|
*
|
|
|
|
|
* Assumptions:
|
|
|
|
|
* The network is locked.
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
void devif_forward(FAR struct forward_s *fwd);
|
|
|
|
|
|
2017-07-08 04:19:26 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipfwd_forward
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Called by the IP forwarding logic when a packet is received on one
|
|
|
|
|
* network device, but must be forwarded on another network device.
|
|
|
|
|
*
|
|
|
|
|
* Set up to forward the packet on the specified device. This function
|
2017-08-29 22:08:04 +02:00
|
|
|
* will set up a send event handler that will perform the actual send
|
|
|
|
|
* asynchronously and must return without waiting for the send to
|
2017-07-08 04:19:26 +02:00
|
|
|
* complete.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* fwd - An initialized instance of the common forwarding structure that
|
|
|
|
|
* includes everything needed to perform the forwarding operation.
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* Zero is returned if the packet was successfully forwarded; A negated
|
|
|
|
|
* errno value is returned if the packet is not forwardable. In that
|
|
|
|
|
* latter case, the caller should free the IOB list and drop the packet.
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
int ipfwd_forward(FAR struct forward_s *fwd);
|
|
|
|
|
|
2017-07-08 17:56:08 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipfwd_poll
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Poll all pending transfer for ARP requests to send.
|
|
|
|
|
*
|
|
|
|
|
* Assumptions:
|
|
|
|
|
* This function is called from the MAC device driver indirectly through
|
2022-06-05 17:34:03 +02:00
|
|
|
* devif_poll().
|
2017-07-08 17:56:08 +02:00
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
void ipfwd_poll(FAR struct net_driver_s *dev);
|
|
|
|
|
|
2017-07-10 19:37:06 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipfwd_dropstats
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Update statistics for a dropped packet.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* fwd - The forwarding state structure
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* None
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_NET_STATISTICS
|
|
|
|
|
void ipfwd_dropstats(FAR struct forward_s *fwd);
|
|
|
|
|
#else
|
|
|
|
|
# define ipfwd_dropstats(fwd)
|
|
|
|
|
#endif
|
|
|
|
|
|
2017-07-06 15:26:01 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipv4_forward
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* This function is called from ipv4_input when a packet is received that
|
|
|
|
|
* is not destined for us. In this case, the packet may need to be
|
|
|
|
|
* forwarded to another device (or sent back out the same device)
|
|
|
|
|
* depending configuration, routing table information, and the IPv4
|
|
|
|
|
* networks served by various network devices.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* dev - The device on which the packet was received and which contains
|
|
|
|
|
* the IPv4 packet.
|
|
|
|
|
* ipv4 - A convenience pointer to the IPv4 header in within the IPv4
|
|
|
|
|
* packet
|
|
|
|
|
*
|
|
|
|
|
* On input:
|
|
|
|
|
* - dev->d_buf holds the received packet.
|
|
|
|
|
* - dev->d_len holds the length of the received packet MINUS the
|
|
|
|
|
* size of the L1 header. That was subtracted out by ipv4_input.
|
|
|
|
|
* - ipv4 points to the IPv4 header with dev->d_buf.
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* Zero is returned if the packet was successfully forward; A negated
|
|
|
|
|
* errno value is returned if the packet is not forwardable. In that
|
|
|
|
|
* latter case, the caller (ipv4_input()) should drop the packet.
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_NET_IPv4
|
|
|
|
|
int ipv4_forward(FAR struct net_driver_s *dev, FAR struct ipv4_hdr_s *ipv4);
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipv6_forward
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* This function is called from ipv6_input when a packet is received that
|
|
|
|
|
* is not destined for us. In this case, the packet may need to be
|
|
|
|
|
* forwarded to another device (or sent back out the same device)
|
|
|
|
|
* depending configuration, routing table information, and the IPv6
|
|
|
|
|
* networks served by various network devices.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* dev - The device on which the packet was received and which contains
|
|
|
|
|
* the IPv6 packet.
|
|
|
|
|
* ipv6 - A convenience pointer to the IPv6 header in within the IPv6
|
|
|
|
|
* packet
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* Zero is returned if the packet was successfully forward; A negated
|
|
|
|
|
* errno value is returned if the packet is not forwardable. In that
|
|
|
|
|
* latter case, the caller (ipv6_input()) should drop the packet.
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_NET_IPv6
|
|
|
|
|
int ipv6_forward(FAR struct net_driver_s *dev, FAR struct ipv6_hdr_s *ipv6);
|
|
|
|
|
#endif
|
|
|
|
|
|
2017-07-08 04:19:26 +02:00
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipv6_dropstats
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Update statistics for a dropped Ipv6 packet.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* ipv6 - A pointer to the IPv6 header in within the IPv6 packet to be
|
|
|
|
|
* dropped.
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* None
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#if defined(CONFIG_NET_STATISTICS) && defined(CONFIG_NET_IPv6)
|
|
|
|
|
void ipv6_dropstats(FAR struct ipv6_hdr_s *ipv6);
|
|
|
|
|
#else
|
|
|
|
|
# define ipv6_dropstats(ipv6)
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
|
* Name: ipv4_dropstats
|
|
|
|
|
*
|
|
|
|
|
* Description:
|
|
|
|
|
* Update statistics for a dropped Ipv4 packet.
|
|
|
|
|
*
|
|
|
|
|
* Input Parameters:
|
|
|
|
|
* ipv4 - A pointer to the IPv4 header in within the IPv4 packet to be
|
|
|
|
|
* dropped.
|
|
|
|
|
*
|
|
|
|
|
* Returned Value:
|
|
|
|
|
* None
|
|
|
|
|
*
|
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#if defined(CONFIG_NET_STATISTICS) && defined(CONFIG_NET_IPv4)
|
|
|
|
|
void ipv4_dropstats(FAR struct ipv4_hdr_s *ipv4);
|
|
|
|
|
#else
|
|
|
|
|
# define ipv4_dropstats(ipv4)
|
|
|
|
|
#endif
|
|
|
|
|
|
2017-07-06 15:26:01 +02:00
|
|
|
#endif /* CONFIG_NET_IPFORWARD */
|
2017-07-08 02:45:58 +02:00
|
|
|
#endif /* __NET_IPFORWARD_IPFORWARD_H */
|
