236 lines
7.4 KiB
C
236 lines
7.4 KiB
C
/****************************************************************************
|
|
* net/route/ramroute.h
|
|
*
|
|
* Copyright (C) 2017 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __NET_ROUTE_RAMROUTE_H
|
|
#define __NET_ROUTE_RAMROUTE_H 1
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include "route/route.h"
|
|
|
|
#if defined(CONFIG_ROUTE_IPv4_RAMROUTE) || defined(CONFIG_ROUTE_IPv6_RAMROUTE)
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* Configuration ************************************************************/
|
|
|
|
#ifndef CONFIG_ROUTE_MAX_IPv4_RAMROUTES
|
|
# define CONFIG_ROUTE_MAX_IPv4_RAMROUTES 4
|
|
#endif
|
|
|
|
#ifndef CONFIG_ROUTE_MAX_IPv6_RAMROUTES
|
|
# define CONFIG_ROUTE_MAX_IPv6_RAMROUTES 4
|
|
#endif
|
|
|
|
/* Routing table initializer */
|
|
|
|
#define ramroute_init(rr) \
|
|
do \
|
|
{ \
|
|
(rr)->head = NULL; \
|
|
(rr)->tail = NULL; \
|
|
} \
|
|
while (0) \
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ROUTE_IPv4_RAMROUTE
|
|
/* This structure describes one entry in the routing table */
|
|
|
|
struct net_route_ipv4_entry_s
|
|
{
|
|
struct net_route_ipv4_s entry;
|
|
FAR struct net_route_ipv4_entry_s *flink;
|
|
};
|
|
|
|
/* This structure describes the head of a routing table list */
|
|
|
|
struct net_route_ipv4_queue_s
|
|
{
|
|
FAR struct net_route_ipv4_entry_s *head;
|
|
FAR struct net_route_ipv4_entry_s *tail;
|
|
};
|
|
#endif
|
|
|
|
#ifdef CONFIG_ROUTE_IPv6_RAMROUTE
|
|
/* This structure describes one entry in the routing table */
|
|
|
|
struct net_route_ipv6_entry_s
|
|
{
|
|
struct net_route_ipv6_s entry;
|
|
FAR struct net_route_ipv6_entry_s *flink;
|
|
};
|
|
|
|
/* This structure describes the head of a routing table list */
|
|
|
|
struct net_route_ipv6_queue_s
|
|
{
|
|
FAR struct net_route_ipv6_entry_s *head;
|
|
FAR struct net_route_ipv6_entry_s *tail;
|
|
};
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
/* These are the routing tables */
|
|
|
|
#if defined(CONFIG_ROUTE_IPv4_RAMROUTE)
|
|
/* The in-memory routing tables are represented as singly linked lists. */
|
|
|
|
extern struct net_route_ipv4_queue_s g_ipv4_routes;
|
|
#endif
|
|
|
|
#if defined(CONFIG_ROUTE_IPv6_RAMROUTE)
|
|
/* The in-memory routing tables are represented as singly linked lists. */
|
|
|
|
extern struct net_route_ipv6_queue_s g_ipv6_routes;
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: net_init_ramroute
|
|
*
|
|
* Description:
|
|
* Initialize the in-memory, RAM routing table
|
|
*
|
|
* Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
* Assumptions:
|
|
* Called early in initialization so that no special protection is needed.
|
|
*
|
|
****************************************************************************/
|
|
|
|
void net_init_ramroute(void);
|
|
|
|
/****************************************************************************
|
|
* Name: net_allocroute_ipv4 and net_allocroute_ipv6
|
|
*
|
|
* Description:
|
|
* Allocate one route by removing it from the free list
|
|
*
|
|
* Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* On success, a pointer to the newly allocated routing table entry is
|
|
* returned; NULL is returned on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ROUTE_IPv4_RAMROUTE
|
|
FAR struct net_route_ipv4_s *net_allocroute_ipv4(void);
|
|
#endif
|
|
|
|
#ifdef CONFIG_ROUTE_IPv6_RAMROUTE
|
|
FAR struct net_route_ipv6_s *net_allocroute_ipv6(void);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: net_freeroute_ipv4 and net_freeroute_ipv6
|
|
*
|
|
* Description:
|
|
* Free one route by adding it from the free list
|
|
*
|
|
* Parameters:
|
|
* route - The route to be freed
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ROUTE_IPv4_RAMROUTE
|
|
void net_freeroute_ipv4(FAR struct net_route_ipv4_s *route);
|
|
#endif
|
|
|
|
#ifdef CONFIG_ROUTE_IPv6_RAMROUTE
|
|
void net_freeroute_ipv6(FAR struct net_route_ipv6_s *route);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: (various low-level list operations)
|
|
*
|
|
* Description:
|
|
* Perform operations on in-memory routing table lists
|
|
*
|
|
* Parameters:
|
|
* entry - A pointer to the new entry to add to the list
|
|
* list - The list to be used.
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_ROUTE_IPv4_RAMROUTE
|
|
void ramroute_ipv4_addlast(FAR struct net_route_ipv4_entry_s *entry,
|
|
FAR struct net_route_ipv4_queue_s *list);
|
|
FAR struct net_route_ipv4_entry_s *
|
|
ramroute_ipv4_remfirst(struct net_route_ipv4_queue_s *list);
|
|
FAR struct net_route_ipv4_entry_s *
|
|
ramroute_ipv4_remafter(FAR struct net_route_ipv4_entry_s *entry,
|
|
FAR struct net_route_ipv4_queue_s *list);
|
|
#endif
|
|
|
|
#ifdef CONFIG_ROUTE_IPv6_RAMROUTE
|
|
void ramroute_ipv6_addlast(FAR struct net_route_ipv6_entry_s *entry,
|
|
FAR struct net_route_ipv6_queue_s *list);
|
|
FAR struct net_route_ipv6_entry_s *
|
|
ramroute_ipv6_remfirst(struct net_route_ipv6_queue_s *list);
|
|
FAR struct net_route_ipv6_entry_s *
|
|
ramroute_ipv6_remafter(FAR struct net_route_ipv6_entry_s *entry,
|
|
struct net_route_ipv6_queue_s *list);
|
|
#endif
|
|
|
|
#endif /* CONFIG_ROUTE_IPv4_RAMROUTE || CONFIG_ROUTE_IPv6_RAMROUTE */
|
|
#endif /* __NET_ROUTE_RAMROUTE_H */
|