FreeBSD/Linux Kernel Cross Reference
sys/net/route.h
1 /* $NetBSD: route.h,v 1.45 2006/11/13 19:14:30 dyoung 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 #include <sys/types.h>
40 #include <net/if.h>
41
42 /*
43 * Kernel resident routing tables.
44 *
45 * The routing tables are initialized when interface addresses
46 * are set by making entries for all directly connected interfaces.
47 */
48
49 /*
50 * A route consists of a destination address and a reference
51 * to a routing entry. These are often held by protocols
52 * in their control blocks, e.g. inpcb.
53 */
54 struct route {
55 struct rtentry *ro_rt;
56 struct sockaddr ro_dst;
57 };
58
59 /*
60 * These numbers are used by reliable protocols for determining
61 * retransmission behavior and are included in the routing structure.
62 */
63 struct rt_metrics {
64 u_long rmx_locks; /* Kernel must leave these values alone */
65 u_long rmx_mtu; /* MTU for this path */
66 u_long rmx_hopcount; /* max hops expected */
67 u_long rmx_expire; /* lifetime for route, e.g. redirect */
68 u_long rmx_recvpipe; /* inbound delay-bandwidth product */
69 u_long rmx_sendpipe; /* outbound delay-bandwidth product */
70 u_long rmx_ssthresh; /* outbound gateway buffer limit */
71 u_long rmx_rtt; /* estimated round trip time */
72 u_long rmx_rttvar; /* estimated rtt variance */
73 u_long rmx_pksent; /* packets sent using this route */
74 };
75
76 /*
77 * rmx_rtt and rmx_rttvar are stored as microseconds;
78 * RTTTOPRHZ(rtt) converts to a value suitable for use
79 * by a protocol slowtimo counter.
80 */
81 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
82 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
83
84 /*
85 * We distinguish between routes to hosts and routes to networks,
86 * preferring the former if available. For each route we infer
87 * the interface to use from the gateway address supplied when
88 * the route was entered. Routes that forward packets through
89 * gateways are marked so that the output routines know to address the
90 * gateway rather than the ultimate destination.
91 */
92 #ifndef RNF_NORMAL
93 #include <net/radix.h>
94 #endif
95 struct rtentry {
96 struct radix_node rt_nodes[2]; /* tree glue, and other values */
97 /*XXXUNCONST*/
98 #define rt_key(r) ((struct sockaddr *)__UNCONST((r)->rt_nodes->rn_key))
99 /*XXXUNCONST*/
100 #define rt_mask(r) ((struct sockaddr *)__UNCONST((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 uint32_t rt_ifa_seqno;
108 const struct sockaddr *rt_genmask; /* for generation of cloned routes */
109 caddr_t rt_llinfo; /* pointer to link level info cache */
110 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */
111 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */
112 LIST_HEAD(, rttimer) rt_timer; /* queue of timeouts for misc funcs */
113 struct rtentry *rt_parent; /* parent of cloned route */
114 };
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_use; /* raw # packets forwarded */
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_CLONED 0x2000 /* this is a cloned route */
144 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
145 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
146 #define RTF_SRC 0x10000 /* route has fixed source address */
147
148
149 /*
150 * Routing statistics.
151 */
152 struct rtstat {
153 u_quad_t rts_badredirect; /* bogus redirect calls */
154 u_quad_t rts_dynamic; /* routes created by redirects */
155 u_quad_t rts_newgateway; /* routes modified by redirects */
156 u_quad_t rts_unreach; /* lookups which failed */
157 u_quad_t rts_wildcard; /* lookups satisfied by a wildcard */
158 };
159 /*
160 * Structures for routing messages.
161 */
162 struct rt_msghdr {
163 u_short rtm_msglen; /* to skip over non-understood messages */
164 u_char rtm_version; /* future binary compatibility */
165 u_char rtm_type; /* message type */
166 u_short rtm_index; /* index for associated ifp */
167 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
168 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
169 pid_t rtm_pid; /* identify sender */
170 int rtm_seq; /* for sender to identify action */
171 int rtm_errno; /* why failed */
172 int rtm_use; /* from rtentry */
173 u_long rtm_inits; /* which metrics we are initializing */
174 struct rt_metrics rtm_rmx; /* metrics themselves */
175 };
176
177 #define RTM_VERSION 3 /* Up the ante and ignore older versions */
178
179 #define RTM_ADD 0x1 /* Add Route */
180 #define RTM_DELETE 0x2 /* Delete Route */
181 #define RTM_CHANGE 0x3 /* Change Metrics or flags */
182 #define RTM_GET 0x4 /* Report Metrics */
183 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
184 #define RTM_REDIRECT 0x6 /* Told to use different route */
185 #define RTM_MISS 0x7 /* Lookup failed on this address */
186 #define RTM_LOCK 0x8 /* fix specified metrics */
187 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
188 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
189 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
190 #define RTM_NEWADDR 0xc /* address being added to iface */
191 #define RTM_DELADDR 0xd /* address being removed from iface */
192 #define RTM_OIFINFO 0xe /* Old (pre-1.5) RTM_IFINFO message */
193 #define RTM_IFINFO 0xf /* iface/link going up/down etc. */
194 #define RTM_IFANNOUNCE 0x10 /* iface arrival/departure */
195 #define RTM_IEEE80211 0x11 /* IEEE80211 wireless event */
196
197 #define RTV_MTU 0x1 /* init or lock _mtu */
198 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
199 #define RTV_EXPIRE 0x4 /* init or lock _expire */
200 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
201 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
202 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
203 #define RTV_RTT 0x40 /* init or lock _rtt */
204 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
205
206 /*
207 * Bitmask values for rtm_addr.
208 */
209 #define RTA_DST 0x1 /* destination sockaddr present */
210 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
211 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
212 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
213 #define RTA_IFP 0x10 /* interface name sockaddr present */
214 #define RTA_IFA 0x20 /* interface addr sockaddr present */
215 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
216 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
217
218 /*
219 * Index offsets for sockaddr array for alternate internal encoding.
220 */
221 #define RTAX_DST 0 /* destination sockaddr present */
222 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
223 #define RTAX_NETMASK 2 /* netmask sockaddr present */
224 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
225 #define RTAX_IFP 4 /* interface name sockaddr present */
226 #define RTAX_IFA 5 /* interface addr sockaddr present */
227 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
228 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
229 #define RTAX_MAX 8 /* size of array to allocate */
230
231 struct rt_addrinfo {
232 int rti_addrs;
233 const struct sockaddr *rti_info[RTAX_MAX];
234 int rti_flags;
235 struct ifaddr *rti_ifa;
236 struct ifnet *rti_ifp;
237 struct rt_msghdr *rti_rtm;
238 };
239
240 struct route_cb {
241 int ip_count;
242 int ip6_count;
243 int ipx_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)(struct rtentry *, struct rttimer *);
261 time_t rtt_time; /* When this timer was registered */
262 };
263
264 struct rttimer_queue {
265 long rtq_timeout;
266 unsigned long rtq_count;
267 TAILQ_HEAD(, rttimer) rtq_head;
268 LIST_ENTRY(rttimer_queue) rtq_link;
269 };
270
271
272 #ifdef _KERNEL
273 #define RTFREE(rt) \
274 do { \
275 if ((rt)->rt_refcnt <= 1) \
276 rtfree(rt); \
277 else \
278 (rt)->rt_refcnt--; \
279 } while (/*CONSTCOND*/ 0)
280
281 extern struct route_cb route_cb;
282 extern struct rtstat rtstat;
283 extern struct radix_node_head *rt_tables[AF_MAX+1];
284
285 struct socket;
286
287 void route_init(void);
288 int route_output(struct mbuf *, ...);
289 int route_usrreq(struct socket *,
290 int, struct mbuf *, struct mbuf *, struct mbuf *, struct lwp *);
291 void rt_ifannouncemsg(struct ifnet *, int);
292 void rt_ieee80211msg(struct ifnet *, int, void *, size_t);
293 void rt_ifmsg(struct ifnet *);
294 void rt_maskedcopy(const struct sockaddr *,
295 struct sockaddr *, const struct sockaddr *);
296 void rt_missmsg(int, struct rt_addrinfo *, int, int);
297 void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
298 int rt_setgate(struct rtentry *,
299 const struct sockaddr *, const struct sockaddr *);
300 void rt_setmetrics(u_long, const struct rt_metrics *, struct rt_metrics *);
301 int rt_timer_add(struct rtentry *,
302 void(*)(struct rtentry *, struct rttimer *),
303 struct rttimer_queue *);
304 void rt_timer_init(void);
305 struct rttimer_queue *
306 rt_timer_queue_create(u_int);
307 void rt_timer_queue_change(struct rttimer_queue *, long);
308 void rt_timer_queue_remove_all(struct rttimer_queue *, int);
309 void rt_timer_queue_destroy(struct rttimer_queue *, int);
310 void rt_timer_remove_all(struct rtentry *, int);
311 unsigned long rt_timer_count(struct rttimer_queue *);
312 void rt_timer_timer(void *);
313 void rtable_init(void **);
314 void rtalloc(struct route *);
315 struct rtentry *
316 rtalloc1(const struct sockaddr *, int);
317 void rtfree(struct rtentry *);
318 int rt_getifa(struct rt_addrinfo *);
319 int rtinit(struct ifaddr *, int, int);
320 int rtioctl(u_long, caddr_t, struct lwp *);
321 void rtredirect(const struct sockaddr *, const struct sockaddr *,
322 const struct sockaddr *, int, const struct sockaddr *,
323 struct rtentry **);
324 int rtrequest(int, const struct sockaddr *,
325 const struct sockaddr *, const struct sockaddr *, int,
326 struct rtentry **);
327 int rtrequest1(int, struct rt_addrinfo *, struct rtentry **);
328
329 static inline void
330 rt_set_ifa1(struct rtentry *rt, struct ifaddr *ifa)
331 {
332 rt->rt_ifa = ifa;
333 if (ifa->ifa_seqno != NULL)
334 rt->rt_ifa_seqno = *ifa->ifa_seqno;
335 }
336
337 static inline void
338 rt_replace_ifa(struct rtentry *rt, struct ifaddr *ifa)
339 {
340 IFAREF(ifa);
341 IFAFREE(rt->rt_ifa);
342 rt_set_ifa1(rt, ifa);
343 }
344
345 static inline struct ifaddr *
346 rt_get_ifa(struct rtentry *rt)
347 {
348 struct ifaddr *ifa;
349
350 if ((ifa = rt->rt_ifa) == NULL)
351 return ifa;
352 else if (ifa->ifa_getifa == NULL)
353 return ifa;
354 #if 0
355 else if (ifa->ifa_seqno != NULL && *ifa->ifa_seqno == rt->rt_ifa_seqno)
356 return ifa;
357 #endif
358 else {
359 ifa = (*ifa->ifa_getifa)(ifa, rt_key(rt));
360 rt_replace_ifa(rt, ifa);
361 return ifa;
362 }
363 }
364
365 static inline void
366 rt_set_ifa(struct rtentry *rt, struct ifaddr *ifa)
367 {
368 IFAREF(ifa);
369 rt_set_ifa1(rt, ifa);
370 }
371
372 #endif /* _KERNEL */
373 #endif /* !_NET_ROUTE_H_ */
Cache object: a9452caa35cf6003347ed17995a879a1
|