From b4e9e42b45494e19fd131ea02e2c01745de855a5 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Tue, 1 Oct 2013 18:55:20 -0600 Subject: Partial implementation of a simple network routing table. --- nuttx/ChangeLog | 3 + nuttx/include/nuttx/net/route.h | 162 ++++++++++++++++++++++++++++++++++++++++ nuttx/net/net_addroute.c | 120 +++++++++++++++++++++++++++++ nuttx/net/net_delroute.c | 132 ++++++++++++++++++++++++++++++++ nuttx/net/net_findroute.c | 132 ++++++++++++++++++++++++++++++++ nuttx/net/net_foreachroute.c | 97 ++++++++++++++++++++++++ 6 files changed, 646 insertions(+) create mode 100644 nuttx/include/nuttx/net/route.h create mode 100644 nuttx/net/net_addroute.c create mode 100644 nuttx/net/net_delroute.c create mode 100644 nuttx/net/net_findroute.c create mode 100644 nuttx/net/net_foreachroute.c diff --git a/nuttx/ChangeLog b/nuttx/ChangeLog index ca448cd4a..d130c9cf0 100644 --- a/nuttx/ChangeLog +++ b/nuttx/ChangeLog @@ -5688,4 +5688,7 @@ now functional. From Max Holtzberg (2013-9-30). * tools/define.sh: 'cut' long because as it once did. Script adapted to observed behavior (2013-9-30). + * include/nuttx/net/route.h and net/net_*route.c: Partial + implementation of a routing table. Not yet hooked into the + build system (2013-10-1) diff --git a/nuttx/include/nuttx/net/route.h b/nuttx/include/nuttx/net/route.h new file mode 100644 index 000000000..9fa761726 --- /dev/null +++ b/nuttx/include/nuttx/net/route.h @@ -0,0 +1,162 @@ +/**************************************************************************** + * include/nuttx/net/route.h + * + * Copyright (C) 2013 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * 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 __INCLUDE_NUTTX_NET_ROUTE_H +#define __INCLUDE_NUTTX_NET_ROUTE_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include +#include + +#ifdef CONFIG_NET_ROUTE + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ +/* Configuration ************************************************************/ + +#ifndef CONFIG_NET_MAXROUTES +# define CONFIG_NET_MAXROUTES 4 +#endif + +/**************************************************************************** + * Public Types + ****************************************************************************/ +/* This structure describes one entry in the routing table */ + +struct net_route_s +{ + bool inuse; /* TRUE: This entry contains a valid route */ + uint8_t minor; /* Ethernet device minor */ + uip_ipaddr_t target; /* The destination network */ + uip_ipaddr_t netmask; /* The network address mask */ + uip_ipaddr_t gateway; /* Route packets via a gateway */ +}; + +/* Type of the call out function pointer provided to net_foreachroute() */ + +typedef int (*route_handler_t)(FAR struct net_route_s *route, FAR void *arg); + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +#ifdef __cplusplus +#define EXTERN extern "C" +extern "C" +{ +#else +#define EXTERN extern +#endif + +/* This is the routing table */ + +EXTERN struct net_route_s g_routes[CONFIG_NET_MAXROUTES]; + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ + +/**************************************************************************** + * Function: net_addroute + * + * Description: + * Add a new route to the routing table + * + * Parameters: + * + * Returned Value: + * OK on success; Negated errno on failure. + * + ****************************************************************************/ + +int net_addroute(uip_ipaddr_t target, uip_ipaddr_t netmask, + uip_ipaddr_t gateway, int devno); + +/**************************************************************************** + * Function: net_delroute + * + * Description: + * Remove an existing route from the routing table + * + * Parameters: + * + * Returned Value: + * OK on success; Negated errno on failure. + * + ****************************************************************************/ + +int net_delroute(uip_ipaddr_t target, uip_ipaddr_t netmask); + +/**************************************************************************** + * Function: net_findroute + * + * Description: + * Given an IP address, return a copy of the routing table contents + * + * Parameters: + * + * Returned Value: + * OK on success; Negated errno on failure. + * + ****************************************************************************/ + +int net_findroute(uip_ipaddr_t target, FAR struct net_route_s *route); + +/**************************************************************************** + * Function: net_foreachroute + * + * Description: + * Traverse the route table + * + * Parameters: + * + * Returned Value: + * OK on success; Negated errno on failure. + * + ****************************************************************************/ + +int net_foreachroute(route_handler_t handler, FAR void *arg); + +#undef EXTERN +#ifdef __cplusplus +} +#endif + +#endif /* CONFIG_NET_ROUTE */ +#endif /* __INCLUDE_NUTTX_NET_ROUTE_H */ diff --git a/nuttx/net/net_addroute.c b/nuttx/net/net_addroute.c new file mode 100644 index 000000000..fd4e7de9a --- /dev/null +++ b/nuttx/net/net_addroute.c @@ -0,0 +1,120 @@ +/**************************************************************************** + * net/net_addroute.c + * + * Copyright (C) 2013 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * 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 + +#include +#include + +#include + +#include "net_internal.h" + +#if defined(CONFIG_NET) && defined(CONFIG_NET_ROUTE) + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +/**************************************************************************** + * Private Functions + ****************************************************************************/ + +/**************************************************************************** + * Function: net_available + * + * Description: + * Return 1 if the route is available + * + * Parameters: + * route - The next route to examine + * arg - The new route entry (cast to void*) + * + * Returned Value: + * OK on success; Negated errno on failure. + * + ****************************************************************************/ + +static int net_available(FAR struct net_route_s *route, FAR void *arg) +{ + if (!route->inuse) + { + memcpy(route, arg, sizeof(struct net_route_s)); + return 1; + } + + return 0; +} + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Function: net_addroute + * + * Description: + * Add a new route to the routing table + * + * Parameters: + * + * Returned Value: + * OK on success; Negated errno on failure. + * + ****************************************************************************/ + +int net_addroute(uip_ipaddr_t target, uip_ipaddr_t netmask, + uip_ipaddr_t gateway, int devno) +{ + struct net_route_s route; + + /* Format the new route table entry */ + + route.inuse = true; + route.minor = devno; + uip_ipaddr_copy(route.target, target); + uip_ipaddr_copy(route.netmask, netmask); + uip_ipaddr_copy(route.gateway, gateway); + + /* Then add the new entry to the table */ + + return net_foreachroute(net_available, &route) ? OK : -EAGAIN; +} + +#endif /* CONFIG_NET && CONFIG_NET_SOCKOPTS && !CONFIG_DISABLE_CLOCK */ diff --git a/nuttx/net/net_delroute.c b/nuttx/net/net_delroute.c new file mode 100644 index 000000000..08d9ad154 --- /dev/null +++ b/nuttx/net/net_delroute.c @@ -0,0 +1,132 @@ +/**************************************************************************** + * net/net_delroute.c + * + * Copyright (C) 2013 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * 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 + +#include +#include + +#include + +#include "net_internal.h" + +#if defined(CONFIG_NET) && defined(CONFIG_NET_ROUTE) + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +struct route_match_s +{ + uip_ipaddr_t target; /* The target IP address to match */ + FAR struct net_route_s *route; /* The location to return the route */ +}; + +/**************************************************************************** + * Private Functions + ****************************************************************************/ + +/**************************************************************************** + * Function: net_match + * + * Description: + * Return 1 if the route is available + * + * Parameters: + * route - The next route to examine + * arg - The match values (cast to void*) + * + * Returned Value: + * 0 if the entry is not a match; 1 if the entry matched and was cleared. + * + ****************************************************************************/ + +static int net_match(FAR struct net_route_s *route, FAR void *arg) +{ + FAR struct route_match_s *match = ( FAR struct route_match_s *)arg; + + /* To match, the entry has to be in use, the masked target addresses must + * be the same. In the event of multiple matches, only the first is + * returned. + */ + + if (route->inuse && + uip_ipaddr_maskcmp(route->target, match->target, route>netmask)) + { + /* They match.. clear the route table entry */ + + memcpy(match->route, route, sizeof(struct net_route_s)); + return 1; + } + + return 0; +} + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Function: net_findroute + * + * Description: + * Given an IP address, return a copy of the routing table contents + * + * Parameters: + * + * Returned Value: + * OK on success; Negated errno on failure. + * + ****************************************************************************/ + +int net_findroute(uip_ipaddr_t target, FAR struct net_route_s *route); +{ + struct route_match_s match; + + /* Set up the comparison structure */ + + uip_ipaddr_copy(match.target, target); + uip_ipaddr_copy(match.netmask, netmask); + + /* Then remove the entry from the routing table */ + + return net_foreachroute(net_match, &match) ? OK : -ENOENT; +} + +#endif /* CONFIG_NET && CONFIG_NET_ROUTE */ diff --git a/nuttx/net/net_findroute.c b/nuttx/net/net_findroute.c new file mode 100644 index 000000000..252f9a098 --- /dev/null +++ b/nuttx/net/net_findroute.c @@ -0,0 +1,132 @@ +/**************************************************************************** + * net/net_delroute.c + * + * Copyright (C) 2013 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * 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 + +#include +#include + +#include + +#include "net_internal.h" + +#if defined(CONFIG_NET) && defined(CONFIG_NET_ROUTE) + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +struct route_match_s +{ + uip_ipaddr_t target; /* The target IP address to match */ + uip_ipaddr_t netmask; /* The network mask to match */ +}; + +/**************************************************************************** + * Private Functions + ****************************************************************************/ + +/**************************************************************************** + * Function: net_match + * + * Description: + * Return 1 if the route is available + * + * Parameters: + * route - The next route to examine + * arg - The match values (cast to void*) + * + * Returned Value: + * 0 if the entry is not a match; 1 if the entry matched and was cleared. + * + ****************************************************************************/ + +static int net_match(FAR struct net_route_s *route, FAR void *arg) +{ + FAR struct route_match_s *match = ( FAR struct route_match_s *)arg; + + /* To match, the entry has to be in use, the masked target address must + * be the same, and the masks must be the same. + */ + + if (route->inuse && + uip_ipaddr_maskcmp(route->target, match->target, match->netmask) && + uip_ipaddr_cmp(route->target, match->netmask)) + { + /* They match.. clear the route table entry */ + + memset(route, 0, sizeof(struct net_route_s)); + return 1; + } + + return 0; +} + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Function: net_delroute + * + * Description: + * Remove an existing route from the routing table + * + * Parameters: + * + * Returned Value: + * OK on success; Negated errno on failure. + * + ****************************************************************************/ + +int net_delroute(uip_ipaddr_t target, uip_ipaddr_t netmask); +{ + struct route_match_s match; + + /* Set up the comparison structure */ + + uip_ipaddr_copy(match.target, target); + uip_ipaddr_copy(match.netmask, netmask); + + /* Then remove the entry from the routing table */ + + return net_foreachroute(net_match, &match) ? OK : -ENOENT; +} + +#endif /* CONFIG_NET && CONFIG_NET_SOCKOPTS && !CONFIG_DISABLE_CLOCK */ diff --git a/nuttx/net/net_foreachroute.c b/nuttx/net/net_foreachroute.c new file mode 100644 index 000000000..4c82a688b --- /dev/null +++ b/nuttx/net/net_foreachroute.c @@ -0,0 +1,97 @@ +/**************************************************************************** + * net/net_foreachroute.c + * + * Copyright (C) 2013 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * 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 + +#include +#include + +#include + +#include "net_internal.h" + +#if defined(CONFIG_NET) && defined(CONFIG_NET_ROUTE) + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +/* This is the routing table */ + +struct net_route_s g_routes[CONFIG_NET_MAXROUTES]; + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Function: net_foreachroute + * + * Description: + * Traverse the route table + * + * Parameters: + * + * Returned Value: + * 0 if in use; 1 if avaialble and the new entry was added + * + ****************************************************************************/ + +int net_foreachroute(route_handler_t handler, FAR void *arg) +{ + uip_lock_t save; + int ret = 0; + int i; + + /* Prevent concurrent access to the routing table */ + + save = uip_lock(); + + for (i = 0; i < CONFIG_NET_MAXROUTES && ret == 0; i++) + { + ret = handler(&g_route[i], arg); + } + + /* Unlock uIP */ + + uip_unlock(save); + return ret; +} + +#endif /* CONFIG_NET && CONFIG_NET_SOCKOPTS && !CONFIG_DISABLE_CLOCK */ -- cgit v1.2.3