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/route/cacheroute.h

131 lines
4.1 KiB
C
Raw Normal View History

Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
/****************************************************************************
* net/route/cacheroute.h
*
net: migrate to SPDX identifier Most tools used for compliance and SBOM generation use SPDX identifiers This change brings us a step closer to an easy SBOM generation. Signed-off-by: Alin Jerpelea <alin.jerpelea@sony.com>
2024-09-11 20:39:39 +08:00
* SPDX-License-Identifier: Apache-2.0
*
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
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
*
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
* http://www.apache.org/licenses/LICENSE-2.0
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
*
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
* 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.
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
*
****************************************************************************/
#ifndef __NET_ROUTE_CACHEROUTE_H
Refine the preprocessor conditional guard style (#190)
2020-02-01 02:07:39 +08:00
#define __NET_ROUTE_CACHEROUTE_H
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include "route/route.h"
#if defined(CONFIG_ROUTE_IPv4_CACHEROUTE) || defined(CONFIG_ROUTE_IPv6_CACHEROUTE)
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: net_init_cacheroute
*
* Description:
* Initialize the in-memory, routing table cache
*
Standardization of some function headers.
2018-03-13 23:52:27 +08:00
* Input Parameters:
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
* None
*
* Returned Value:
* None
*
* Assumptions:
* Called early in initialization so that no special protection is needed.
*
****************************************************************************/
void net_init_cacheroute(void);
/****************************************************************************
* Name: net_addcache_ipv4 and net_addcache_ipv6
*
* Description:
* Add one route to the routing table cache
*
Standardization of some function headers.
2018-03-13 23:52:27 +08:00
* Input Parameters:
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
* None
*
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned
* on any failure.
*
****************************************************************************/
#ifdef CONFIG_ROUTE_IPv4_CACHEROUTE
int net_addcache_ipv4(FAR struct net_route_ipv4_s *route);
#endif
#ifdef CONFIG_ROUTE_IPv6_CACHEROUTE
int net_addcache_ipv6(FAR struct net_route_ipv6_s *route);
#endif
/****************************************************************************
* Name: net_foreachcache_ipv4/net_foreachcache_ipv6
*
* Description:
Run codespell -w with the latest dictonary again Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-02-23 16:50:23 +08:00
* Traverse the routing table cache
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
*
Standardization of some function headers.
2018-03-13 23:52:27 +08:00
* Input Parameters:
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
* handler - Will be called for each route in the routing table cache.
Fix typos (and nxstyle errors) ReleaseNotes, arch/arm/src/cxd56xx/cxd56_dmac_common.h, arch/arm/src/efm32/efm32_dma.h, arch/arm/src/lpc54xx/lpc54_lcd.c, arch/arm/src/rp2040/rp2040_dmac.h, arch/arm/src/stm32/stm32_dma.h, arch/arm/src/stm32f0l0g0/stm32_dma.h, arch/arm/src/stm32f7/stm32_dma.h, arch/arm/src/stm32h7/stm32_dma.h, arch/arm/src/stm32l4/stm32l4_dma.h, arch/renesas/src/rx65n/rx65n_dtc.h, fs/spiffs/src/spiffs_vfs.c, net/route/cacheroute.h, net/route/net_cacheroute.c, net/route/net_foreach_fileroute.c, net/route/net_foreach_ramroute.c, net/route/net_foreach_romroute.c, and net/route/route.h: * Fix the following typos: - remove spurious "are" - "tot he" -> "to the" arch/arm/src/stm32f0l0g0/stm32_dma.h and arch/arm/src/stm32l4/stm32l4_dma.h: * Fix nxstyle errors.
2021-03-22 01:07:36 +08:00
* arg - An arbitrary value that will be passed to the handler.
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
*
* Returned Value:
* Zero (OK) returned if the entire table was searched. A negated errno
* value will be returned in the event of a failure. Handlers may also
* terminate the search early with any non-zero value.
*
****************************************************************************/
#ifdef CONFIG_ROUTE_IPv4_CACHEROUTE
int net_foreachcache_ipv4(route_handler_ipv4_t handler, FAR void *arg);
#endif
#ifdef CONFIG_ROUTE_IPv6_CACHEROUTE
int net_foreachcache_ipv6(route_handler_ipv6_t handler, FAR void *arg);
#endif
/****************************************************************************
* Name: net_flushcache_ipv4 and net_flushcache_ipv6
*
* Description:
* Flush the content of the routing table cache
*
Standardization of some function headers.
2018-03-13 23:52:27 +08:00
* Input Parameters:
Add support for an in-memory routing table cache in order to improve performance when the routing table is retained in a file. The cache holds the most recently used routing table entries and so can eliminate some file access. Squashed commit of the following: net/route: Flush in cache when any entry is deleted from the routing table. When a router matching an IP address is found, add the routing table entry to the cache. net/route: Add utility functions to manage an in-memory cache to improve performance when use a file-based routing table.
2017-09-30 02:04:45 +08:00
* None
*
* Returned Value:
* None
*
****************************************************************************/
#ifdef CONFIG_ROUTE_IPv4_CACHEROUTE
void net_flushcache_ipv4(void);
#endif
#ifdef CONFIG_ROUTE_IPv6_CACHEROUTE
void net_flushcache_ipv6(void);
#endif
#endif /* CONFIG_ROUTE_IPv4_CACHEROUTE || CONFIG_ROUTE_IPv6_CACHEROUTE */
#endif /* __NET_ROUTE_CACHEROUTE_H */