/**************************************************************************** * net/netlink/netlink_route.c * * Copyright (C) 2019 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 #include #include #include #include #include #include #include "netdev/netdev.h" #include "arp/arp.h" #include "neighbor/neighbor.h" #include "route/route.h" #include "netlink/netlink.h" #ifdef CONFIG_NETLINK_ROUTE /**************************************************************************** * Pre-processor Definitions ****************************************************************************/ /* Configuration ************************************************************/ #if !defined(CONFIG_NET_ARP) && !defined(CONFIG_NET_IPv6) # undef CONFIG_NETLINK_DISABLE_GETNEIGH # define CONFIG_NETLINK_DISABLE_GETNEIGH 1 #endif #if !defined(CONFIG_NET_ROUTE) || (!defined(CONFIG_NET_IPv4) && \ !defined(CONFIG_NET_IPv6)) # undef CONFIG_NETLINK_DISABLE_GETROUTE # define CONFIG_NETLINK_DISABLE_GETROUTE 1 #endif /**************************************************************************** * Private Types ****************************************************************************/ /* RTM_GETLINK: Enumerate network devices */ struct getlink_recvfrom_response_s { struct nlmsghdr hdr; struct ifinfomsg iface; struct rtattr attr; uint8_t data[IFNAMSIZ]; /* IFLA_IFNAME is the only attribute supported */ }; struct getlink_recvfrom_rsplist_s { sq_entry_t flink; struct getlink_recvfrom_response_s payload; }; /* RTM_GETNEIGH: Get neighbor table entry */ struct getneigh_recvfrom_response_s { struct nlmsghdr hdr; struct ndmsg msg; struct rtattr attr; uint8_t data[1]; }; #define SIZEOF_NLROUTE_RECVFROM_RESPONSE_S(n) \ (sizeof(struct getneigh_recvfrom_response_s) + (n) - 1) struct getneigh_recvfrom_rsplist_s { sq_entry_t flink; struct getneigh_recvfrom_response_s payload; }; #define SIZEOF_NLROUTE_RECVFROM_RSPLIST_S(n) \ (sizeof(struct getneigh_recvfrom_rsplist_s) + (n) - 1) /* RTM_GETROUTE. Get routing tables */ struct getroute_recvfrom_ipv4addr_s { struct rtattr attr; in_addr_t addr; }; struct getroute_recvfrom_ipv4response_s { struct nlmsghdr hdr; struct rtmsg rte; struct getroute_recvfrom_ipv4addr_s dst; struct getroute_recvfrom_ipv4addr_s genmask; struct getroute_recvfrom_ipv4addr_s gateway; }; struct getroute_recvfrom_ipv4resplist_s { sq_entry_t flink; struct getroute_recvfrom_ipv4response_s payload; }; struct getroute_recvfrom_ipv6addr_s { struct rtattr attr; net_ipv6addr_t addr; }; struct getroute_recvfrom_ipv6response_s { struct nlmsghdr hdr; struct rtmsg rte; struct getroute_recvfrom_ipv6addr_s dst; struct getroute_recvfrom_ipv6addr_s genmask; struct getroute_recvfrom_ipv6addr_s gateway; }; struct getroute_recvfrom_ipv6resplist_s { sq_entry_t flink; struct getroute_recvfrom_ipv6response_s payload; }; /* netdev_foreach() callback */ struct nlroute_sendto_request_s { struct nlmsghdr hdr; struct rtgenmsg gen; }; struct nlroute_info_s { NETLINK_HANDLE handle; FAR const struct nlroute_sendto_request_s *req; }; /**************************************************************************** * Private Functions ****************************************************************************/ /**************************************************************************** * Name: netlink_get_device * * Description: * Generate one device response. * ****************************************************************************/ #ifndef CONFIG_NETLINK_DISABLE_GETLINK static FAR struct netlink_response_s * netlink_get_device(FAR struct net_driver_s *dev, FAR const struct nlroute_sendto_request_s *req) { FAR struct getlink_recvfrom_rsplist_s *alloc; FAR struct getlink_recvfrom_response_s *resp; int up = IFF_IS_UP(dev->d_flags); /* Allocate the response buffer */ alloc = (FAR struct getlink_recvfrom_rsplist_s *) kmm_zalloc(sizeof(struct getlink_recvfrom_rsplist_s)); if (alloc == NULL) { nerr("ERROR: Failed to allocate response buffer.\n"); return NULL; } /* Initialize the response buffer */ resp = &alloc->payload; resp->hdr.nlmsg_len = sizeof(struct getlink_recvfrom_response_s); resp->hdr.nlmsg_type = up ? RTM_NEWLINK : RTM_DELLINK; resp->hdr.nlmsg_flags = req ? req->hdr.nlmsg_flags : 0; resp->hdr.nlmsg_seq = req ? req->hdr.nlmsg_seq : 0; resp->hdr.nlmsg_pid = req ? req->hdr.nlmsg_pid : 0; resp->iface.ifi_family = req ? req->gen.rtgen_family : AF_PACKET; resp->iface.ifi_type = dev->d_lltype; #ifdef CONFIG_NETDEV_IFINDEX resp->iface.ifi_index = dev->d_ifindex; #endif resp->iface.ifi_flags = dev->d_flags; resp->iface.ifi_change = 0xffffffff; resp->attr.rta_len = RTA_LENGTH(strnlen(dev->d_ifname, IFNAMSIZ)); resp->attr.rta_type = IFLA_IFNAME; strncpy((FAR char *)resp->data, dev->d_ifname, IFNAMSIZ); /* Finally, return the response */ return (FAR struct netlink_response_s *)alloc; } #endif /**************************************************************************** * Name: netlink_get_terminator * * Description: * Generate one NLMSG_DONE response. * ****************************************************************************/ static FAR struct netlink_response_s * netlink_get_terminator(FAR const struct nlroute_sendto_request_s *req) { FAR struct netlink_response_s *resp; FAR struct nlmsghdr *hdr; /* Allocate the list terminator */ resp = kmm_zalloc(sizeof(struct netlink_response_s)); if (resp == NULL) { nerr("ERROR: Failed to allocate response terminator.\n"); return NULL; } /* Initialize and send the list terminator */ hdr = &resp->msg; hdr->nlmsg_len = sizeof(struct nlmsghdr); hdr->nlmsg_type = NLMSG_DONE; hdr->nlmsg_flags = req ? req->hdr.nlmsg_flags : 0; hdr->nlmsg_seq = req ? req->hdr.nlmsg_seq : 0; hdr->nlmsg_pid = req ? req->hdr.nlmsg_pid : 0; /* Finally, return the response */ return resp; } /**************************************************************************** * Name: netlink_add_terminator * * Description: * Add one NLMSG_DONE response to handle. * ****************************************************************************/ static int netlink_add_terminator(NETLINK_HANDLE handle, FAR const struct nlroute_sendto_request_s *req) { FAR struct netlink_response_s * resp; resp = netlink_get_terminator(req); if (resp == NULL) { return -ENOMEM; } netlink_add_response(handle, resp); return OK; } /**************************************************************************** * Name: netlink_get_devlist * * Description: * Dump a list of all network devices of the specified type. * ****************************************************************************/ #ifndef CONFIG_NETLINK_DISABLE_GETLINK static int netlink_device_callback(FAR struct net_driver_s *dev, FAR void *arg) { FAR struct nlroute_info_s *info = arg; FAR struct netlink_response_s * resp; resp = netlink_get_device(dev, info->req); if (resp == NULL) { return -ENOMEM; } netlink_add_response(info->handle, resp); return OK; } static int netlink_get_devlist(NETLINK_HANDLE handle, FAR const struct nlroute_sendto_request_s *req) { struct nlroute_info_s info; int ret; /* Visit each device */ info.handle = handle; info.req = req; net_lock(); ret = netdev_foreach(netlink_device_callback, &info); net_unlock(); if (ret < 0) { return ret; } return netlink_add_terminator(handle, req); } #endif /**************************************************************************** * Name: netlink_get_arptable() * * Description: * Return the entire ARP table. * ****************************************************************************/ #if defined(CONFIG_NET_ARP) && !defined(CONFIG_NETLINK_DISABLE_GETNEIGH) static int netlink_get_arptable(NETLINK_HANDLE handle, FAR const struct nlroute_sendto_request_s *req) { FAR struct getneigh_recvfrom_rsplist_s *entry; unsigned int ncopied; size_t allocsize; size_t tabsize; size_t rspsize; /* Preallocate memory to hold the maximum sized ARP table * REVISIT: This is probably excessively large and could cause false * memory out conditions. A better approach would be to actually count * the number of valid entries in the ARP table. */ tabsize = CONFIG_NET_ARPTAB_SIZE * sizeof(struct arp_entry_s); rspsize = SIZEOF_NLROUTE_RECVFROM_RESPONSE_S(tabsize); allocsize = SIZEOF_NLROUTE_RECVFROM_RSPLIST_S(tabsize); entry = (FAR struct getneigh_recvfrom_rsplist_s *)kmm_zalloc(allocsize); if (entry == NULL) { nerr("ERROR: Failed to allocate response buffer.\n"); return -ENOMEM; } /* Populate the entry */ memcpy(&entry->payload.hdr, &req->hdr, sizeof(struct nlmsghdr)); entry->payload.hdr.nlmsg_len = rspsize; entry->payload.msg.ndm_family = req->gen.rtgen_family; entry->payload.attr.rta_len = RTA_LENGTH(tabsize); /* Lock the network so that the ARP table will be stable, then copy * the ARP table into the allocated memory. */ net_lock(); ncopied = arp_snapshot((FAR struct arp_entry_s *)entry->payload.data, CONFIG_NET_ARPTAB_SIZE); net_unlock(); /* Now we have the real number of valid entries in the ARP table and * we can trim the allocation. */ if (ncopied < CONFIG_NET_ARPTAB_SIZE) { FAR struct getneigh_recvfrom_rsplist_s *newentry; tabsize = ncopied * sizeof(struct arp_entry_s); rspsize = SIZEOF_NLROUTE_RECVFROM_RESPONSE_S(tabsize); allocsize = SIZEOF_NLROUTE_RECVFROM_RSPLIST_S(tabsize); newentry = (FAR struct getneigh_recvfrom_rsplist_s *) kmm_realloc(entry, allocsize); if (newentry != NULL) { entry = newentry; } entry->payload.hdr.nlmsg_len = rspsize; entry->payload.attr.rta_len = RTA_LENGTH(tabsize); } /* Finally, add the data to the list of pending responses */ netlink_add_response(handle, (FAR struct netlink_response_s *)entry); return OK; } #endif /**************************************************************************** * Name: netlink_get_nbtable() * * Description: * Return the entire IPv6 neighbor table. * ****************************************************************************/ #if defined(CONFIG_NET_IPv6) && !defined(CONFIG_NETLINK_DISABLE_GETNEIGH) static int netlink_get_nbtable(NETLINK_HANDLE handle, FAR const struct nlroute_sendto_request_s *req) { FAR struct getneigh_recvfrom_rsplist_s *entry; unsigned int ncopied; size_t allocsize; size_t tabsize; size_t rspsize; /* Preallocate memory to hold the maximum sized Neighbor table * REVISIT: This is probably excessively large and could cause false * memory out conditions. A better approach would be to actually count * the number of valid entries in the Neighbor table. */ tabsize = CONFIG_NET_IPv6_NCONF_ENTRIES * sizeof(struct neighbor_entry_s); rspsize = SIZEOF_NLROUTE_RECVFROM_RESPONSE_S(tabsize); allocsize = SIZEOF_NLROUTE_RECVFROM_RSPLIST_S(tabsize); entry = (FAR struct getneigh_recvfrom_rsplist_s *)kmm_zalloc(allocsize); if (entry == NULL) { nerr("ERROR: Failed to allocate response buffer.\n"); return -ENOMEM; } /* Populate the entry */ memcpy(&entry->payload.hdr, &req->hdr, sizeof(struct nlmsghdr)); entry->payload.hdr.nlmsg_len = rspsize; entry->payload.msg.ndm_family = req->gen.rtgen_family; entry->payload.attr.rta_len = RTA_LENGTH(tabsize); /* Lock the network so that the Neighbor table will be stable, then * copy the Neighbor table into the allocated memory. */ net_lock(); ncopied = neighbor_snapshot( (FAR struct neighbor_entry_s *)entry->payload.data, CONFIG_NET_IPv6_NCONF_ENTRIES); net_unlock(); /* Now we have the real number of valid entries in the Neighbor table * and we can trim the allocation. */ if (ncopied < CONFIG_NET_IPv6_NCONF_ENTRIES) { FAR struct getneigh_recvfrom_rsplist_s *newentry; tabsize = ncopied * sizeof(struct neighbor_entry_s); rspsize = SIZEOF_NLROUTE_RECVFROM_RESPONSE_S(tabsize); allocsize = SIZEOF_NLROUTE_RECVFROM_RSPLIST_S(tabsize); newentry = (FAR struct getneigh_recvfrom_rsplist_s *) kmm_realloc(entry, allocsize); if (newentry != NULL) { entry = newentry; } entry->payload.hdr.nlmsg_len = rspsize; entry->payload.attr.rta_len = RTA_LENGTH(tabsize); } /* Finally, add the response to the list of pending responses */ netlink_add_response(handle, (FAR struct netlink_response_s *)entry); return OK; } #endif /**************************************************************************** * Name: netlink_ipv4_route * * Description: * Dump a list of all network devices of the specified type. * ****************************************************************************/ #if defined(CONFIG_NET_IPv4) && !defined(CONFIG_NETLINK_DISABLE_GETROUTE) static int netlink_ipv4_route(FAR struct net_route_ipv4_s *route, FAR void *arg) { FAR struct getroute_recvfrom_ipv4resplist_s *alloc; FAR struct getroute_recvfrom_ipv4response_s *resp; FAR struct nlroute_info_s *info; DEBUGASSERT(route != NULL && arg != NULL); info = (FAR struct nlroute_info_s *)arg; /* Allocate the response */ alloc = (FAR struct getroute_recvfrom_ipv4resplist_s *) kmm_zalloc(sizeof(struct getroute_recvfrom_ipv4resplist_s)); if (alloc == NULL) { return -ENOMEM; } /* Format the response */ resp = &alloc->payload; resp->hdr.nlmsg_len = sizeof(struct getroute_recvfrom_ipv4response_s); resp->hdr.nlmsg_type = RTM_NEWROUTE; resp->hdr.nlmsg_flags = info->req->hdr.nlmsg_flags; resp->hdr.nlmsg_seq = info->req->hdr.nlmsg_seq; resp->hdr.nlmsg_pid = info->req->hdr.nlmsg_pid; resp->rte.rtm_family = info->req->gen.rtgen_family; resp->rte.rtm_table = RT_TABLE_MAIN; resp->rte.rtm_protocol = RTPROT_STATIC; resp->rte.rtm_scope = RT_SCOPE_SITE; resp->dst.attr.rta_len = RTA_LENGTH(sizeof(in_addr_t)); resp->dst.attr.rta_type = RTA_DST; resp->dst.addr = route->target; resp->genmask.attr.rta_len = RTA_LENGTH(sizeof(in_addr_t)); resp->genmask.attr.rta_type = RTA_GENMASK; resp->genmask.addr = route->netmask; resp->gateway.attr.rta_len = RTA_LENGTH(sizeof(in_addr_t)); resp->gateway.attr.rta_type = RTA_GATEWAY; resp->gateway.addr = route->router; /* Finally, add the response to the list of pending responses */ netlink_add_response(info->handle, (FAR struct netlink_response_s *)alloc); return OK; } #endif /**************************************************************************** * Name: netlink_get_ipv4route * * Description: * Dump a list of all network devices of the specified type. * ****************************************************************************/ #if defined(CONFIG_NET_IPv4) && !defined(CONFIG_NETLINK_DISABLE_GETROUTE) static int netlink_get_ipv4route(NETLINK_HANDLE handle, FAR const struct nlroute_sendto_request_s *req) { struct nlroute_info_s info; int ret; /* Visit each routing table entry */ info.handle = handle; info.req = req; ret = net_foreachroute_ipv4(netlink_ipv4_route, &info); if (ret < 0) { return ret; } /* Terminate the routing table */ return netlink_add_terminator(handle, req); } #endif /**************************************************************************** * Name: netlink_ipv6_route * * Description: * Dump a list of all network devices of the specified type. * ****************************************************************************/ #if defined(CONFIG_NET_IPv6) && !defined(CONFIG_NETLINK_DISABLE_GETROUTE) static int netlink_ipv6_route(FAR struct net_route_ipv6_s *route, FAR void *arg) { FAR struct getroute_recvfrom_ipv6resplist_s *alloc; FAR struct getroute_recvfrom_ipv6response_s *resp; FAR struct nlroute_info_s *info; DEBUGASSERT(route != NULL && arg != NULL); info = (FAR struct nlroute_info_s *)arg; /* Allocate the response */ alloc = (FAR struct getroute_recvfrom_ipv6resplist_s *) kmm_zalloc(sizeof(struct getroute_recvfrom_ipv6resplist_s)); if (alloc == NULL) { return -ENOMEM; } /* Format the response */ resp = &alloc->payload; resp->hdr.nlmsg_len = sizeof(struct getroute_recvfrom_ipv6response_s); resp->hdr.nlmsg_type = RTM_NEWROUTE; resp->hdr.nlmsg_flags = info->req->hdr.nlmsg_flags; resp->hdr.nlmsg_seq = info->req->hdr.nlmsg_seq; resp->hdr.nlmsg_pid = info->req->hdr.nlmsg_pid; resp->rte.rtm_family = info->req->gen.rtgen_family; resp->rte.rtm_table = RT_TABLE_MAIN; resp->rte.rtm_protocol = RTPROT_STATIC; resp->rte.rtm_scope = RT_SCOPE_SITE; resp->dst.attr.rta_len = RTA_LENGTH(sizeof(net_ipv6addr_t)); resp->dst.attr.rta_type = RTA_DST; net_ipv6addr_copy(resp->dst.addr, route->target); resp->genmask.attr.rta_len = RTA_LENGTH(sizeof(net_ipv6addr_t)); resp->genmask.attr.rta_type = RTA_GENMASK; net_ipv6addr_copy(resp->genmask.addr, route->netmask); resp->gateway.attr.rta_len = RTA_LENGTH(sizeof(net_ipv6addr_t)); resp->gateway.attr.rta_type = RTA_GATEWAY; net_ipv6addr_copy(resp->gateway.addr, route->router); /* Finally, add the response to the list of pending responses */ netlink_add_response(info->handle, (FAR struct netlink_response_s *)alloc); return OK; } #endif /**************************************************************************** * Name: netlink_get_ip6vroute * * Description: * Dump a list of all network devices of the specified type. * ****************************************************************************/ #if defined(CONFIG_NET_IPv6) && !defined(CONFIG_NETLINK_DISABLE_GETROUTE) static int netlink_get_ip6vroute(NETLINK_HANDLE handle, FAR const struct nlroute_sendto_request_s *req) { struct nlroute_info_s info; int ret; /* Visit each routing table entry */ info.handle = handle; info.req = req; ret = net_foreachroute_ipv6(netlink_ipv6_route, &info); if (ret < 0) { return ret; } /* Terminate the routing table */ return netlink_add_terminator(handle, req); } #endif /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * Name: netlink_route_sendto() * * Description: * Perform the sendto() operation for the NETLINK_ROUTE protocol. * ****************************************************************************/ ssize_t netlink_route_sendto(NETLINK_HANDLE handle, FAR const struct nlmsghdr *nlmsg, size_t len, int flags, FAR const struct sockaddr_nl *to, socklen_t tolen) { FAR const struct nlroute_sendto_request_s *req = (FAR const struct nlroute_sendto_request_s *)nlmsg; int ret; DEBUGASSERT(handle != NULL && nlmsg != NULL && nlmsg->nlmsg_len >= sizeof(struct nlmsghdr) && len >= sizeof(struct nlmsghdr) && len >= nlmsg->nlmsg_len && to != NULL && tolen >= sizeof(struct sockaddr_nl)); /* Handle according to the message type */ switch (nlmsg->nlmsg_type) { #ifndef CONFIG_NETLINK_DISABLE_GETLINK /* Dump a list of all devices */ case RTM_GETLINK: /* Generate the response */ ret = netlink_get_devlist(handle, req); break; #endif #ifndef CONFIG_NETLINK_DISABLE_GETNEIGH /* Retrieve ARP/Neighbor Tables */ case RTM_GETNEIGH: #ifdef CONFIG_NET_ARP /* Retrieve the ARP table in its entirety. */ if (req->gen.rtgen_family == AF_INET) { ret = netlink_get_arptable(handle, req); } else #endif #ifdef CONFIG_NET_IPv6 /* Retrieve the IPv6 neighbor table in its entirety. */ if (req->gen.rtgen_family == AF_INET6) { ret = netlink_get_nbtable(handle, req); } else #endif { ret = -EAFNOSUPPORT; } break; #endif /* !CONFIG_NETLINK_DISABLE_GETNEIGH */ #ifndef CONFIG_NETLINK_DISABLE_GETROUTE /* Retrieve the IPv4 or IPv6 routing table */ case RTM_GETROUTE: #ifdef CONFIG_NET_IPv4 if (req->gen.rtgen_family == AF_INET) { ret = netlink_get_ipv4route(handle, req); } else #endif #ifdef CONFIG_NET_IPv6 if (req->gen.rtgen_family == AF_INET6) { ret = netlink_get_ip6vroute(handle, req); } else #endif { ret = -EAFNOSUPPORT; } break; #endif default: ret = -ENOSYS; break; } /* On success, return the size of the request that was processed */ if (ret >= 0) { ret = len; } return ret; } /**************************************************************************** * Name: netlink_device_notify() * * Description: * Perform the route broadcast for the NETLINK_ROUTE protocol. * ****************************************************************************/ #ifndef CONFIG_NETLINK_DISABLE_GETLINK void netlink_device_notify(FAR struct net_driver_s *dev) { FAR struct netlink_response_s *resp; DEBUGASSERT(dev != NULL); resp = netlink_get_device(dev, NULL); if (resp != NULL) { netlink_add_broadcast(RTNLGRP_LINK, resp); resp = netlink_get_terminator(NULL); if (resp != NULL) { netlink_add_broadcast(RTNLGRP_LINK, resp); } } } #endif #endif /* CONFIG_NETLINK_ROUTE */