18d36e1dfSRoy Marples /* SPDX-License-Identifier: BSD-2-Clause */ 27827cba2SAaron LI /* 37827cba2SAaron LI * dhcpcd - route management 4*80aa9461SRoy Marples * Copyright (c) 2006-2023 Roy Marples <roy@marples.name> 57827cba2SAaron LI * All rights reserved 67827cba2SAaron LI 77827cba2SAaron LI * rEDISTRIBUTION AND USE IN SOURCE AND BINARY FORMS, WITH OR WITHOUT 87827cba2SAaron LI * modification, are permitted provided that the following conditions 97827cba2SAaron LI * are met: 107827cba2SAaron LI * 1. Redistributions of source code must retain the above copyright 117827cba2SAaron LI * notice, this list of conditions and the following disclaimer. 127827cba2SAaron LI * 2. Redistributions in binary form must reproduce the above copyright 137827cba2SAaron LI * notice, this list of conditions and the following disclaimer in the 147827cba2SAaron LI * documentation and/or other materials provided with the distribution. 157827cba2SAaron LI * 167827cba2SAaron LI * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 177827cba2SAaron LI * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 187827cba2SAaron LI * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 197827cba2SAaron LI * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 207827cba2SAaron LI * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 217827cba2SAaron LI * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 227827cba2SAaron LI * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 237827cba2SAaron LI * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 247827cba2SAaron LI * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 257827cba2SAaron LI * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 267827cba2SAaron LI * SUCH DAMAGE. 277827cba2SAaron LI */ 287827cba2SAaron LI 297827cba2SAaron LI #ifndef ROUTE_H 307827cba2SAaron LI #define ROUTE_H 317827cba2SAaron LI 328d36e1dfSRoy Marples #ifdef HAVE_SYS_RBTREE_H 338d36e1dfSRoy Marples #include <sys/rbtree.h> 348d36e1dfSRoy Marples #endif 358d36e1dfSRoy Marples 367827cba2SAaron LI #include <sys/socket.h> 377827cba2SAaron LI #include <net/route.h> 387827cba2SAaron LI 397827cba2SAaron LI #include <stdbool.h> 407827cba2SAaron LI 417827cba2SAaron LI #include "dhcpcd.h" 427827cba2SAaron LI #include "sa.h" 437827cba2SAaron LI 448d36e1dfSRoy Marples /* 458d36e1dfSRoy Marples * Enable the route free list by default as 468d36e1dfSRoy Marples * memory usage is still reported as low/unchanged even 478d36e1dfSRoy Marples * when dealing with millions of routes. 488d36e1dfSRoy Marples */ 498d36e1dfSRoy Marples #if !defined(RT_FREE_ROUTE_TABLE) 508d36e1dfSRoy Marples #define RT_FREE_ROUTE_TABLE 1 518d36e1dfSRoy Marples #elif RT_FREE_ROUTE_TABLE == 0 528d36e1dfSRoy Marples #undef RT_FREE_ROUTE_TABLE 538d36e1dfSRoy Marples #endif 548d36e1dfSRoy Marples 557827cba2SAaron LI /* Some systems have route metrics. 567827cba2SAaron LI * OpenBSD route priority is not this. */ 577827cba2SAaron LI #ifndef HAVE_ROUTE_METRIC 587827cba2SAaron LI # if defined(__linux__) 597827cba2SAaron LI # define HAVE_ROUTE_METRIC 1 607827cba2SAaron LI # endif 617827cba2SAaron LI #endif 627827cba2SAaron LI 63280986e4SRoy Marples #ifdef __linux__ 64280986e4SRoy Marples # include <linux/version.h> /* RTA_PREF is only an enum.... */ 65280986e4SRoy Marples # if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 1, 0) 66280986e4SRoy Marples # define HAVE_ROUTE_PREF 67280986e4SRoy Marples # endif 68280986e4SRoy Marples #endif 69280986e4SRoy Marples 707827cba2SAaron LI #if defined(__OpenBSD__) || defined (__sun) 717827cba2SAaron LI # define ROUTE_PER_GATEWAY 727827cba2SAaron LI /* XXX dhcpcd doesn't really support this yet. 737827cba2SAaron LI * But that's generally OK if only dhcpcd is managing routes. */ 747827cba2SAaron LI #endif 757827cba2SAaron LI 767827cba2SAaron LI /* OpenBSD defines this as a "convienience" ..... we work around it. */ 777827cba2SAaron LI #ifdef __OpenBSD__ 787827cba2SAaron LI #undef rt_mtu 797827cba2SAaron LI #endif 807827cba2SAaron LI 817827cba2SAaron LI struct rt { 827827cba2SAaron LI union sa_ss rt_ss_dest; 837827cba2SAaron LI #define rt_dest rt_ss_dest.sa 847827cba2SAaron LI union sa_ss rt_ss_netmask; 857827cba2SAaron LI #define rt_netmask rt_ss_netmask.sa 867827cba2SAaron LI union sa_ss rt_ss_gateway; 877827cba2SAaron LI #define rt_gateway rt_ss_gateway.sa 887827cba2SAaron LI struct interface *rt_ifp; 897827cba2SAaron LI union sa_ss rt_ss_ifa; 907827cba2SAaron LI #define rt_ifa rt_ss_ifa.sa 917827cba2SAaron LI unsigned int rt_flags; 927827cba2SAaron LI unsigned int rt_mtu; 937827cba2SAaron LI #ifdef HAVE_ROUTE_METRIC 947827cba2SAaron LI unsigned int rt_metric; 957827cba2SAaron LI #endif 960aaf6155SRoy Marples /* Maximum interface index is generally USHORT_MAX or 65535. 970aaf6155SRoy Marples * Add some padding for other stuff and we get offsets for the 980aaf6155SRoy Marples * below that should work automatically. 990aaf6155SRoy Marples * This is only an issue if the user defines higher metrics in 1000aaf6155SRoy Marples * their configuration, but then they might wish to override also. */ 1010aaf6155SRoy Marples #define RTMETRIC_BASE 1000U 1020aaf6155SRoy Marples #define RTMETRIC_WIRELESS 2000U 1030aaf6155SRoy Marples #define RTMETRIC_IPV4LL 1000000U 1040aaf6155SRoy Marples #define RTMETRIC_ROAM 2000000U 105280986e4SRoy Marples #ifdef HAVE_ROUTE_PREF 106280986e4SRoy Marples int rt_pref; 107280986e4SRoy Marples #endif 108280986e4SRoy Marples #define RTPREF_HIGH 1 109280986e4SRoy Marples #define RTPREF_MEDIUM 0 /* has to be zero */ 110280986e4SRoy Marples #define RTPREF_LOW (-1) 111280986e4SRoy Marples #define RTPREF_RESERVED (-2) 112280986e4SRoy Marples #define RTPREF_INVALID (-3) /* internal */ 1137827cba2SAaron LI unsigned int rt_dflags; 114b8b69544SRoy Marples #define RTDF_IFA_ROUTE 0x01 /* Address generated route */ 115b8b69544SRoy Marples #define RTDF_FAKE 0x02 /* Maybe us on lease reboot */ 116b8b69544SRoy Marples #define RTDF_IPV4LL 0x04 /* IPv4LL route */ 1177827cba2SAaron LI #define RTDF_RA 0x08 /* Router Advertisement */ 1187827cba2SAaron LI #define RTDF_DHCP 0x10 /* DHCP route */ 1197827cba2SAaron LI #define RTDF_STATIC 0x20 /* Configured in dhcpcd */ 1208d36e1dfSRoy Marples #define RTDF_GATELINK 0x40 /* Gateway is on link */ 1218d36e1dfSRoy Marples size_t rt_order; 1228d36e1dfSRoy Marples rb_node_t rt_tree; 1237827cba2SAaron LI }; 1248d36e1dfSRoy Marples 1258d36e1dfSRoy Marples extern const rb_tree_ops_t rt_compare_list_ops; 1268d36e1dfSRoy Marples extern const rb_tree_ops_t rt_compare_proto_ops; 1277827cba2SAaron LI 1287827cba2SAaron LI void rt_init(struct dhcpcd_ctx *); 1297827cba2SAaron LI void rt_dispose(struct dhcpcd_ctx *); 1307827cba2SAaron LI void rt_free(struct rt *); 1317827cba2SAaron LI void rt_freeif(struct interface *); 1328d36e1dfSRoy Marples bool rt_is_default(const struct rt *); 1338d36e1dfSRoy Marples void rt_headclear0(struct dhcpcd_ctx *, rb_tree_t *, int); 1348d36e1dfSRoy Marples void rt_headclear(rb_tree_t *, int); 1358d36e1dfSRoy Marples void rt_headfreeif(rb_tree_t *); 1367827cba2SAaron LI struct rt * rt_new0(struct dhcpcd_ctx *); 1377827cba2SAaron LI void rt_setif(struct rt *, struct interface *); 1387827cba2SAaron LI struct rt * rt_new(struct interface *); 1398d36e1dfSRoy Marples struct rt * rt_proto_add_ctx(rb_tree_t *, struct rt *, struct dhcpcd_ctx *); 1408d36e1dfSRoy Marples struct rt * rt_proto_add(rb_tree_t *, struct rt *); 1418d36e1dfSRoy Marples int rt_cmp_dest(const struct rt *, const struct rt *); 1428d36e1dfSRoy Marples void rt_recvrt(int, const struct rt *, pid_t); 1437827cba2SAaron LI void rt_build(struct dhcpcd_ctx *, int); 1447827cba2SAaron LI 1457827cba2SAaron LI #endif 146