2 * Copyright (c) 1980, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * @(#)route.h 8.4 (Berkeley) 1/9/95
34 * $FreeBSD: src/sys/net/route.h,v 1.36.2.5 2002/02/01 11:48:01 ru Exp $
35 * $DragonFly: src/sys/net/route.h,v 1.9 2005/01/06 09:14:13 hsu Exp $
42 * Kernel resident routing tables.
44 * The routing tables are initialized when interface addresses
45 * are set by making entries for all directly connected interfaces.
49 * A route consists of a destination address and a reference
50 * to a routing entry. These are often held by protocols
51 * in their control blocks, e.g. inpcb.
54 struct rtentry *ro_rt;
55 struct sockaddr ro_dst;
59 * These numbers are used by reliable protocols for determining
60 * retransmission behavior and are included in the routing structure.
62 struct rt_metrics { /* grouped for locality of reference */
63 u_long rmx_locks; /* Kernel must leave these values alone */
64 u_long rmx_mtu; /* MTU for this path */
65 u_long rmx_pksent; /* packets sent using this route */
66 u_long rmx_expire; /* lifetime for route */
68 u_long rmx_sendpipe; /* outbound delay-bandwidth product */
69 u_long rmx_ssthresh; /* outbound gateway buffer limit */
70 u_long rmx_rtt; /* estimated round trip time */
71 u_long rmx_rttvar; /* estimated rtt variance */
73 u_long rmx_recvpipe; /* inbound delay-bandwidth product */
74 u_long rmx_hopcount; /* max hops expected */
75 u_long rmx_filler[4]; /* will be used for T/TCP later */
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.
83 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
84 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
87 * XXX kernel function pointer `rt_output' is visible to applications.
92 * We distinguish between routes to hosts and routes to networks,
93 * preferring the former if available. For each route we infer
94 * the interface to use from the gateway address supplied when
95 * the route was entered. Routes that forward packets through
96 * gateways are marked so that the output routines know to address the
97 * gateway rather than the ultimate destination.
100 #include <net/radix.h>
104 struct radix_node rt_nodes[2]; /* tree glue, and other values */
105 #define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key))
106 #define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask))
107 struct sockaddr *rt_gateway; /* value */
108 long rt_refcnt; /* # held references */
109 u_long rt_flags; /* up/down?, host/net */
110 struct ifnet *rt_ifp; /* the answer: interface to use */
111 struct ifaddr *rt_ifa; /* the answer: interface to use */
112 struct sockaddr *rt_genmask; /* for generation of cloned routes */
113 void *rt_llinfo; /* pointer to link level info cache */
114 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */
115 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */
116 int (*rt_output) (struct ifnet *, struct mbuf *, struct sockaddr *,
118 /* output routine for this (rt,if) */
119 struct rtentry *rt_parent; /* cloning parent of this route */
120 void *rt_filler2; /* more filler */
124 * Following structure necessary for 4.3 compatibility;
125 * We should eventually move it to a compat file.
128 u_long rt_hash; /* to speed lookups */
129 struct sockaddr rt_dst; /* key */
130 struct sockaddr rt_gateway; /* value */
131 short rt_flags; /* up/down?, host/net */
132 short rt_refcnt; /* # held references */
133 u_long rt_use; /* raw # packets forwarded */
134 struct ifnet *rt_ifp; /* the answer: interface to use */
137 #define rt_use rt_rmx.rmx_pksent
139 #define RTF_UP 0x1 /* route usable */
140 #define RTF_GATEWAY 0x2 /* destination is a gateway */
141 #define RTF_HOST 0x4 /* host entry (net otherwise) */
142 #define RTF_REJECT 0x8 /* host or net unreachable */
143 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
144 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
145 #define RTF_DONE 0x40 /* message confirmed */
146 /* 0x80 unused, was RTF_DELCLONE */
147 #define RTF_CLONING 0x100 /* generate new routes on use */
148 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
149 #define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */
150 #define RTF_STATIC 0x800 /* manually added */
151 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
152 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
153 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
155 #define RTF_PRCLONING 0x10000 /* protocol requires cloning */
156 #define RTF_WASCLONED 0x20000 /* route generated through cloning */
157 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */
159 #define RTF_PINNED 0x100000 /* future use */
160 #define RTF_LOCAL 0x200000 /* route represents a local address */
161 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */
162 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */
163 /* 0x1000000 and up unassigned */
166 * Routing statistics.
169 short rts_badredirect; /* bogus redirect calls */
170 short rts_dynamic; /* routes created by redirects */
171 short rts_newgateway; /* routes modified by redirects */
172 short rts_unreach; /* lookups which failed */
173 short rts_wildcard; /* lookups satisfied by a wildcard */
176 * Structures for routing messages.
179 u_short rtm_msglen; /* to skip over non-understood messages */
180 u_char rtm_version; /* future binary compatibility */
181 u_char rtm_type; /* message type */
182 u_short rtm_index; /* index for associated ifp */
183 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
184 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
185 pid_t rtm_pid; /* identify sender */
186 int rtm_seq; /* for sender to identify action */
187 int rtm_errno; /* why failed */
188 int rtm_use; /* from rtentry */
189 u_long rtm_inits; /* which metrics we are initializing */
190 struct rt_metrics rtm_rmx; /* metrics themselves */
193 #define RTM_VERSION 5 /* Up the ante and ignore older versions */
198 #define RTM_ADD 0x1 /* Add Route */
199 #define RTM_DELETE 0x2 /* Delete Route */
200 #define RTM_CHANGE 0x3 /* Change Metrics or flags */
201 #define RTM_GET 0x4 /* Report Metrics */
202 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
203 #define RTM_REDIRECT 0x6 /* Told to use different route */
204 #define RTM_MISS 0x7 /* Lookup failed on this address */
205 #define RTM_LOCK 0x8 /* fix specified metrics */
206 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
207 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
208 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
209 #define RTM_NEWADDR 0xc /* address being added to iface */
210 #define RTM_DELADDR 0xd /* address being removed from iface */
211 #define RTM_IFINFO 0xe /* iface going up/down etc. */
212 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
213 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
214 #define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */
217 * Bitmask values for rtm_inits and rmx_locks.
219 #define RTV_MTU 0x1 /* init or lock _mtu */
220 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
221 #define RTV_EXPIRE 0x4 /* init or lock _expire */
222 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
223 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
224 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
225 #define RTV_RTT 0x40 /* init or lock _rtt */
226 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
229 * Bitmask values for rtm_addrs.
231 #define RTA_DST 0x1 /* destination sockaddr present */
232 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
233 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
234 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
235 #define RTA_IFP 0x10 /* interface name sockaddr present */
236 #define RTA_IFA 0x20 /* interface addr sockaddr present */
237 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
238 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
241 * Index offsets for sockaddr array for alternate internal encoding.
243 #define RTAX_DST 0 /* destination sockaddr present */
244 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
245 #define RTAX_NETMASK 2 /* netmask sockaddr present */
246 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
247 #define RTAX_IFP 4 /* interface name sockaddr present */
248 #define RTAX_IFA 5 /* interface addr sockaddr present */
249 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
250 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
251 #define RTAX_MAX 8 /* size of array to allocate */
255 struct sockaddr *rti_info[RTAX_MAX];
257 struct ifaddr *rti_ifa;
258 struct ifnet *rti_ifp;
263 #define sa_dst rti_info[RTAX_DST]
264 #define sa_gateway rti_info[RTAX_GATEWAY]
265 #define sa_netmask rti_info[RTAX_NETMASK]
266 #define sa_genmask rti_info[RTAX_GENMASK]
267 #define sa_ifpaddr rti_info[RTAX_IFP]
268 #define sa_ifaaddr rti_info[RTAX_IFA]
269 #define sa_author rti_info[RTAX_AUTHOR]
270 #define sa_bcastaddr rti_info[RTAX_BRD]
272 extern struct radix_node_head *rt_tables[AF_MAX+1];
277 void route_init (void);
278 int rt_getifa (struct rt_addrinfo *);
279 void rt_ifannouncemsg (struct ifnet *, int);
280 void rt_ifmsg (struct ifnet *);
281 int rt_llroute (struct sockaddr *dst, struct rtentry *rt0,
282 struct rtentry **drt);
283 void rt_missmsg (int, struct rt_addrinfo *, int, int);
284 void rt_newaddrmsg (int, struct ifaddr *, int, struct rtentry *);
285 void rt_newmaddrmsg (int, struct ifmultiaddr *);
286 int rt_setgate (struct rtentry *,
287 struct sockaddr *, struct sockaddr *);
288 void rtalloc (struct route *);
289 void rtalloc_ign (struct route *, u_long);
291 rtlookup (struct sockaddr *, int, u_long);
292 void rtfree (struct rtentry *);
293 int rtinit (struct ifaddr *, int, int);
294 int rtioctl (u_long, caddr_t, struct thread *);
295 void rtredirect (struct sockaddr *, struct sockaddr *,
296 struct sockaddr *, int, struct sockaddr *, struct rtentry **);
297 int rtrequest (int, struct sockaddr *,
298 struct sockaddr *, struct sockaddr *, int, struct rtentry **);
299 int rtrequest1 (int, struct rt_addrinfo *, struct rtentry **);
302 RTFREE(struct rtentry *rt)
304 if (rt->rt_refcnt <= 1)