FreeBSD/Linux Kernel Cross Reference
sys/net/route.h
1 /*
2 * Copyright (c) 1980, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
20 *
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
31 * SUCH DAMAGE.
32 *
33 * @(#)route.h 8.4 (Berkeley) 1/9/95
34 * $FreeBSD: releng/5.2/sys/net/route.h 122922 2003-11-20 20:07:39Z andre $
35 */
36
37 #ifndef _NET_ROUTE_H_
38 #define _NET_ROUTE_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_lite {
62 u_long rmx_mtu; /* MTU for this path */
63 u_long rmx_expire; /* lifetime for route, e.g. redirect */
64 u_long rmx_pksent; /* packets sent using this route */
65 };
66
67 struct rt_metrics {
68 u_long rmx_locks; /* Kernel must leave these values alone */
69 u_long rmx_mtu; /* MTU for this path */
70 u_long rmx_hopcount; /* max hops expected */
71 u_long rmx_expire; /* lifetime for route, e.g. redirect */
72 u_long rmx_recvpipe; /* inbound delay-bandwidth product */
73 u_long rmx_sendpipe; /* outbound delay-bandwidth product */
74 u_long rmx_ssthresh; /* outbound gateway buffer limit */
75 u_long rmx_rtt; /* estimated round trip time */
76 u_long rmx_rttvar; /* estimated rtt variance */
77 u_long rmx_pksent; /* packets sent using this route */
78 u_long rmx_filler[4]; /* will be used for T/TCP later */
79 };
80
81 /*
82 * rmx_rtt and rmx_rttvar are stored as microseconds;
83 * RTTTOPRHZ(rtt) converts to a value suitable for use
84 * by a protocol slowtimo counter.
85 */
86 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
87 #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
88
89 /*
90 * XXX kernel function pointer `rt_output' is visible to applications.
91 */
92 struct mbuf;
93
94 /*
95 * We distinguish between routes to hosts and routes to networks,
96 * preferring the former if available. For each route we infer
97 * the interface to use from the gateway address supplied when
98 * the route was entered. Routes that forward packets through
99 * gateways are marked so that the output routines know to address the
100 * gateway rather than the ultimate destination.
101 */
102 #ifndef RNF_NORMAL
103 #include <net/radix.h>
104 #endif
105 struct rtentry {
106 struct radix_node rt_nodes[2]; /* tree glue, and other values */
107 #define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key))
108 #define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask))
109 struct sockaddr *rt_gateway; /* value */
110 long rt_refcnt; /* # held references */
111 u_long rt_flags; /* up/down?, host/net */
112 struct ifnet *rt_ifp; /* the answer: interface to use */
113 struct ifaddr *rt_ifa; /* the answer: interface address to use */
114 struct sockaddr *rt_genmask; /* for generation of cloned routes */
115 caddr_t rt_llinfo; /* pointer to link level info cache */
116 struct rt_metrics_lite rt_rmx; /* metrics used by rx'ing protocols */
117 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */
118 int (*rt_output)(struct ifnet *, struct mbuf *, struct sockaddr *,
119 struct rtentry *);
120 /* output routine for this (rt,if) */
121 struct rtentry *rt_parent; /* cloning parent of this route */
122 #ifdef _KERNEL
123 /* XXX ugly, user apps use this definition but don't have a mtx def */
124 struct mtx rt_mtx; /* mutex for routing entry */
125 #endif
126 };
127
128 /*
129 * Following structure necessary for 4.3 compatibility;
130 * We should eventually move it to a compat file.
131 */
132 struct ortentry {
133 u_long rt_hash; /* to speed lookups */
134 struct sockaddr rt_dst; /* key */
135 struct sockaddr rt_gateway; /* value */
136 short rt_flags; /* up/down?, host/net */
137 short rt_refcnt; /* # held references */
138 u_long rt_use; /* raw # packets forwarded */
139 struct ifnet *rt_ifp; /* the answer: interface to use */
140 };
141
142 #define rt_use rt_rmx.rmx_pksent
143
144 #define RTF_UP 0x1 /* route usable */
145 #define RTF_GATEWAY 0x2 /* destination is a gateway */
146 #define RTF_HOST 0x4 /* host entry (net otherwise) */
147 #define RTF_REJECT 0x8 /* host or net unreachable */
148 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
149 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
150 #define RTF_DONE 0x40 /* message confirmed */
151 /* 0x80 unused, was RTF_DELCLONE */
152 #define RTF_CLONING 0x100 /* generate new routes on use */
153 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
154 #define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */
155 #define RTF_STATIC 0x800 /* manually added */
156 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
157 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
158 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
159
160 /* XXX: temporary to stay API/ABI compatible with userland */
161 #ifndef _KERNEL
162 #define RTF_PRCLONING 0x10000 /* unused, for compatibility */
163 #endif
164
165 #define RTF_WASCLONED 0x20000 /* route generated through cloning */
166 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */
167 /* 0x80000 unused */
168 #define RTF_PINNED 0x100000 /* future use */
169 #define RTF_LOCAL 0x200000 /* route represents a local address */
170 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */
171 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */
172 /* 0x1000000 and up unassigned */
173
174 /*
175 * Routing statistics.
176 */
177 struct rtstat {
178 short rts_badredirect; /* bogus redirect calls */
179 short rts_dynamic; /* routes created by redirects */
180 short rts_newgateway; /* routes modified by redirects */
181 short rts_unreach; /* lookups which failed */
182 short rts_wildcard; /* lookups satisfied by a wildcard */
183 };
184 /*
185 * Structures for routing messages.
186 */
187 struct rt_msghdr {
188 u_short rtm_msglen; /* to skip over non-understood messages */
189 u_char rtm_version; /* future binary compatibility */
190 u_char rtm_type; /* message type */
191 u_short rtm_index; /* index for associated ifp */
192 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
193 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
194 pid_t rtm_pid; /* identify sender */
195 int rtm_seq; /* for sender to identify action */
196 int rtm_errno; /* why failed */
197 int rtm_use; /* from rtentry */
198 u_long rtm_inits; /* which metrics we are initializing */
199 struct rt_metrics rtm_rmx; /* metrics themselves */
200 };
201
202 #define RTM_VERSION 5 /* Up the ante and ignore older versions */
203
204 /*
205 * Message types.
206 */
207 #define RTM_ADD 0x1 /* Add Route */
208 #define RTM_DELETE 0x2 /* Delete Route */
209 #define RTM_CHANGE 0x3 /* Change Metrics or flags */
210 #define RTM_GET 0x4 /* Report Metrics */
211 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
212 #define RTM_REDIRECT 0x6 /* Told to use different route */
213 #define RTM_MISS 0x7 /* Lookup failed on this address */
214 #define RTM_LOCK 0x8 /* fix specified metrics */
215 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
216 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
217 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
218 #define RTM_NEWADDR 0xc /* address being added to iface */
219 #define RTM_DELADDR 0xd /* address being removed from iface */
220 #define RTM_IFINFO 0xe /* iface going up/down etc. */
221 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
222 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
223 #define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */
224
225 /*
226 * Bitmask values for rtm_inits and rmx_locks.
227 */
228 #define RTV_MTU 0x1 /* init or lock _mtu */
229 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
230 #define RTV_EXPIRE 0x4 /* init or lock _expire */
231 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
232 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
233 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
234 #define RTV_RTT 0x40 /* init or lock _rtt */
235 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
236
237 /*
238 * Bitmask values for rtm_addrs.
239 */
240 #define RTA_DST 0x1 /* destination sockaddr present */
241 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
242 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
243 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
244 #define RTA_IFP 0x10 /* interface name sockaddr present */
245 #define RTA_IFA 0x20 /* interface addr sockaddr present */
246 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
247 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
248
249 /*
250 * Index offsets for sockaddr array for alternate internal encoding.
251 */
252 #define RTAX_DST 0 /* destination sockaddr present */
253 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
254 #define RTAX_NETMASK 2 /* netmask sockaddr present */
255 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
256 #define RTAX_IFP 4 /* interface name sockaddr present */
257 #define RTAX_IFA 5 /* interface addr sockaddr present */
258 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
259 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
260 #define RTAX_MAX 8 /* size of array to allocate */
261
262 struct rt_addrinfo {
263 int rti_addrs;
264 struct sockaddr *rti_info[RTAX_MAX];
265 int rti_flags;
266 struct ifaddr *rti_ifa;
267 struct ifnet *rti_ifp;
268 };
269
270 #ifdef _KERNEL
271
272 #define RT_LOCK_INIT(_rt) \
273 mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK)
274 #define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx)
275 #define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx)
276 #define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx)
277 #define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED)
278
279 #define RT_ADDREF(_rt) do { \
280 RT_LOCK_ASSERT(_rt); \
281 KASSERT((_rt)->rt_refcnt >= 0, \
282 ("negative refcnt %ld", (_rt)->rt_refcnt)); \
283 (_rt)->rt_refcnt++; \
284 } while (0);
285 #define RT_REMREF(_rt) do { \
286 RT_LOCK_ASSERT(_rt); \
287 KASSERT((_rt)->rt_refcnt > 0, \
288 ("bogus refcnt %ld", (_rt)->rt_refcnt)); \
289 (_rt)->rt_refcnt--; \
290 } while (0);
291
292 #define RTFREE_LOCKED(_rt) do { \
293 if ((_rt)->rt_refcnt <= 1) \
294 rtfree(_rt); \
295 else { \
296 RT_REMREF(_rt); \
297 RT_UNLOCK(_rt); \
298 } \
299 /* guard against invalid refs */ \
300 _rt = 0; \
301 } while (0)
302 #define RTFREE(_rt) do { \
303 RT_LOCK(_rt); \
304 RTFREE_LOCKED(_rt); \
305 } while (0)
306
307 extern struct radix_node_head *rt_tables[AF_MAX+1];
308
309 struct ifmultiaddr;
310
311 void route_init(void);
312 int rt_getifa(struct rt_addrinfo *);
313 void rt_ifannouncemsg(struct ifnet *, int);
314 void rt_ifmsg(struct ifnet *);
315 void rt_missmsg(int, struct rt_addrinfo *, int, int);
316 void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
317 void rt_newmaddrmsg(int, struct ifmultiaddr *);
318 void rtalloc(struct route *);
319 int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
320 void rtalloc_ign(struct route *, u_long);
321 /* NB: the rtentry is returned locked */
322 struct rtentry *rtalloc1(struct sockaddr *, int, u_long);
323 int rtexpunge(struct rtentry *);
324 void rtfree(struct rtentry *);
325 int rtinit(struct ifaddr *, int, int);
326 int rtioctl(u_long, caddr_t);
327 void rtredirect(struct sockaddr *, struct sockaddr *,
328 struct sockaddr *, int, struct sockaddr *);
329 int rtrequest(int, struct sockaddr *,
330 struct sockaddr *, struct sockaddr *, int, struct rtentry **);
331 int rtrequest1(int, struct rt_addrinfo *, struct rtentry **);
332 int rt_check(struct rtentry **, struct rtentry **, struct sockaddr *);
333 #endif
334
335 #endif
Cache object: e6c2690d1989c5774ae8f5694f3ff22e
|