/**************************************************************************** * net/route/net_router.c * * Copyright (C) 2013-2015 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 #include #include "devif/devif.h" #include "route/route.h" #if defined(CONFIG_NET) && defined(CONFIG_NET_ROUTE) /**************************************************************************** * Public Types ****************************************************************************/ #ifdef CONFIG_NET_IPv4 struct route_ipv4_match_s { in_addr_t target; /* Target IPv4 address on an external network to match */ in_addr_t router; /* IPv4 address of the router on one of our networks */ }; #endif #ifdef CONFIG_NET_IPv6 struct route_ipv6_match_s { net_ipv6addr_t target; /* Target IPv6 address on an external network to match */ net_ipv6addr_t router; /* IPv6 address of the router on one of our networks */ }; #endif /**************************************************************************** * Private Functions ****************************************************************************/ /**************************************************************************** * Name: net_ipv4_match * * Description: * Return 1 if the IPv4 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. * ****************************************************************************/ #ifdef CONFIG_NET_IPv4 static int net_ipv4_match(FAR struct net_route_ipv4_s *route, FAR void *arg) { FAR struct route_ipv4_match_s *match = (FAR struct route_ipv4_match_s *)arg; /* To match, the masked target addresses must be the same. In the event * of multiple matches, only the first is returned. There is not (yet) any * concept for the precedence of networks. */ if (net_ipv4addr_maskcmp(route->target, match->target, route->netmask)) { /* They match.. Copy the router address */ net_ipv4addr_copy(match->router, route->router); return 1; } return 0; } #endif /* CONFIG_NET_IPv4 */ /**************************************************************************** * Name: net_ipv6_match * * Description: * Return 1 if the IPv6 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. * ****************************************************************************/ #ifdef CONFIG_NET_IPv6 static int net_ipv6_match(FAR struct net_route_ipv6_s *route, FAR void *arg) { FAR struct route_ipv6_match_s *match = (FAR struct route_ipv6_match_s *)arg; /* To match, the masked target addresses must be the same. In the event * of multiple matches, only the first is returned. There is not (yet) any * concept for the precedence of networks. */ if (net_ipv6addr_maskcmp(route->target, match->target, route->netmask)) { /* They match.. Copy the router address */ net_ipv6addr_copy(match->router, route->router); return 1; } return 0; } #endif /* CONFIG_NET_IPv6 */ /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * Name: net_ipv4_router * * Description: * Given an IPv4 address on a external network, return the address of the * router on a local network that can forward to the external network. * * Parameters: * target - An IPv4 address on a remote network to use in the lookup. * router - The address of router on a local network that can forward our * packets to the target. * * Returned Value: * OK on success; Negated errno on failure. * ****************************************************************************/ #ifdef CONFIG_NET_IPv4 int net_ipv4_router(in_addr_t target, FAR in_addr_t *router) { struct route_ipv4_match_s match; int ret; /* Do not route the special broadcast IP address */ if (net_ipv4addr_cmp(target, INADDR_BROADCAST)) { return -ENOENT; } /* Set up the comparison structure */ memset(&match, 0, sizeof(struct route_ipv4_match_s)); net_ipv4addr_copy(match.target, target); /* Find an router entry with the routing table that can forward to this * address */ ret = net_foreachroute_ipv4(net_ipv4_match, &match); if (ret > 0) { /* We found a route. Return the router address. */ net_ipv4addr_copy(*router, match.router); ret = OK; } else { /* There is no route for this address */ ret = -ENOENT; } return ret; } #endif /* CONFIG_NET_IPv4 */ /**************************************************************************** * Name: net_ipv6_router * * Description: * Given an IPv6 address on a external network, return the address of the * router on a local network that can forward to the external network. * * Parameters: * target - An IPv6 address on a remote network to use in the lookup. * router - The address of router on a local network that can forward our * packets to the target. * * Returned Value: * OK on success; Negated errno on failure. * ****************************************************************************/ #ifdef CONFIG_NET_IPv6 int net_ipv6_router(const net_ipv6addr_t target, net_ipv6addr_t router) { struct route_ipv6_match_s match; int ret; /* Do not route to any the special IPv6 multicast addresses */ if (target[0] == HTONS(0xff02)) { return -ENOENT; } /* Set up the comparison structure */ memset(&match, 0, sizeof(struct route_ipv6_match_s)); net_ipv6addr_copy(match.target, target); /* Find an router entry with the routing table that can forward to this * address */ ret = net_foreachroute_ipv6(net_ipv6_match, &match); if (ret > 0) { /* We found a route. Return the router address. */ net_ipv6addr_copy(router, match.router); ret = OK; } else { /* There is no route for this address */ ret = -ENOENT; } return ret; } #endif /* CONFIG_NET_IPv6 */ #endif /* CONFIG_NET && CONFIG_NET_ROUTE */