1 /* 2 * Copyright (c) 2004, 2005 The DragonFly Project. All rights reserved. 3 * 4 * This code is derived from software contributed to The DragonFly Project 5 * by Jeffrey M. Hsu. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of The DragonFly Project nor the names of its 16 * contributors may be used to endorse or promote products derived 17 * from this software without specific, prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 22 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 23 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 24 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 25 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 27 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 29 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 */ 32 33 /* 34 * Copyright (c) 1980, 1986, 1993 35 * The Regents of the University of California. All rights reserved. 36 * 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions 39 * are met: 40 * 1. Redistributions of source code must retain the above copyright 41 * notice, this list of conditions and the following disclaimer. 42 * 2. Redistributions in binary form must reproduce the above copyright 43 * notice, this list of conditions and the following disclaimer in the 44 * documentation and/or other materials provided with the distribution. 45 * 3. All advertising materials mentioning features or use of this software 46 * must display the following acknowledgement: 47 * This product includes software developed by the University of 48 * California, Berkeley and its contributors. 49 * 4. Neither the name of the University nor the names of its contributors 50 * may be used to endorse or promote products derived from this software 51 * without specific prior written permission. 52 * 53 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 54 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 55 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 56 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 57 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 58 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 59 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 60 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 61 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 62 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 63 * SUCH DAMAGE. 64 * 65 * @(#)route.h 8.4 (Berkeley) 1/9/95 66 * $FreeBSD: src/sys/net/route.h,v 1.36.2.5 2002/02/01 11:48:01 ru Exp $ 67 * $DragonFly: src/sys/net/route.h,v 1.24 2008/09/11 11:23:29 sephe Exp $ 68 */ 69 70 #ifndef _NET_ROUTE_H_ 71 #define _NET_ROUTE_H_ 72 73 #ifndef _SYS_TYPES_H_ 74 #include <sys/types.h> 75 #endif 76 #ifndef _SYS_PARAM_H_ 77 #include <sys/param.h> 78 #endif 79 #ifndef _SYS_SOCKET_H_ 80 #include <sys/socket.h> 81 #endif 82 83 /* 84 * Kernel resident routing tables. 85 * 86 * The routing tables are initialized when interface addresses 87 * are set by making entries for all directly connected interfaces. 88 */ 89 90 /* 91 * A route consists of a destination address and a reference 92 * to a routing entry. These are often held by protocols 93 * in their control blocks, e.g. inpcb. 94 */ 95 struct route { 96 struct rtentry *ro_rt; 97 struct sockaddr ro_dst; 98 }; 99 100 /* 101 * These numbers are used by reliable protocols for determining 102 * retransmission behavior and are included in the routing structure. 103 */ 104 struct rt_metrics { /* grouped for locality of reference */ 105 u_long rmx_locks; /* Kernel must leave these values alone */ 106 u_long rmx_mtu; /* MTU for this path */ 107 u_long rmx_pksent; /* packets sent using this route */ 108 u_long rmx_expire; /* lifetime for route */ 109 110 u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 111 u_long rmx_ssthresh; /* outbound gateway buffer limit */ 112 u_long rmx_rtt; /* estimated round trip time */ 113 u_long rmx_rttvar; /* estimated rtt variance */ 114 115 u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 116 u_long rmx_hopcount; /* max hops expected */ 117 u_long rmx_filler[4]; /* will be used for T/TCP later */ 118 }; 119 120 /* 121 * rmx_rtt and rmx_rttvar are stored as microseconds; 122 * RTTTOPRHZ(rtt) converts to a value suitable for use 123 * by a protocol slowtimo counter. 124 */ 125 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 126 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 127 128 /* 129 * XXX kernel function pointer `rt_output' is visible to applications. 130 */ 131 struct mbuf; 132 133 /* 134 * We distinguish between routes to hosts and routes to networks, 135 * preferring the former if available. For each route we infer 136 * the interface to use from the gateway address supplied when 137 * the route was entered. Routes that forward packets through 138 * gateways are marked so that the output routines know to address the 139 * gateway rather than the ultimate destination. 140 */ 141 #ifndef RNF_NORMAL 142 #include <net/radix.h> 143 #endif 144 145 struct rtentry { 146 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 147 #define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key)) 148 #define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask)) 149 struct sockaddr *rt_gateway; /* value */ 150 long rt_refcnt; /* # held references */ 151 u_long rt_flags; /* up/down?, host/net */ 152 struct ifnet *rt_ifp; /* the answer: interface to use */ 153 struct ifaddr *rt_ifa; /* the answer: interface to use */ 154 struct sockaddr *rt_genmask; /* for generation of cloned routes */ 155 void *rt_llinfo; /* pointer to link level info cache */ 156 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ 157 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 158 int (*rt_output) (struct ifnet *, struct mbuf *, struct sockaddr *, 159 struct rtentry *); 160 /* output routine for this (rt,if) */ 161 struct rtentry *rt_parent; /* cloning parent of this route */ 162 int rt_cpuid; /* owner cpu */ 163 struct sockaddr *rt_shim[3]; /* mpls label / operation array */ 164 }; 165 166 /* 167 * Following structure necessary for 4.3 compatibility; 168 * We should eventually move it to a compat file. 169 */ 170 struct ortentry { 171 u_long rt_hash; /* to speed lookups */ 172 struct sockaddr rt_dst; /* key */ 173 struct sockaddr rt_gateway; /* value */ 174 short rt_flags; /* up/down?, host/net */ 175 short rt_refcnt; /* # held references */ 176 u_long rt_use; /* raw # packets forwarded */ 177 struct ifnet *rt_ifp; /* the answer: interface to use */ 178 }; 179 180 #define rt_use rt_rmx.rmx_pksent 181 182 #define RTF_UP 0x1 /* route usable */ 183 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 184 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 185 #define RTF_REJECT 0x8 /* host or net unreachable */ 186 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 187 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 188 #define RTF_DONE 0x40 /* message confirmed */ 189 /* 0x80 unused, was RTF_DELCLONE */ 190 #define RTF_CLONING 0x100 /* generate new routes on use */ 191 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 192 #define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */ 193 #define RTF_STATIC 0x800 /* manually added */ 194 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 195 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 196 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 197 198 #define RTF_PRCLONING 0x10000 /* protocol requires cloning */ 199 #define RTF_WASCLONED 0x20000 /* route generated through cloning */ 200 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 201 /* 0x80000 unused */ 202 #define RTF_PINNED 0x100000 /* future use */ 203 #define RTF_LOCAL 0x200000 /* route represents a local address */ 204 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 205 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 206 #define RTF_MPLSOPS 0x1000000 /* route uses mpls label operations */ 207 /* 0x2000000 and up unassigned */ 208 209 /* 210 * Routing statistics. 211 */ 212 struct rtstatistics { 213 u_long rts_badredirect; /* bogus redirect calls */ 214 u_long rts_dynamic; /* routes created by redirects */ 215 u_long rts_newgateway; /* routes modified by redirects */ 216 u_long rts_unreach; /* lookups which failed */ 217 u_long rts_wildcard; /* lookups satisfied by a wildcard */ 218 }; 219 /* 220 * Structures for routing messages. 221 */ 222 struct rt_msghdr { 223 u_short rtm_msglen; /* to skip over non-understood messages */ 224 u_char rtm_version; /* future binary compatibility */ 225 u_char rtm_type; /* message type */ 226 u_short rtm_index; /* index for associated ifp */ 227 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 228 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 229 pid_t rtm_pid; /* identify sender */ 230 int rtm_seq; /* for sender to identify action */ 231 int rtm_errno; /* why failed */ 232 int rtm_use; /* from rtentry */ 233 u_long rtm_inits; /* which metrics we are initializing */ 234 struct rt_metrics rtm_rmx; /* metrics themselves */ 235 }; 236 237 #define RTM_VERSION 6 /* Up the ante and ignore older versions */ 238 239 /* 240 * Message types. 241 */ 242 #define RTM_ADD 0x1 /* Add Route */ 243 #define RTM_DELETE 0x2 /* Delete Route */ 244 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ 245 #define RTM_GET 0x4 /* Report Metrics */ 246 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 247 #define RTM_REDIRECT 0x6 /* Told to use different route */ 248 #define RTM_MISS 0x7 /* Lookup failed on this address */ 249 #define RTM_LOCK 0x8 /* fix specified metrics */ 250 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 251 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 252 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 253 #define RTM_NEWADDR 0xc /* address being added to iface */ 254 #define RTM_DELADDR 0xd /* address being removed from iface */ 255 #define RTM_IFINFO 0xe /* iface going up/down etc. */ 256 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ 257 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ 258 #define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */ 259 #define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */ 260 261 /* 262 * Bitmask values for rtm_inits and rmx_locks. 263 */ 264 #define RTV_MTU 0x1 /* init or lock _mtu */ 265 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 266 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 267 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 268 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 269 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 270 #define RTV_RTT 0x40 /* init or lock _rtt */ 271 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 272 273 /* 274 * Bitmask values for rtm_addrs. 275 */ 276 #define RTA_DST 0x1 /* destination sockaddr present */ 277 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 278 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 279 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 280 #define RTA_IFP 0x10 /* interface name sockaddr present */ 281 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 282 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 283 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 284 #define RTA_MPLS1 0x100 /* mpls label and/or operation present */ 285 #define RTA_MPLS2 0x200 /* mpls label and/or operation present */ 286 #define RTA_MPLS3 0x400 /* mpls label and/or operation present */ 287 288 /* 289 * Index offsets for sockaddr array for alternate internal encoding. 290 */ 291 #define RTAX_DST 0 /* destination sockaddr present */ 292 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ 293 #define RTAX_NETMASK 2 /* netmask sockaddr present */ 294 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 295 #define RTAX_IFP 4 /* interface name sockaddr present */ 296 #define RTAX_IFA 5 /* interface addr sockaddr present */ 297 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 298 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 299 #define RTAX_MPLS1 8 /* mpls label and/or operation present */ 300 #define RTAX_MPLS2 9 /* mpls label and/or operation present */ 301 #define RTAX_MPLS3 10 /* mpls label and/or operation present */ 302 #define RTAX_MAX 11 /* size of array to allocate */ 303 304 struct rt_addrinfo { 305 int rti_addrs; 306 struct sockaddr *rti_info[RTAX_MAX]; 307 int rti_flags; 308 struct ifaddr *rti_ifa; 309 struct ifnet *rti_ifp; 310 }; 311 312 #ifdef _KERNEL 313 314 #define rti_dst rti_info[RTAX_DST] 315 #define rti_gateway rti_info[RTAX_GATEWAY] 316 #define rti_netmask rti_info[RTAX_NETMASK] 317 #define rti_genmask rti_info[RTAX_GENMASK] 318 #define rti_ifpaddr rti_info[RTAX_IFP] 319 #define rti_ifaaddr rti_info[RTAX_IFA] 320 #define rti_author rti_info[RTAX_AUTHOR] 321 #define rti_bcastaddr rti_info[RTAX_BRD] 322 #define rti_mpls1 rti_info[RTAX_MPLS1] 323 #define rti_mpls2 rti_info[RTAX_MPLS2] 324 #define rti_mpls3 rti_info[RTAX_MPLS3] 325 326 extern struct radix_node_head *rt_tables[MAXCPU][AF_MAX+1]; 327 extern struct lwkt_port *rt_ports[MAXCPU]; 328 329 struct ifmultiaddr; 330 struct proc; 331 struct ucred; 332 333 void route_init (void); 334 void rt_dstmsg(int type, struct sockaddr *dst, int error); 335 int rt_getifa (struct rt_addrinfo *); 336 void rt_ieee80211msg(struct ifnet *, int, void *, size_t); 337 void rt_ifannouncemsg (struct ifnet *, int); 338 void rt_ifmsg (struct ifnet *); 339 int rt_llroute (struct sockaddr *dst, struct rtentry *rt0, 340 struct rtentry **drt); 341 void rt_missmsg (int, struct rt_addrinfo *, int, int); 342 void rt_newaddrmsg (int, struct ifaddr *, int, struct rtentry *); 343 void rt_newmaddrmsg (int, struct ifmultiaddr *); 344 void rt_rtmsg(int cmd, struct rtentry *rt, struct ifnet *ifp, int error); 345 int rt_setgate (struct rtentry *, 346 struct sockaddr *, struct sockaddr *, boolean_t); 347 void rtalloc (struct route *); 348 void rtalloc_ign (struct route *, u_long); 349 350 struct rtentry * 351 _rtlookup (struct sockaddr *, __boolean_t, u_long); 352 #define RTL_REPORTMSG TRUE 353 #define RTL_DONTREPORT FALSE 354 355 /* flags to ignore */ 356 #define RTL_DOCLONE 0UL 357 #define RTL_DONTCLONE (RTF_CLONING | RTF_PRCLONING) 358 359 /* 360 * Look up a route with no cloning side-effects or miss reports generated. 361 */ 362 static __inline struct rtentry * 363 rtpurelookup(struct sockaddr *dst) 364 { 365 return _rtlookup(dst, RTL_DONTREPORT, RTL_DONTCLONE); 366 } 367 368 /* 369 * Do full route lookup with cloning and reporting on misses. 370 */ 371 static __inline struct rtentry * 372 rtlookup(struct sockaddr *dst) 373 { 374 return _rtlookup(dst, RTL_REPORTMSG, RTL_DOCLONE); 375 } 376 377 typedef void (*rtrequest1_callback_func_t)(int, int, struct rt_addrinfo *, 378 struct rtentry *, void *); 379 typedef int (*rtsearch_callback_func_t)(int, struct rt_addrinfo *, 380 struct rtentry *, void *, int); 381 382 void rtfree (struct rtentry *); 383 int rtinit (struct ifaddr *, int, int); 384 int rtioctl (u_long, caddr_t, struct ucred *); 385 void rtredirect (struct sockaddr *, struct sockaddr *, 386 struct sockaddr *, int, struct sockaddr *); 387 int rtrequest (int, struct sockaddr *, 388 struct sockaddr *, struct sockaddr *, int, struct rtentry **); 389 int rtrequest_global (int, struct sockaddr *, 390 struct sockaddr *, struct sockaddr *, int); 391 int rtrequest1 (int, struct rt_addrinfo *, struct rtentry **); 392 int rtrequest1_global (int, struct rt_addrinfo *, rtrequest1_callback_func_t, void *); 393 394 #define RTS_EXACTMATCH TRUE 395 #define RTS_NOEXACTMATCH FALSE 396 397 int rtsearch_global(int, struct rt_addrinfo *, 398 rtsearch_callback_func_t, void *, boolean_t); 399 400 int rtmask_add_global(struct sockaddr *); 401 402 struct sockaddr *_rtmask_lookup(struct sockaddr *, boolean_t); 403 404 static __inline struct sockaddr * 405 rtmask_lookup(struct sockaddr *_mask) 406 { 407 return _rtmask_lookup(_mask, FALSE); 408 } 409 410 static __inline struct sockaddr * 411 rtmask_purelookup(struct sockaddr *_mask) 412 { 413 return _rtmask_lookup(_mask, TRUE); 414 } 415 416 void rtfree_oncpu(struct rtentry *); 417 void rtfree_remote(struct rtentry *, int); 418 void rt_print(struct rt_addrinfo *, struct rtentry *); 419 void rt_addrinfo_print(int cmd, struct rt_addrinfo *); 420 void sockaddr_print(struct sockaddr *); 421 422 #ifndef _SYS_GLOBALDATA_H_ 423 #include <sys/globaldata.h> 424 #endif 425 426 static __inline void 427 RTFREE(struct rtentry *rt) 428 { 429 if (rt->rt_cpuid == mycpuid) { 430 if (rt->rt_refcnt <= 1) 431 rtfree_oncpu(rt); 432 else 433 --rt->rt_refcnt; 434 } else { 435 rtfree_remote(rt, 1); 436 } 437 } 438 439 static __inline 440 struct lwkt_port * 441 rtable_portfn(int cpu) 442 { 443 return (rt_ports[cpu]); 444 } 445 446 int in_inithead(void **, int); 447 #endif 448 449 #endif 450