1 /* $OpenBSD: route.h,v 1.12 2001/06/09 06:16:39 angelos 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. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)route.h 8.3 (Berkeley) 4/19/94 37 */ 38 39 #ifndef _NET_ROUTE_H_ 40 #define _NET_ROUTE_H_ 41 42 #include <sys/queue.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 u_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 struct rtentry *rt_parent; /* If cloned, parent of this route. */ 112 LIST_HEAD(, rttimer) rt_timer; /* queue of timeouts for misc funcs */ 113 }; 114 #define rt_use rt_rmx.rmx_pksent 115 116 /* 117 * Following structure necessary for 4.3 compatibility; 118 * We should eventually move it to a compat file. 119 */ 120 struct ortentry { 121 u_int32_t rt_hash; /* to speed lookups */ 122 struct sockaddr rt_dst; /* key */ 123 struct sockaddr rt_gateway; /* value */ 124 int16_t rt_flags; /* up/down?, host/net */ 125 int16_t rt_refcnt; /* # held references */ 126 u_int32_t rt_ouse; /* raw # packets forwarded (was: rt_use) */ 127 struct ifnet *rt_ifp; /* the answer: interface to use */ 128 }; 129 130 #define RTF_UP 0x1 /* route usable */ 131 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 132 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 133 #define RTF_REJECT 0x8 /* host or net unreachable */ 134 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 135 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 136 #define RTF_DONE 0x40 /* message confirmed */ 137 #define RTF_MASK 0x80 /* subnet mask present */ 138 #define RTF_CLONING 0x100 /* generate new routes on use */ 139 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 140 #define RTF_LLINFO 0x400 /* generated by ARP or ESIS */ 141 #define RTF_STATIC 0x800 /* manually added */ 142 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 143 #define RTF_PROTO3 0x2000 /* protocol specific routing flag */ 144 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 145 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 146 147 #ifndef _KERNEL 148 /* obsoleted */ 149 #define RTF_TUNNEL 0x100000 /* Tunnelling bit. */ 150 #endif 151 152 /* 153 * Routing statistics. 154 */ 155 struct rtstat { 156 u_int32_t rts_badredirect; /* bogus redirect calls */ 157 u_int32_t rts_dynamic; /* routes created by redirects */ 158 u_int32_t rts_newgateway; /* routes modified by redirects */ 159 u_int32_t rts_unreach; /* lookups which failed */ 160 u_int32_t rts_wildcard; /* lookups satisfied by a wildcard */ 161 }; 162 163 /* 164 * Structures for routing messages. 165 */ 166 struct rt_msghdr { 167 u_short rtm_msglen; /* to skip over non-understood messages */ 168 u_char rtm_version; /* future binary compatibility */ 169 u_char rtm_type; /* message type */ 170 u_short rtm_index; /* index for associated ifp */ 171 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 172 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 173 pid_t rtm_pid; /* identify sender */ 174 int rtm_seq; /* for sender to identify action */ 175 int rtm_errno; /* why failed */ 176 int rtm_use; /* from rtentry */ 177 u_long rtm_inits; /* which metrics we are initializing */ 178 struct rt_metrics rtm_rmx; /* metrics themselves */ 179 }; 180 181 #define RTM_VERSION 3 /* Up the ante and ignore older versions */ 182 183 #define RTM_ADD 0x1 /* Add Route */ 184 #define RTM_DELETE 0x2 /* Delete Route */ 185 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ 186 #define RTM_GET 0x4 /* Report Metrics */ 187 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 188 #define RTM_REDIRECT 0x6 /* Told to use different route */ 189 #define RTM_MISS 0x7 /* Lookup failed on this address */ 190 #define RTM_LOCK 0x8 /* fix specified metrics */ 191 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 192 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 193 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 194 #define RTM_NEWADDR 0xc /* address being added to iface */ 195 #define RTM_DELADDR 0xd /* address being removed from iface */ 196 #define RTM_IFINFO 0xe /* iface going up/down etc. */ 197 198 #define RTV_MTU 0x1 /* init or lock _mtu */ 199 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 200 #define RTV_EXPIRE 0x4 /* init or lock _hopcount */ 201 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 202 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 203 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 204 #define RTV_RTT 0x40 /* init or lock _rtt */ 205 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 206 207 /* 208 * Bitmask values for rtm_addr. 209 */ 210 #define RTA_DST 0x1 /* destination sockaddr present */ 211 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 212 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 213 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 214 #define RTA_IFP 0x10 /* interface name sockaddr present */ 215 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 216 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 217 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 218 219 /* 220 * Index offsets for sockaddr array for alternate internal encoding. 221 */ 222 #define RTAX_DST 0 /* destination sockaddr present */ 223 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ 224 #define RTAX_NETMASK 2 /* netmask sockaddr present */ 225 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 226 #define RTAX_IFP 4 /* interface name sockaddr present */ 227 #define RTAX_IFA 5 /* interface addr sockaddr present */ 228 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 229 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 230 #define RTAX_MAX 8 /* size of array to allocate */ 231 232 struct rt_addrinfo { 233 int rti_addrs; 234 struct sockaddr *rti_info[RTAX_MAX]; 235 int rti_flags; 236 struct ifaddr *rti_ifa; 237 struct ifnet *rti_ifp; 238 struct rt_msghdr *rti_rtm; 239 }; 240 241 struct route_cb { 242 int ip_count; 243 int ip6_count; 244 int ns_count; 245 int iso_count; 246 int any_count; 247 }; 248 249 /* 250 * This structure, and the prototypes for the rt_timer_{init,remove_all, 251 * add,timer} functions all used with the kind permission of BSDI. 252 * These allow functions to be called for routes at specific times. 253 */ 254 255 struct rttimer { 256 TAILQ_ENTRY(rttimer) rtt_next; /* entry on timer queue */ 257 LIST_ENTRY(rttimer) rtt_link; /* multiple timers per rtentry */ 258 struct rttimer_queue *rtt_queue;/* back pointer to queue */ 259 struct rtentry *rtt_rt; /* Back pointer to the route */ 260 void (*rtt_func) __P((struct rtentry *, 261 struct rttimer *)); 262 time_t rtt_time; /* When this timer was registered */ 263 }; 264 265 struct rttimer_queue { 266 long rtq_timeout; 267 unsigned long rtq_count; 268 TAILQ_HEAD(, rttimer) rtq_head; 269 LIST_ENTRY(rttimer_queue) rtq_link; 270 }; 271 272 #ifdef _KERNEL 273 #define RTFREE(rt) do { \ 274 if ((rt)->rt_refcnt <= 1) \ 275 rtfree(rt); \ 276 else \ 277 (rt)->rt_refcnt--; \ 278 } while (0) 279 280 /* 281 * Values for additional argument to rtalloc_noclone() and rtalloc2() 282 */ 283 #define ALL_CLONING 0 284 #define ONNET_CLONING 1 285 #define NO_CLONING 2 286 287 struct route_cb route_cb; 288 struct rtstat rtstat; 289 struct radix_node_head *rt_tables[AF_MAX+1]; 290 291 struct socket; 292 void route_init __P((void)); 293 int route_output __P((struct mbuf *, ...)); 294 int route_usrreq __P((struct socket *, int, struct mbuf *, 295 struct mbuf *, struct mbuf *)); 296 void rt_ifmsg __P((struct ifnet *)); 297 void rt_maskedcopy __P((struct sockaddr *, 298 struct sockaddr *, struct sockaddr *)); 299 void rt_missmsg __P((int, struct rt_addrinfo *, int, int)); 300 void rt_newaddrmsg __P((int, struct ifaddr *, int, struct rtentry *)); 301 int rt_setgate __P((struct rtentry *, struct sockaddr *, 302 struct sockaddr *)); 303 void rt_setmetrics __P((u_long, struct rt_metrics *, struct rt_metrics *)); 304 int rt_timer_add __P((struct rtentry *, 305 void(*)(struct rtentry *, struct rttimer *), 306 struct rttimer_queue *)); 307 void rt_timer_init __P((void)); 308 struct rttimer_queue * 309 rt_timer_queue_create __P((u_int)); 310 void rt_timer_queue_change __P((struct rttimer_queue *, long)); 311 void rt_timer_queue_destroy __P((struct rttimer_queue *, int)); 312 void rt_timer_remove_all __P((struct rtentry *)); 313 unsigned long rt_timer_count __P((struct rttimer_queue *)); 314 void rt_timer_timer __P((void *)); 315 void rtable_init __P((void **)); 316 void rtalloc __P((struct route *)); 317 struct rtentry * 318 rtalloc1 __P((struct sockaddr *, int)); 319 void rtalloc_noclone __P((struct route *, int)); 320 struct rtentry * 321 rtalloc2 __P((struct sockaddr *, int, int)); 322 void rtfree __P((struct rtentry *)); 323 int rt_getifa __P((struct rt_addrinfo *)); 324 int rtinit __P((struct ifaddr *, int, int)); 325 int rtioctl __P((u_long, caddr_t, struct proc *)); 326 void rtredirect __P((struct sockaddr *, struct sockaddr *, 327 struct sockaddr *, int, struct sockaddr *, 328 struct rtentry **)); 329 int rtrequest __P((int, struct sockaddr *, 330 struct sockaddr *, struct sockaddr *, int, 331 struct rtentry **)); 332 int rtrequest1 __P((int, struct rt_addrinfo *, struct rtentry **)); 333 #endif /* _KERNEL */ 334 #endif /* _NET_ROUTE_H_ */ 335