1 /* $NetBSD: route.h,v 1.43 2005/12/11 12:24:52 christos Exp $ */ 2 3 /* 4 * Copyright (c) 1980, 1986, 1993 5 * The Regents of the University of California. All rights reserved. 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 University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)route.h 8.5 (Berkeley) 2/8/95 32 */ 33 34 #ifndef _NET_ROUTE_H_ 35 #define _NET_ROUTE_H_ 36 37 #include <sys/queue.h> 38 #include <sys/socket.h> 39 40 /* 41 * Kernel resident routing tables. 42 * 43 * The routing tables are initialized when interface addresses 44 * are set by making entries for all directly connected interfaces. 45 */ 46 47 /* 48 * A route consists of a destination address and a reference 49 * to a routing entry. These are often held by protocols 50 * in their control blocks, e.g. inpcb. 51 */ 52 struct route { 53 struct rtentry *ro_rt; 54 struct sockaddr ro_dst; 55 }; 56 57 /* 58 * These numbers are used by reliable protocols for determining 59 * retransmission behavior and are included in the routing structure. 60 */ 61 struct rt_metrics { 62 u_long rmx_locks; /* Kernel must leave these values alone */ 63 u_long rmx_mtu; /* MTU for this path */ 64 u_long rmx_hopcount; /* max hops expected */ 65 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 66 u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 67 u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 68 u_long rmx_ssthresh; /* outbound gateway buffer limit */ 69 u_long rmx_rtt; /* estimated round trip time */ 70 u_long rmx_rttvar; /* estimated rtt variance */ 71 u_long rmx_pksent; /* packets sent using this route */ 72 }; 73 74 /* 75 * rmx_rtt and rmx_rttvar are stored as microseconds; 76 * RTTTOPRHZ(rtt) converts to a value suitable for use 77 * by a protocol slowtimo counter. 78 */ 79 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 80 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 81 82 /* 83 * We distinguish between routes to hosts and routes to networks, 84 * preferring the former if available. For each route we infer 85 * the interface to use from the gateway address supplied when 86 * the route was entered. Routes that forward packets through 87 * gateways are marked so that the output routines know to address the 88 * gateway rather than the ultimate destination. 89 */ 90 #ifndef RNF_NORMAL 91 #include <net/radix.h> 92 #endif 93 struct rtentry { 94 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 95 /*XXXUNCONST*/ 96 #define rt_key(r) ((struct sockaddr *)__UNCONST((r)->rt_nodes->rn_key)) 97 /*XXXUNCONST*/ 98 #define rt_mask(r) ((struct sockaddr *)__UNCONST((r)->rt_nodes->rn_mask)) 99 struct sockaddr *rt_gateway; /* value */ 100 int rt_flags; /* up/down?, host/net */ 101 int rt_refcnt; /* # held references */ 102 u_long rt_use; /* raw # packets forwarded */ 103 struct ifnet *rt_ifp; /* the answer: interface to use */ 104 struct ifaddr *rt_ifa; /* the answer: interface to use */ 105 const struct sockaddr *rt_genmask; /* for generation of cloned routes */ 106 caddr_t rt_llinfo; /* pointer to link level info cache */ 107 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ 108 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 109 LIST_HEAD(, rttimer) rt_timer; /* queue of timeouts for misc funcs */ 110 struct rtentry *rt_parent; /* parent of cloned route */ 111 }; 112 113 /* 114 * Following structure necessary for 4.3 compatibility; 115 * We should eventually move it to a compat file. 116 */ 117 struct ortentry { 118 u_int32_t rt_hash; /* to speed lookups */ 119 struct sockaddr rt_dst; /* key */ 120 struct sockaddr rt_gateway; /* value */ 121 int16_t rt_flags; /* up/down?, host/net */ 122 int16_t rt_refcnt; /* # held references */ 123 u_int32_t rt_use; /* raw # packets forwarded */ 124 struct ifnet *rt_ifp; /* the answer: interface to use */ 125 }; 126 127 #define RTF_UP 0x1 /* route usable */ 128 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 129 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 130 #define RTF_REJECT 0x8 /* host or net unreachable */ 131 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 132 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 133 #define RTF_DONE 0x40 /* message confirmed */ 134 #define RTF_MASK 0x80 /* subnet mask present */ 135 #define RTF_CLONING 0x100 /* generate new routes on use */ 136 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 137 #define RTF_LLINFO 0x400 /* generated by ARP or ESIS */ 138 #define RTF_STATIC 0x800 /* manually added */ 139 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 140 #define RTF_CLONED 0x2000 /* this is a cloned route */ 141 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 142 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 143 144 145 /* 146 * Routing statistics. 147 */ 148 struct rtstat { 149 u_quad_t rts_badredirect; /* bogus redirect calls */ 150 u_quad_t rts_dynamic; /* routes created by redirects */ 151 u_quad_t rts_newgateway; /* routes modified by redirects */ 152 u_quad_t rts_unreach; /* lookups which failed */ 153 u_quad_t rts_wildcard; /* lookups satisfied by a wildcard */ 154 }; 155 /* 156 * Structures for routing messages. 157 */ 158 struct rt_msghdr { 159 u_short rtm_msglen; /* to skip over non-understood messages */ 160 u_char rtm_version; /* future binary compatibility */ 161 u_char rtm_type; /* message type */ 162 u_short rtm_index; /* index for associated ifp */ 163 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 164 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 165 pid_t rtm_pid; /* identify sender */ 166 int rtm_seq; /* for sender to identify action */ 167 int rtm_errno; /* why failed */ 168 int rtm_use; /* from rtentry */ 169 u_long rtm_inits; /* which metrics we are initializing */ 170 struct rt_metrics rtm_rmx; /* metrics themselves */ 171 }; 172 173 #define RTM_VERSION 3 /* Up the ante and ignore older versions */ 174 175 #define RTM_ADD 0x1 /* Add Route */ 176 #define RTM_DELETE 0x2 /* Delete Route */ 177 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ 178 #define RTM_GET 0x4 /* Report Metrics */ 179 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 180 #define RTM_REDIRECT 0x6 /* Told to use different route */ 181 #define RTM_MISS 0x7 /* Lookup failed on this address */ 182 #define RTM_LOCK 0x8 /* fix specified metrics */ 183 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 184 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 185 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 186 #define RTM_NEWADDR 0xc /* address being added to iface */ 187 #define RTM_DELADDR 0xd /* address being removed from iface */ 188 #define RTM_OIFINFO 0xe /* Old (pre-1.5) RTM_IFINFO message */ 189 #define RTM_IFINFO 0xf /* iface/link going up/down etc. */ 190 #define RTM_IFANNOUNCE 0x10 /* iface arrival/departure */ 191 #define RTM_IEEE80211 0x11 /* IEEE80211 wireless event */ 192 193 #define RTV_MTU 0x1 /* init or lock _mtu */ 194 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 195 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 196 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 197 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 198 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 199 #define RTV_RTT 0x40 /* init or lock _rtt */ 200 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 201 202 /* 203 * Bitmask values for rtm_addr. 204 */ 205 #define RTA_DST 0x1 /* destination sockaddr present */ 206 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 207 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 208 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 209 #define RTA_IFP 0x10 /* interface name sockaddr present */ 210 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 211 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 212 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 213 214 /* 215 * Index offsets for sockaddr array for alternate internal encoding. 216 */ 217 #define RTAX_DST 0 /* destination sockaddr present */ 218 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ 219 #define RTAX_NETMASK 2 /* netmask sockaddr present */ 220 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 221 #define RTAX_IFP 4 /* interface name sockaddr present */ 222 #define RTAX_IFA 5 /* interface addr sockaddr present */ 223 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 224 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 225 #define RTAX_MAX 8 /* size of array to allocate */ 226 227 struct rt_addrinfo { 228 int rti_addrs; 229 const struct sockaddr *rti_info[RTAX_MAX]; 230 int rti_flags; 231 struct ifaddr *rti_ifa; 232 struct ifnet *rti_ifp; 233 struct rt_msghdr *rti_rtm; 234 }; 235 236 struct route_cb { 237 int ip_count; 238 int ip6_count; 239 int ipx_count; 240 int ns_count; 241 int iso_count; 242 int any_count; 243 }; 244 245 /* 246 * This structure, and the prototypes for the rt_timer_{init,remove_all, 247 * add,timer} functions all used with the kind permission of BSDI. 248 * These allow functions to be called for routes at specific times. 249 */ 250 251 struct rttimer { 252 TAILQ_ENTRY(rttimer) rtt_next; /* entry on timer queue */ 253 LIST_ENTRY(rttimer) rtt_link; /* multiple timers per rtentry */ 254 struct rttimer_queue *rtt_queue; /* back pointer to queue */ 255 struct rtentry *rtt_rt; /* Back pointer to the route */ 256 void (*rtt_func)(struct rtentry *, struct rttimer *); 257 time_t rtt_time; /* When this timer was registered */ 258 }; 259 260 struct rttimer_queue { 261 long rtq_timeout; 262 unsigned long rtq_count; 263 TAILQ_HEAD(, rttimer) rtq_head; 264 LIST_ENTRY(rttimer_queue) rtq_link; 265 }; 266 267 268 #ifdef _KERNEL 269 #define RTFREE(rt) \ 270 do { \ 271 if ((rt)->rt_refcnt <= 1) \ 272 rtfree(rt); \ 273 else \ 274 (rt)->rt_refcnt--; \ 275 } while (/*CONSTCOND*/ 0) 276 277 extern struct route_cb route_cb; 278 extern struct rtstat rtstat; 279 extern struct radix_node_head *rt_tables[AF_MAX+1]; 280 281 struct socket; 282 283 void route_init(void); 284 int route_output(struct mbuf *, ...); 285 int route_usrreq(struct socket *, 286 int, struct mbuf *, struct mbuf *, struct mbuf *, struct lwp *); 287 void rt_ifannouncemsg(struct ifnet *, int); 288 void rt_ieee80211msg(struct ifnet *, int, void *, size_t); 289 void rt_ifmsg(struct ifnet *); 290 void rt_maskedcopy(const struct sockaddr *, 291 struct sockaddr *, const struct sockaddr *); 292 void rt_missmsg(int, struct rt_addrinfo *, int, int); 293 void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *); 294 int rt_setgate(struct rtentry *, 295 const struct sockaddr *, const struct sockaddr *); 296 void rt_setmetrics(u_long, const struct rt_metrics *, struct rt_metrics *); 297 int rt_timer_add(struct rtentry *, 298 void(*)(struct rtentry *, struct rttimer *), 299 struct rttimer_queue *); 300 void rt_timer_init(void); 301 struct rttimer_queue * 302 rt_timer_queue_create(u_int); 303 void rt_timer_queue_change(struct rttimer_queue *, long); 304 void rt_timer_queue_remove_all(struct rttimer_queue *, int); 305 void rt_timer_queue_destroy(struct rttimer_queue *, int); 306 void rt_timer_remove_all(struct rtentry *, int); 307 unsigned long rt_timer_count(struct rttimer_queue *); 308 void rt_timer_timer(void *); 309 void rtable_init(void **); 310 void rtalloc(struct route *); 311 struct rtentry * 312 rtalloc1(const struct sockaddr *, int); 313 void rtfree(struct rtentry *); 314 int rt_getifa(struct rt_addrinfo *); 315 int rtinit(struct ifaddr *, int, int); 316 int rtioctl(u_long, caddr_t, struct lwp *); 317 void rtredirect(const struct sockaddr *, const struct sockaddr *, 318 const struct sockaddr *, int, const struct sockaddr *, 319 struct rtentry **); 320 int rtrequest(int, const struct sockaddr *, 321 const struct sockaddr *, const struct sockaddr *, int, 322 struct rtentry **); 323 int rtrequest1(int, struct rt_addrinfo *, struct rtentry **); 324 #endif /* _KERNEL */ 325 #endif /* !_NET_ROUTE_H_ */ 326