1 /*- 2 * Copyright (c) 1980, 1986, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)route.h 8.4 (Berkeley) 1/9/95 30 * $FreeBSD$ 31 */ 32 33 #ifndef _NET_ROUTE_H_ 34 #define _NET_ROUTE_H_ 35 36 /* 37 * Kernel resident routing tables. 38 * 39 * The routing tables are initialized when interface addresses 40 * are set by making entries for all directly connected interfaces. 41 */ 42 43 /* 44 * Struct route consiste of a destination address, 45 * a route entry pointer, link-layer prepend data pointer along 46 * with its length. 47 */ 48 struct route { 49 struct rtentry *ro_rt; 50 struct llentry *ro_lle; 51 /* 52 * ro_prepend and ro_plen are only used for bpf to pass in a 53 * preformed header. They are not cacheable. 54 */ 55 char *ro_prepend; 56 uint16_t ro_plen; 57 uint16_t ro_flags; 58 uint16_t ro_mtu; /* saved ro_rt mtu */ 59 uint16_t spare; 60 struct sockaddr ro_dst; 61 }; 62 63 #define RT_L2_ME_BIT 2 /* dst L2 addr is our address */ 64 #define RT_MAY_LOOP_BIT 3 /* dst may require loop copy */ 65 #define RT_HAS_HEADER_BIT 4 /* mbuf already have its header prepended */ 66 67 #define RT_CACHING_CONTEXT 0x1 /* XXX: not used anywhere */ 68 #define RT_NORTREF 0x2 /* doesn't hold reference on ro_rt */ 69 #define RT_L2_ME (1 << RT_L2_ME_BIT) /* 0x0004 */ 70 #define RT_MAY_LOOP (1 << RT_MAY_LOOP_BIT) /* 0x0008 */ 71 #define RT_HAS_HEADER (1 << RT_HAS_HEADER_BIT) /* 0x0010 */ 72 73 #define RT_REJECT 0x0020 /* Destination is reject */ 74 #define RT_BLACKHOLE 0x0040 /* Destination is blackhole */ 75 #define RT_HAS_GW 0x0080 /* Destination has GW */ 76 #define RT_LLE_CACHE 0x0100 /* Cache link layer */ 77 78 struct rt_metrics { 79 u_long rmx_locks; /* Kernel must leave these values alone */ 80 u_long rmx_mtu; /* MTU for this path */ 81 u_long rmx_hopcount; /* max hops expected */ 82 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 83 u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 84 u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 85 u_long rmx_ssthresh; /* outbound gateway buffer limit */ 86 u_long rmx_rtt; /* estimated round trip time */ 87 u_long rmx_rttvar; /* estimated rtt variance */ 88 u_long rmx_pksent; /* packets sent using this route */ 89 u_long rmx_weight; /* route weight */ 90 u_long rmx_filler[3]; /* will be used for T/TCP later */ 91 }; 92 93 /* 94 * rmx_rtt and rmx_rttvar are stored as microseconds; 95 * RTTTOPRHZ(rtt) converts to a value suitable for use 96 * by a protocol slowtimo counter. 97 */ 98 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 99 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 100 101 /* lle state is exported in rmx_state rt_metrics field */ 102 #define rmx_state rmx_weight 103 104 /* 105 * Keep a generation count of routing table, incremented on route addition, 106 * so we can invalidate caches. This is accessed without a lock, as precision 107 * is not required. 108 */ 109 typedef volatile u_int rt_gen_t; /* tree generation (for adds) */ 110 #define RT_GEN(fibnum, af) rt_tables_get_gen(fibnum, af) 111 112 #define RT_DEFAULT_FIB 0 /* Explicitly mark fib=0 restricted cases */ 113 #define RT_ALL_FIBS -1 /* Announce event for every fib */ 114 115 #include "net/radix.h" 116 117 #if defined(_KERNEL) || defined(_WANT_RTENTRY) 118 struct rtentry { 119 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 120 /* 121 * XXX struct rtentry must begin with a struct radix_node (or two!) 122 * because the code does some casts of a 'struct radix_node *' 123 * to a 'struct rtentry *' 124 */ 125 #define rt_key(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_key))) 126 #define rt_mask(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask))) 127 struct sockaddr *rt_gateway; /* value */ 128 struct ifnet *rt_ifp; /* the answer: interface to use */ 129 struct ifaddr *rt_ifa; /* the answer: interface address to use */ 130 int rt_flags; /* up/down?, host/net */ 131 int rt_refcnt; /* # held references */ 132 u_int rt_fibnum; /* which FIB */ 133 u_long rt_mtu; /* MTU for this path */ 134 u_long rt_weight; /* absolute weight */ 135 u_long rt_expire; /* lifetime for route, e.g. redirect */ 136 #define rt_endzero rt_pksent 137 counter_u64_t rt_pksent; /* packets sent using this route */ 138 struct mtx rt_mtx; /* mutex for routing entry */ 139 struct rtentry *rt_chain; /* pointer to next rtentry to delete */ 140 }; 141 #endif /* _KERNEL || _WANT_RTENTRY */ 142 143 #define RTF_UP 0x1 /* route usable */ 144 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 145 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 146 #define RTF_REJECT 0x8 /* host or net unreachable */ 147 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 148 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 149 #define RTF_DONE 0x40 /* message confirmed */ 150 /* 0x80 unused, was RTF_DELCLONE */ 151 /* 0x100 unused, was RTF_CLONING */ 152 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 153 #define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward 154 compatibility */ 155 #define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */ 156 #define RTF_STATIC 0x800 /* manually added */ 157 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 158 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 159 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 160 /* 0x10000 unused, was RTF_PRCLONING */ 161 /* 0x20000 unused, was RTF_WASCLONED */ 162 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 163 #define RTF_FIXEDMTU 0x80000 /* MTU was explicitly specified */ 164 #define RTF_PINNED 0x100000 /* route is immutable */ 165 #define RTF_LOCAL 0x200000 /* route represents a local address */ 166 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 167 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 168 /* 0x8000000 and up unassigned */ 169 #define RTF_STICKY 0x10000000 /* always route dst->src */ 170 171 #define RTF_RNH_LOCKED 0x40000000 /* unused */ 172 173 #define RTF_GWFLAG_COMPAT 0x80000000 /* a compatibility bit for interacting 174 with existing routing apps */ 175 176 /* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */ 177 #define RTF_FMASK \ 178 (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \ 179 RTF_REJECT | RTF_STATIC | RTF_STICKY) 180 181 /* 182 * fib_ nexthop API flags. 183 */ 184 185 /* Consumer-visible nexthop info flags */ 186 #define NHF_REJECT 0x0010 /* RTF_REJECT */ 187 #define NHF_BLACKHOLE 0x0020 /* RTF_BLACKHOLE */ 188 #define NHF_REDIRECT 0x0040 /* RTF_DYNAMIC|RTF_MODIFIED */ 189 #define NHF_DEFAULT 0x0080 /* Default route */ 190 #define NHF_BROADCAST 0x0100 /* RTF_BROADCAST */ 191 #define NHF_GATEWAY 0x0200 /* RTF_GATEWAY */ 192 193 /* Nexthop request flags */ 194 #define NHR_IFAIF 0x01 /* Return ifa_ifp interface */ 195 #define NHR_REF 0x02 /* For future use */ 196 197 /* Control plane route request flags */ 198 #define NHR_COPY 0x100 /* Copy rte data */ 199 200 #ifdef _KERNEL 201 /* rte<>ro_flags translation */ 202 static inline void 203 rt_update_ro_flags(struct route *ro) 204 { 205 int rt_flags = ro->ro_rt->rt_flags; 206 207 ro->ro_flags &= ~ (RT_REJECT|RT_BLACKHOLE|RT_HAS_GW); 208 209 ro->ro_flags |= (rt_flags & RTF_REJECT) ? RT_REJECT : 0; 210 ro->ro_flags |= (rt_flags & RTF_BLACKHOLE) ? RT_BLACKHOLE : 0; 211 ro->ro_flags |= (rt_flags & RTF_GATEWAY) ? RT_HAS_GW : 0; 212 } 213 #endif 214 215 /* 216 * Routing statistics. 217 */ 218 struct rtstat { 219 short rts_badredirect; /* bogus redirect calls */ 220 short rts_dynamic; /* routes created by redirects */ 221 short rts_newgateway; /* routes modified by redirects */ 222 short rts_unreach; /* lookups which failed */ 223 short rts_wildcard; /* lookups satisfied by a wildcard */ 224 }; 225 /* 226 * Structures for routing messages. 227 */ 228 struct rt_msghdr { 229 u_short rtm_msglen; /* to skip over non-understood messages */ 230 u_char rtm_version; /* future binary compatibility */ 231 u_char rtm_type; /* message type */ 232 u_short rtm_index; /* index for associated ifp */ 233 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 234 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 235 pid_t rtm_pid; /* identify sender */ 236 int rtm_seq; /* for sender to identify action */ 237 int rtm_errno; /* why failed */ 238 int rtm_fmask; /* bitmask used in RTM_CHANGE message */ 239 u_long rtm_inits; /* which metrics we are initializing */ 240 struct rt_metrics rtm_rmx; /* metrics themselves */ 241 }; 242 243 #define RTM_VERSION 5 /* Up the ante and ignore older versions */ 244 245 /* 246 * Message types. 247 */ 248 #define RTM_ADD 0x1 /* Add Route */ 249 #define RTM_DELETE 0x2 /* Delete Route */ 250 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ 251 #define RTM_GET 0x4 /* Report Metrics */ 252 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 253 #define RTM_REDIRECT 0x6 /* Told to use different route */ 254 #define RTM_MISS 0x7 /* Lookup failed on this address */ 255 #define RTM_LOCK 0x8 /* fix specified metrics */ 256 /* 0x9 */ 257 /* 0xa */ 258 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 259 #define RTM_NEWADDR 0xc /* address being added to iface */ 260 #define RTM_DELADDR 0xd /* address being removed from iface */ 261 #define RTM_IFINFO 0xe /* iface going up/down etc. */ 262 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ 263 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ 264 #define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */ 265 #define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */ 266 267 /* 268 * Bitmask values for rtm_inits and rmx_locks. 269 */ 270 #define RTV_MTU 0x1 /* init or lock _mtu */ 271 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 272 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 273 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 274 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 275 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 276 #define RTV_RTT 0x40 /* init or lock _rtt */ 277 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 278 #define RTV_WEIGHT 0x100 /* init or lock _weight */ 279 280 /* 281 * Bitmask values for rtm_addrs. 282 */ 283 #define RTA_DST 0x1 /* destination sockaddr present */ 284 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 285 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 286 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 287 #define RTA_IFP 0x10 /* interface name sockaddr present */ 288 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 289 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 290 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 291 292 /* 293 * Index offsets for sockaddr array for alternate internal encoding. 294 */ 295 #define RTAX_DST 0 /* destination sockaddr present */ 296 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ 297 #define RTAX_NETMASK 2 /* netmask sockaddr present */ 298 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 299 #define RTAX_IFP 4 /* interface name sockaddr present */ 300 #define RTAX_IFA 5 /* interface addr sockaddr present */ 301 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 302 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 303 #define RTAX_MAX 8 /* size of array to allocate */ 304 305 typedef int rt_filter_f_t(const struct rtentry *, void *); 306 307 struct rt_addrinfo { 308 int rti_addrs; /* Route RTF_ flags */ 309 int rti_flags; /* Route RTF_ flags */ 310 struct sockaddr *rti_info[RTAX_MAX]; /* Sockaddr data */ 311 struct ifaddr *rti_ifa; /* value of rt_ifa addr */ 312 struct ifnet *rti_ifp; /* route interface */ 313 rt_filter_f_t *rti_filter; /* filter function */ 314 void *rti_filterdata; /* filter paramenters */ 315 u_long rti_mflags; /* metrics RTV_ flags */ 316 u_long rti_spare; /* Will be used for fib */ 317 struct rt_metrics *rti_rmx; /* Pointer to route metrics */ 318 }; 319 320 /* 321 * This macro returns the size of a struct sockaddr when passed 322 * through a routing socket. Basically we round up sa_len to 323 * a multiple of sizeof(long), with a minimum of sizeof(long). 324 * The check for a NULL pointer is just a convenience, probably never used. 325 * The case sa_len == 0 should only apply to empty structures. 326 */ 327 #define SA_SIZE(sa) \ 328 ( (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ? \ 329 sizeof(long) : \ 330 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) ) 331 332 #define sa_equal(a, b) ( \ 333 (((const struct sockaddr *)(a))->sa_len == ((const struct sockaddr *)(b))->sa_len) && \ 334 (bcmp((a), (b), ((const struct sockaddr *)(b))->sa_len) == 0)) 335 336 #endif 337