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