1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2020 Alexander V. Chernikov 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD$ 28 */ 29 30 /* 31 * This header file contains public definitions for the nexthop routing subsystem. 32 */ 33 34 #ifndef _NET_ROUTE_NHOP_H_ 35 #define _NET_ROUTE_NHOP_H_ 36 37 #include <netinet/in.h> /* sockaddr_in && sockaddr_in6 */ 38 39 #include <sys/counter.h> 40 41 enum nhop_type { 42 NH_TYPE_IPV4_ETHER_RSLV = 1, /* IPv4 ethernet without GW */ 43 NH_TYPE_IPV4_ETHER_NHOP = 2, /* IPv4 with pre-calculated ethernet encap */ 44 NH_TYPE_IPV6_ETHER_RSLV = 3, /* IPv6 ethernet, without GW */ 45 NH_TYPE_IPV6_ETHER_NHOP = 4 /* IPv6 with pre-calculated ethernet encap*/ 46 }; 47 48 #ifdef _KERNEL 49 50 /* 51 * Define shorter version of AF_LINK sockaddr. 52 * 53 * Currently the only use case of AF_LINK gateway is storing 54 * interface index of the interface of the source IPv6 address. 55 * This is used by the IPv6 code for the connections over loopback 56 * interface. 57 * 58 * The structure below copies 'struct sockaddr_dl', reducing the 59 * size of sdl_data buffer, as it is not used. This change 60 * allows to store the AF_LINK gateways in the nhop gateway itself, 61 * simplifying control plane handling. 62 */ 63 struct sockaddr_dl_short { 64 u_char sdl_len; /* Total length of sockaddr */ 65 u_char sdl_family; /* AF_LINK */ 66 u_short sdl_index; /* if != 0, system given index for interface */ 67 u_char sdl_type; /* interface type */ 68 u_char sdl_nlen; /* interface name length, no trailing 0 reqd. */ 69 u_char sdl_alen; /* link level address length */ 70 u_char sdl_slen; /* link layer selector length */ 71 char sdl_data[8]; /* unused */ 72 }; 73 74 #define NHOP_RELATED_FLAGS \ 75 (RTF_GATEWAY | RTF_HOST | RTF_REJECT | RTF_BLACKHOLE | \ 76 RTF_FIXEDMTU | RTF_LOCAL | RTF_BROADCAST | RTF_MULTICAST) 77 78 struct nh_control; 79 struct nhop_priv; 80 81 /* 82 * Struct 'nhop_object' field description: 83 * 84 * nh_flags: NHF_ flags used in the dataplane code. NHF_GATEWAY or NHF_BLACKHOLE 85 * can be examples of such flags. 86 * nh_mtu: ready-to-use nexthop mtu. Already accounts for the link-level header, 87 * interface MTU and protocol-specific limitations. 88 * nh_prepend_len: link-level prepend length. Currently unused. 89 * nh_ifp: logical transmit interface. The one from which if_transmit() will be 90 * called. Guaranteed to be non-NULL. 91 * nh_aifp: ifnet of the source address. Same as nh_ifp except IPv6 loopback 92 * routes. See the example below. 93 * nh_ifa: interface address to use. Guaranteed to be non-NULL. 94 * nh_pksent: counter(9) reflecting the number of packets transmitted. 95 * 96 * gw_: storage suitable to hold AF_INET, AF_INET6 or AF_LINK gateway. More 97 * details ara available in the examples below. 98 * 99 * Examples: 100 * 101 * Direct routes (routes w/o gateway): 102 * NHF_GATEWAY is NOT set. 103 * nh_ifp denotes the logical transmit interface (). 104 * nh_aifp is the same as nh_ifp 105 * gw_sa contains AF_LINK sa with nh_aifp ifindex (compat) 106 * Loopback routes: 107 * NHF_GATEWAY is NOT set. 108 * nh_ifp points to the loopback interface (lo0). 109 * nh_aifp points to the interface where the destination address belongs to. 110 * This is useful in IPv6 link-local-over-loopback communications. 111 * gw_sa contains AF_LINK sa with nh_aifp ifindex (compat) 112 * GW routes: 113 * NHF_GATEWAY is set. 114 * nh_ifp denotes the logical transmit interface. 115 * nh_aifp is the same as nh_ifp 116 * gw_sa contains L3 address (either AF_INET or AF_INET6). 117 * 118 * 119 * Note: struct nhop_object fields are ordered in a way that 120 * supports memcmp-based comparisons. 121 * 122 */ 123 #define NHOP_END_CMP (__offsetof(struct nhop_object, nh_pksent)) 124 125 struct nhop_object { 126 uint16_t nh_flags; /* nhop flags */ 127 uint16_t nh_mtu; /* nexthop mtu */ 128 union { 129 struct sockaddr_in gw4_sa; /* GW accessor as IPv4 */ 130 struct sockaddr_in6 gw6_sa; /* GW accessor as IPv6 */ 131 struct sockaddr gw_sa; 132 struct sockaddr_dl_short gwl_sa; /* AF_LINK gw (compat) */ 133 char gw_buf[28]; 134 }; 135 struct ifnet *nh_ifp; /* Logical egress interface. Always != NULL */ 136 struct ifaddr *nh_ifa; /* interface address to use. Always != NULL */ 137 struct ifnet *nh_aifp; /* ifnet of the source address. Always != NULL */ 138 counter_u64_t nh_pksent; /* packets sent using this nhop */ 139 /* 32 bytes + 4xPTR == 64(amd64) / 48(i386) */ 140 uint8_t nh_prepend_len; /* length of prepend data */ 141 uint8_t spare[3]; 142 uint32_t spare1; /* alignment */ 143 char nh_prepend[48]; /* L2 prepend */ 144 struct nhop_priv *nh_priv; /* control plane data */ 145 /* -- 128 bytes -- */ 146 }; 147 148 /* 149 * Nhop validness. 150 * 151 * Currently we verify whether link is up or not on every packet, which can be 152 * quite costy. 153 * TODO: subscribe for the interface notifications and update the nexthops 154 * with NHF_INVALID flag. 155 */ 156 157 #define NH_IS_VALID(_nh) RT_LINK_IS_UP((_nh)->nh_ifp) 158 #define NH_IS_NHGRP(_nh) ((_nh)->nh_flags & NHF_MULTIPATH) 159 160 #define NH_FREE(_nh) do { \ 161 nhop_free(_nh); \ 162 /* guard against invalid refs */ \ 163 _nh = NULL; \ 164 } while (0) 165 166 struct weightened_nhop { 167 struct nhop_object *nh; 168 uint32_t weight; 169 uint32_t storage; 170 }; 171 172 void nhop_free(struct nhop_object *nh); 173 174 struct sysctl_req; 175 struct sockaddr_dl; 176 struct rib_head; 177 178 /* flags that can be set using nhop_set_rtflags() */ 179 #define RT_SET_RTFLAGS_MASK (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_STATIC) 180 #define RT_CHANGE_RTFLAGS_MASK RT_SET_RTFLAGS_MASK 181 182 struct nhop_object *nhop_alloc(uint32_t fibnum, int family); 183 void nhop_copy(struct nhop_object *nh, const struct nhop_object *nh_orig); 184 struct nhop_object *nhop_get_nhop(struct nhop_object *nh, int *perror); 185 int nhop_get_unlinked(struct nhop_object *nh); 186 187 void nhop_set_direct_gw(struct nhop_object *nh, struct ifnet *ifp); 188 bool nhop_set_gw(struct nhop_object *nh, const struct sockaddr *sa, bool is_gw); 189 190 191 void nhop_set_mtu(struct nhop_object *nh, uint32_t mtu, bool from_user); 192 void nhop_set_rtflags(struct nhop_object *nh, int rt_flags); 193 void nhop_set_pxtype_flag(struct nhop_object *nh, int nh_flag); 194 void nhop_set_broadcast(struct nhop_object *nh, bool is_broadcast); 195 void nhop_set_blackhole(struct nhop_object *nh, int blackhole_rt_flag); 196 void nhop_set_pinned(struct nhop_object *nh, bool is_pinned); 197 void nhop_set_redirect(struct nhop_object *nh, bool is_redirect); 198 void nhop_set_type(struct nhop_object *nh, enum nhop_type nh_type); 199 void nhop_set_src(struct nhop_object *nh, struct ifaddr *ifa); 200 void nhop_set_transmit_ifp(struct nhop_object *nh, struct ifnet *ifp); 201 202 #define NH_ORIGIN_UNSPEC 0 /* not set */ 203 #define NH_ORIGIN_REDIRECT 1 /* kernel-originated redirect */ 204 #define NH_ORIGIN_KERNEL 2 /* kernel (interface) routes */ 205 #define NH_ORIGIN_BOOT 3 /* kernel-originated routes at boot */ 206 #define NH_ORIGIN_STATIC 4 /* route(8) routes */ 207 void nhop_set_origin(struct nhop_object *nh, uint8_t origin); 208 uint8_t nhop_get_origin(const struct nhop_object *nh); 209 210 uint32_t nhop_get_idx(const struct nhop_object *nh); 211 uint32_t nhop_get_uidx(const struct nhop_object *nh); 212 void nhop_set_uidx(struct nhop_object *nh, uint32_t uidx); 213 enum nhop_type nhop_get_type(const struct nhop_object *nh); 214 int nhop_get_rtflags(const struct nhop_object *nh); 215 struct vnet *nhop_get_vnet(const struct nhop_object *nh); 216 struct nhop_object *nhop_select_func(struct nhop_object *nh, uint32_t flowid); 217 int nhop_get_upper_family(const struct nhop_object *nh); 218 bool nhop_set_upper_family(struct nhop_object *nh, int family); 219 int nhop_get_neigh_family(const struct nhop_object *nh); 220 uint32_t nhop_get_fibnum(const struct nhop_object *nh); 221 void nhop_set_fibnum(struct nhop_object *nh, uint32_t fibnum); 222 uint32_t nhop_get_expire(const struct nhop_object *nh); 223 void nhop_set_expire(struct nhop_object *nh, uint32_t expire); 224 struct rib_head *nhop_get_rh(const struct nhop_object *nh); 225 226 struct nhgrp_object; 227 struct nhgrp_object *nhgrp_alloc(uint32_t fibnum, int family, 228 struct weightened_nhop *wn, int num_nhops, int *perror); 229 struct nhgrp_object *nhgrp_get_nhgrp(struct nhgrp_object *nhg, int *perror); 230 void nhgrp_set_uidx(struct nhgrp_object *nhg, uint32_t uidx); 231 uint32_t nhgrp_get_uidx(const struct nhgrp_object *nhg); 232 uint8_t nhgrp_get_origin(const struct nhgrp_object *nhg); 233 void nhgrp_set_origin(struct nhgrp_object *nhg, uint8_t origin); 234 #endif /* _KERNEL */ 235 236 /* Kernel <> userland structures */ 237 238 /* Structure usage and layout are described in dump_nhop_entry() */ 239 struct nhop_external { 240 uint32_t nh_len; /* length of the datastructure */ 241 uint32_t nh_idx; /* Nexthop index */ 242 uint32_t nh_fib; /* Fib nexhop is attached to */ 243 uint32_t ifindex; /* transmit interface ifindex */ 244 uint32_t aifindex; /* address ifindex */ 245 uint8_t prepend_len; /* length of the prepend */ 246 uint8_t nh_family; /* address family */ 247 uint16_t nh_type; /* nexthop type */ 248 uint16_t nh_mtu; /* nexthop mtu */ 249 250 uint16_t nh_flags; /* nhop flags */ 251 struct in_addr nh_addr; /* GW/DST IPv4 address */ 252 struct in_addr nh_src; /* default source IPv4 address */ 253 uint64_t nh_pksent; 254 /* control plane */ 255 /* lookup key: address, family, type */ 256 char nh_prepend[64]; /* L2 prepend */ 257 uint64_t nh_refcount; /* number of references */ 258 }; 259 260 struct nhop_addrs { 261 uint32_t na_len; /* length of the datastructure */ 262 uint16_t gw_sa_off; /* offset of gateway SA */ 263 uint16_t src_sa_off; /* offset of src address SA */ 264 }; 265 266 #define NHG_C_TYPE_CNHOPS 0x1 /* Control plane nhops list */ 267 #define NHG_C_TYPE_DNHOPS 0x2 /* Dataplane nhops list */ 268 struct nhgrp_container { 269 uint32_t nhgc_len; /* container length */ 270 uint16_t nhgc_count; /* number of items */ 271 uint8_t nhgc_type; /* container type */ 272 uint8_t nhgc_subtype; /* container subtype */ 273 }; 274 275 struct nhgrp_nhop_external { 276 uint32_t nh_idx; 277 uint32_t nh_weight; 278 }; 279 280 /* 281 * Layout: 282 * - nhgrp_external 283 * - nhgrp_container (control plane nhops list) 284 * - nhgrp_nhop_external 285 * - nhgrp_nhop_external 286 * .. 287 * - nhgrp_container (dataplane nhops list) 288 * - nhgrp_nhop_external 289 * - nhgrp_nhop_external 290 */ 291 struct nhgrp_external { 292 uint32_t nhg_idx; /* Nexthop group index */ 293 uint32_t nhg_refcount; /* number of references */ 294 }; 295 296 #endif 297