1 /* $OpenBSD: route.h,v 1.187 2021/11/12 15:49:41 deraadt Exp $ */ 2 /* $NetBSD: route.h,v 1.9 1996/02/13 22:00:49 christos Exp $ */ 3 4 /* 5 * Copyright (c) 1980, 1986, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)route.h 8.3 (Berkeley) 4/19/94 33 */ 34 35 #ifndef _NET_ROUTE_H_ 36 #define _NET_ROUTE_H_ 37 38 /* 39 * Kernel resident routing tables. 40 * 41 * The routing tables are initialized when interface addresses 42 * are set by making entries for all directly connected interfaces. 43 */ 44 45 #ifdef _KERNEL 46 /* 47 * These numbers are used by reliable protocols for determining 48 * retransmission behavior and are included in the routing structure. 49 */ 50 struct rt_kmetrics { 51 u_int64_t rmx_pksent; /* packets sent using this route */ 52 int64_t rmx_expire; /* lifetime for route, e.g. redirect */ 53 u_int rmx_locks; /* Kernel must leave these values */ 54 u_int rmx_mtu; /* MTU for this path */ 55 }; 56 #endif 57 58 /* 59 * Huge version for userland compatibility. 60 */ 61 struct rt_metrics { 62 u_int64_t rmx_pksent; /* packets sent using this route */ 63 int64_t rmx_expire; /* lifetime for route, e.g. redirect */ 64 u_int rmx_locks; /* Kernel must leave these values */ 65 u_int rmx_mtu; /* MTU for this path */ 66 u_int rmx_refcnt; /* # references hold */ 67 /* some apps may still need these no longer used metrics */ 68 u_int rmx_hopcount; /* max hops expected */ 69 u_int rmx_recvpipe; /* inbound delay-bandwidth product */ 70 u_int rmx_sendpipe; /* outbound delay-bandwidth product */ 71 u_int rmx_ssthresh; /* outbound gateway buffer limit */ 72 u_int rmx_rtt; /* estimated round trip time */ 73 u_int rmx_rttvar; /* estimated rtt variance */ 74 u_int rmx_pad; 75 }; 76 77 #ifdef _KERNEL 78 /* 79 * rmx_rtt and rmx_rttvar are stored as microseconds; 80 * RTTTOPRHZ(rtt) converts to a value suitable for use 81 * by a protocol slowtimo counter. 82 */ 83 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 84 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 85 86 #include <sys/queue.h> 87 #include <net/rtable.h> 88 89 /* 90 * We distinguish between routes to hosts and routes to networks, 91 * preferring the former if available. For each route we infer 92 * the interface to use from the gateway address supplied when 93 * the route was entered. Routes that forward packets through 94 * gateways are marked so that the output routines know to address the 95 * gateway rather than the ultimate destination. 96 */ 97 98 struct rtentry { 99 struct sockaddr *rt_dest; /* destination */ 100 SRPL_ENTRY(rtentry) rt_next; /* Next multipath entry to our dst. */ 101 struct sockaddr *rt_gateway; /* value */ 102 struct ifaddr *rt_ifa; /* the answer: interface addr to use */ 103 caddr_t rt_llinfo; /* pointer to link level info cache or 104 to an MPLS structure */ 105 union { 106 struct rtentry *_nh; /* implied entry for gatewayed routes */ 107 unsigned int _ref; /* # gatewayed caching this route */ 108 } RT_gw; 109 #define rt_gwroute RT_gw._nh 110 #define rt_cachecnt RT_gw._ref 111 struct rtentry *rt_parent; /* If cloned, parent of this route. */ 112 LIST_HEAD(, rttimer) rt_timer; /* queue of timeouts for misc funcs */ 113 struct rt_kmetrics rt_rmx; /* metrics used by rx'ing protocols */ 114 unsigned int rt_ifidx; /* the answer: interface to use */ 115 unsigned int rt_flags; /* up/down?, host/net */ 116 int rt_refcnt; /* # held references */ 117 int rt_plen; /* prefix length */ 118 uint16_t rt_labelid; /* route label ID */ 119 uint8_t rt_priority; /* routing priority to use */ 120 }; 121 #define rt_use rt_rmx.rmx_pksent 122 #define rt_expire rt_rmx.rmx_expire 123 #define rt_locks rt_rmx.rmx_locks 124 #define rt_mtu rt_rmx.rmx_mtu 125 126 #endif /* _KERNEL */ 127 128 /* bitmask values for rtm_flags */ 129 #define RTF_UP 0x1 /* route usable */ 130 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 131 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 132 #define RTF_REJECT 0x8 /* host or net unreachable */ 133 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 134 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 135 #define RTF_DONE 0x40 /* message confirmed */ 136 #define RTF_CLONING 0x100 /* generate new routes on use */ 137 #define RTF_MULTICAST 0x200 /* route associated to a mcast addr. */ 138 #define RTF_LLINFO 0x400 /* generated by ARP or ND */ 139 #define RTF_STATIC 0x800 /* manually added */ 140 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 141 #define RTF_PROTO3 0x2000 /* protocol specific routing flag */ 142 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 143 #define RTF_ANNOUNCE RTF_PROTO2 /* announce L2 entry */ 144 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 145 #define RTF_CLONED 0x10000 /* this is a cloned route */ 146 #define RTF_CACHED 0x20000 /* cached by a RTF_GATEWAY entry */ 147 #define RTF_MPATH 0x40000 /* multipath route or operation */ 148 #define RTF_MPLS 0x100000 /* MPLS additional infos */ 149 #define RTF_LOCAL 0x200000 /* route to a local address */ 150 #define RTF_BROADCAST 0x400000 /* route associated to a bcast addr. */ 151 #define RTF_CONNECTED 0x800000 /* interface route */ 152 #define RTF_BFD 0x1000000 /* Link state controlled by BFD */ 153 154 /* mask of RTF flags that are allowed to be modified by RTM_CHANGE */ 155 #define RTF_FMASK \ 156 (RTF_LLINFO | RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \ 157 RTF_REJECT | RTF_STATIC | RTF_MPLS | RTF_BFD) 158 159 /* Routing priorities used by the different routing protocols */ 160 #define RTP_NONE 0 /* unset priority use sane default */ 161 #define RTP_LOCAL 1 /* local address routes (must be the highest) */ 162 #define RTP_CONNECTED 4 /* directly connected routes */ 163 #define RTP_STATIC 8 /* static routes base priority */ 164 #define RTP_EIGRP 28 /* EIGRP routes */ 165 #define RTP_OSPF 32 /* OSPF routes */ 166 #define RTP_ISIS 36 /* IS-IS routes */ 167 #define RTP_RIP 40 /* RIP routes */ 168 #define RTP_BGP 48 /* BGP routes */ 169 #define RTP_DEFAULT 56 /* routes that have nothing set */ 170 #define RTP_PROPOSAL_STATIC 57 171 #define RTP_PROPOSAL_DHCLIENT 58 172 #define RTP_PROPOSAL_SLAAC 59 173 #define RTP_PROPOSAL_UMB 60 174 #define RTP_PROPOSAL_PPP 61 175 #define RTP_PROPOSAL_SOLICIT 62 /* request reply of all RTM_PROPOSAL */ 176 #define RTP_MAX 63 /* maximum priority */ 177 #define RTP_ANY 64 /* any of the above */ 178 #define RTP_MASK 0x7f 179 #define RTP_DOWN 0x80 /* route/link is down */ 180 181 /* 182 * Routing statistics. 183 */ 184 struct rtstat { 185 u_int32_t rts_badredirect; /* bogus redirect calls */ 186 u_int32_t rts_dynamic; /* routes created by redirects */ 187 u_int32_t rts_newgateway; /* routes modified by redirects */ 188 u_int32_t rts_unreach; /* lookups which failed */ 189 u_int32_t rts_wildcard; /* lookups satisfied by a wildcard */ 190 }; 191 192 /* 193 * Routing Table Info. 194 */ 195 struct rt_tableinfo { 196 u_short rti_tableid; /* routing table id */ 197 u_short rti_domainid; /* routing domain id */ 198 }; 199 200 /* 201 * Structures for routing messages. 202 */ 203 struct rt_msghdr { 204 u_short rtm_msglen; /* to skip over non-understood messages */ 205 u_char rtm_version; /* future binary compatibility */ 206 u_char rtm_type; /* message type */ 207 u_short rtm_hdrlen; /* sizeof(rt_msghdr) to skip over the header */ 208 u_short rtm_index; /* index for associated ifp */ 209 u_short rtm_tableid; /* routing table id */ 210 u_char rtm_priority; /* routing priority */ 211 u_char rtm_mpls; /* MPLS additional infos */ 212 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 213 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 214 int rtm_fmask; /* bitmask used in RTM_CHANGE message */ 215 pid_t rtm_pid; /* identify sender */ 216 int rtm_seq; /* for sender to identify action */ 217 int rtm_errno; /* why failed */ 218 u_int rtm_inits; /* which metrics we are initializing */ 219 struct rt_metrics rtm_rmx; /* metrics themselves */ 220 }; 221 /* overload no longer used field */ 222 #define rtm_use rtm_rmx.rmx_pksent 223 224 #define RTM_VERSION 5 /* Up the ante and ignore older versions */ 225 226 #define RTM_MAXSIZE 2048 /* Maximum size of an accepted route msg */ 227 228 /* values for rtm_type */ 229 #define RTM_ADD 0x1 /* Add Route */ 230 #define RTM_DELETE 0x2 /* Delete Route */ 231 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ 232 #define RTM_GET 0x4 /* Report Metrics */ 233 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 234 #define RTM_REDIRECT 0x6 /* Told to use different route */ 235 #define RTM_MISS 0x7 /* Lookup failed on this address */ 236 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 237 #define RTM_NEWADDR 0xc /* address being added to iface */ 238 #define RTM_DELADDR 0xd /* address being removed from iface */ 239 #define RTM_IFINFO 0xe /* iface going up/down etc. */ 240 #define RTM_IFANNOUNCE 0xf /* iface arrival/departure */ 241 #define RTM_DESYNC 0x10 /* route socket buffer overflow */ 242 #define RTM_INVALIDATE 0x11 /* Invalidate cache of L2 route */ 243 #define RTM_BFD 0x12 /* bidirectional forwarding detection */ 244 #define RTM_PROPOSAL 0x13 /* proposal for resolvd(8) */ 245 #define RTM_CHGADDRATTR 0x14 /* address attribute change */ 246 #define RTM_80211INFO 0x15 /* 80211 iface change */ 247 #define RTM_SOURCE 0x16 /* set source address */ 248 249 #define RTV_MTU 0x1 /* init or lock _mtu */ 250 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 251 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 252 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 253 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 254 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 255 #define RTV_RTT 0x40 /* init or lock _rtt */ 256 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 257 258 /* 259 * Bitmask values for rtm_addrs. 260 */ 261 #define RTA_DST 0x1 /* destination sockaddr present */ 262 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 263 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 264 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 265 #define RTA_IFP 0x10 /* interface name sockaddr present */ 266 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 267 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 268 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 269 #define RTA_SRC 0x100 /* source sockaddr present */ 270 #define RTA_SRCMASK 0x200 /* source netmask present */ 271 #define RTA_LABEL 0x400 /* route label present */ 272 #define RTA_BFD 0x800 /* bfd present */ 273 #define RTA_DNS 0x1000 /* DNS Servers sockaddr present */ 274 #define RTA_STATIC 0x2000 /* RFC 3442 encoded static routes present */ 275 #define RTA_SEARCH 0x4000 /* RFC 3397 encoded search path present */ 276 277 /* 278 * Index offsets for sockaddr array for alternate internal encoding. 279 */ 280 #define RTAX_DST 0 /* destination sockaddr present */ 281 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ 282 #define RTAX_NETMASK 2 /* netmask sockaddr present */ 283 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 284 #define RTAX_IFP 4 /* interface name sockaddr present */ 285 #define RTAX_IFA 5 /* interface addr sockaddr present */ 286 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 287 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 288 #define RTAX_SRC 8 /* source sockaddr present */ 289 #define RTAX_SRCMASK 9 /* source netmask present */ 290 #define RTAX_LABEL 10 /* route label present */ 291 #define RTAX_BFD 11 /* bfd present */ 292 #define RTAX_DNS 12 /* DNS Server(s) sockaddr present */ 293 #define RTAX_STATIC 13 /* RFC 3442 encoded static routes present */ 294 #define RTAX_SEARCH 14 /* RFC 3397 encoded search path present */ 295 #define RTAX_MAX 15 /* size of array to allocate */ 296 297 /* 298 * setsockopt defines used for the filtering. 299 */ 300 #define ROUTE_MSGFILTER 1 /* bitmask to specify which types should be 301 sent to the client. */ 302 #define ROUTE_TABLEFILTER 2 /* change routing table the socket is listening 303 on, RTABLE_ANY listens on all tables. */ 304 #define ROUTE_PRIOFILTER 3 /* only pass updates with a priority higher or 305 equal (actual value lower) to the specified 306 priority. */ 307 #define ROUTE_FLAGFILTER 4 /* do not pass updates for routes with flags 308 in this bitmask. */ 309 310 #define ROUTE_FILTER(m) (1 << (m)) 311 #define RTABLE_ANY 0xffffffff 312 313 #define RTLABEL_LEN 32 314 315 struct sockaddr_rtlabel { 316 u_int8_t sr_len; /* total length */ 317 sa_family_t sr_family; /* address family */ 318 char sr_label[RTLABEL_LEN]; 319 }; 320 321 #define RTDNS_LEN 128 322 323 struct sockaddr_rtdns { 324 u_int8_t sr_len; /* total length */ 325 sa_family_t sr_family; /* address family */ 326 char sr_dns[RTDNS_LEN]; 327 }; 328 329 #ifdef _KERNEL 330 331 static inline struct sockaddr * 332 srtdnstosa(struct sockaddr_rtdns *sdns) 333 { 334 return ((struct sockaddr *)(sdns)); 335 } 336 337 #endif 338 339 #define RTSTATIC_LEN 128 340 341 struct sockaddr_rtstatic { 342 u_int8_t sr_len; /* total length */ 343 sa_family_t sr_family; /* address family */ 344 char sr_static[RTSTATIC_LEN]; 345 }; 346 347 #define RTSEARCH_LEN 128 348 349 struct sockaddr_rtsearch { 350 u_int8_t sr_len; /* total length */ 351 sa_family_t sr_family; /* address family */ 352 char sr_search[RTSEARCH_LEN]; 353 }; 354 355 /* 356 * A route consists of a destination address and a reference 357 * to a routing entry. These are often held by protocols 358 * in their control blocks, e.g. inpcb. 359 */ 360 struct route { 361 struct rtentry *ro_rt; 362 u_long ro_tableid; /* u_long because of alignment */ 363 struct sockaddr ro_dst; 364 }; 365 366 struct rt_addrinfo { 367 int rti_addrs; 368 struct sockaddr *rti_info[RTAX_MAX]; 369 int rti_flags; 370 struct ifaddr *rti_ifa; 371 struct rt_msghdr *rti_rtm; 372 u_char rti_mpls; 373 }; 374 375 #ifdef _KERNEL 376 377 #include <sys/percpu.h> 378 379 enum rtstat_counters { 380 rts_badredirect, /* bogus redirect calls */ 381 rts_dynamic, /* routes created by redirects */ 382 rts_newgateway, /* routes modified by redirects */ 383 rts_unreach, /* lookups which failed */ 384 rts_wildcard, /* lookups satisfied by a wildcard */ 385 386 rts_ncounters 387 }; 388 389 static inline void 390 rtstat_inc(enum rtstat_counters c) 391 { 392 extern struct cpumem *rtcounters; 393 394 counters_inc(rtcounters, c); 395 } 396 397 /* 398 * This structure, and the prototypes for the rt_timer_{init,remove_all, 399 * add,timer} functions all used with the kind permission of BSDI. 400 * These allow functions to be called for routes at specific times. 401 */ 402 struct rttimer { 403 TAILQ_ENTRY(rttimer) rtt_next; /* entry on timer queue */ 404 LIST_ENTRY(rttimer) rtt_link; /* multiple timers per rtentry */ 405 struct rttimer_queue *rtt_queue;/* back pointer to queue */ 406 struct rtentry *rtt_rt; /* Back pointer to the route */ 407 void (*rtt_func)(struct rtentry *, 408 struct rttimer *); 409 time_t rtt_time; /* When this timer was registered */ 410 u_int rtt_tableid; /* routing table id of rtt_rt */ 411 }; 412 413 struct rttimer_queue { 414 long rtq_timeout; 415 unsigned long rtq_count; 416 TAILQ_HEAD(, rttimer) rtq_head; 417 LIST_ENTRY(rttimer_queue) rtq_link; 418 }; 419 420 const char *rtlabel_id2name(u_int16_t); 421 u_int16_t rtlabel_name2id(char *); 422 struct sockaddr *rtlabel_id2sa(u_int16_t, struct sockaddr_rtlabel *); 423 void rtlabel_unref(u_int16_t); 424 425 /* 426 * Values for additional argument to rtalloc() 427 */ 428 #define RT_RESOLVE 1 429 430 extern struct rtstat rtstat; 431 432 struct mbuf; 433 struct socket; 434 struct ifnet; 435 struct sockaddr_in6; 436 struct if_ieee80211_data; 437 struct bfd_config; 438 439 void route_init(void); 440 void rtm_ifchg(struct ifnet *); 441 void rtm_ifannounce(struct ifnet *, int); 442 void rtm_bfd(struct bfd_config *); 443 void rtm_80211info(struct ifnet *, struct if_ieee80211_data *); 444 void rt_maskedcopy(struct sockaddr *, 445 struct sockaddr *, struct sockaddr *); 446 struct sockaddr *rt_plen2mask(struct rtentry *, struct sockaddr_in6 *); 447 void rtm_send(struct rtentry *, int, int, unsigned int); 448 void rtm_addr(int, struct ifaddr *); 449 void rtm_miss(int, struct rt_addrinfo *, int, uint8_t, u_int, int, u_int); 450 void rtm_proposal(struct ifnet *, struct rt_addrinfo *, int, uint8_t); 451 int rt_setgate(struct rtentry *, struct sockaddr *, u_int); 452 struct rtentry *rt_getll(struct rtentry *); 453 454 int rt_timer_add(struct rtentry *, 455 void(*)(struct rtentry *, struct rttimer *), 456 struct rttimer_queue *, u_int); 457 void rt_timer_remove_all(struct rtentry *); 458 struct rttimer_queue *rt_timer_queue_create(u_int); 459 void rt_timer_queue_change(struct rttimer_queue *, long); 460 void rt_timer_queue_destroy(struct rttimer_queue *); 461 unsigned long rt_timer_queue_count(struct rttimer_queue *); 462 void rt_timer_timer(void *); 463 464 int rt_mpls_set(struct rtentry *, struct sockaddr *, uint8_t); 465 void rt_mpls_clear(struct rtentry *); 466 467 int rtisvalid(struct rtentry *); 468 int rt_hash(struct rtentry *, struct sockaddr *, uint32_t *); 469 struct rtentry *rtalloc_mpath(struct sockaddr *, uint32_t *, u_int); 470 struct rtentry *rtalloc(struct sockaddr *, int, unsigned int); 471 void rtref(struct rtentry *); 472 void rtfree(struct rtentry *); 473 474 int rt_ifa_add(struct ifaddr *, int, struct sockaddr *, unsigned int); 475 int rt_ifa_del(struct ifaddr *, int, struct sockaddr *, unsigned int); 476 void rt_ifa_purge(struct ifaddr *); 477 int rt_ifa_addlocal(struct ifaddr *); 478 int rt_ifa_dellocal(struct ifaddr *); 479 void rtredirect(struct sockaddr *, struct sockaddr *, struct sockaddr *, struct rtentry **, unsigned int); 480 int rtrequest(int, struct rt_addrinfo *, u_int8_t, struct rtentry **, 481 u_int); 482 int rtrequest_delete(struct rt_addrinfo *, u_int8_t, struct ifnet *, 483 struct rtentry **, u_int); 484 int rt_if_track(struct ifnet *); 485 int rt_if_linkstate_change(struct rtentry *, void *, u_int); 486 int rtdeletemsg(struct rtentry *, struct ifnet *, u_int); 487 #endif /* _KERNEL */ 488 489 #endif /* _NET_ROUTE_H_ */ 490