|
1 /*- |
|
2 * © Portions copyright (c) 2007 Symbian Software Ltd. All rights reserved. |
|
3 * Copyright (c) 1980, 1986, 1993 |
|
4 * 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 |
|
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 * 4. Neither the name of the University nor the names of its contributors |
|
14 * may be used to endorse or promote products derived from this software |
|
15 * without specific prior written permission. |
|
16 * |
|
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
|
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
|
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
|
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
|
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
|
27 * SUCH DAMAGE. |
|
28 * |
|
29 * @(#)route.h 8.4 (Berkeley) 1/9/95 |
|
30 * $FreeBSD: src/sys/net/route.h,v 1.63 2005/01/07 01:45:35 imp Exp $ |
|
31 */ |
|
32 |
|
33 #ifndef _NET_ROUTE_H_ |
|
34 #define _NET_ROUTE_H_ |
|
35 |
|
36 #ifndef __SYMBIAN32__ |
|
37 /* |
|
38 * Kernel resident routing tables. |
|
39 * |
|
40 * The routing tables are initialized when interface addresses |
|
41 * are set by making entries for all directly connected interfaces. |
|
42 */ |
|
43 |
|
44 /* |
|
45 * A route consists of a destination address and a reference |
|
46 * to a routing entry. These are often held by protocols |
|
47 * in their control blocks, e.g. inpcb. |
|
48 */ |
|
49 struct route { |
|
50 struct rtentry *ro_rt; |
|
51 struct sockaddr ro_dst; |
|
52 }; |
|
53 #endif //__SYMBIAN32__ |
|
54 /* |
|
55 * These numbers are used by reliable protocols for determining |
|
56 * retransmission behavior and are included in the routing structure. |
|
57 */ |
|
58 struct rt_metrics_lite { |
|
59 u_long rmx_mtu; /* MTU for this path */ |
|
60 u_long rmx_expire; /* lifetime for route, e.g. redirect */ |
|
61 u_long rmx_pksent; /* packets sent using this route */ |
|
62 }; |
|
63 |
|
64 struct rt_metrics { |
|
65 u_long rmx_locks; /* Kernel must leave these values alone */ |
|
66 u_long rmx_mtu; /* MTU for this path */ |
|
67 u_long rmx_hopcount; /* max hops expected */ |
|
68 u_long rmx_expire; /* lifetime for route, e.g. redirect */ |
|
69 u_long rmx_recvpipe; /* inbound delay-bandwidth product */ |
|
70 u_long rmx_sendpipe; /* outbound delay-bandwidth product */ |
|
71 u_long rmx_ssthresh; /* outbound gateway buffer limit */ |
|
72 u_long rmx_rtt; /* estimated round trip time */ |
|
73 u_long rmx_rttvar; /* estimated rtt variance */ |
|
74 u_long rmx_pksent; /* packets sent using this route */ |
|
75 u_long rmx_filler[4]; /* will be used for T/TCP later */ |
|
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 * XXX kernel function pointer `rt_output' is visible to applications. |
|
88 */ |
|
89 struct mbuf; |
|
90 |
|
91 /* |
|
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. |
|
98 */ |
|
99 #ifndef RNF_NORMAL |
|
100 #include <net/radix.h> |
|
101 #endif |
|
102 struct rtentry { |
|
103 struct radix_node rt_nodes[2]; /* tree glue, and other values */ |
|
104 /* |
|
105 * XXX struct rtentry must begin with a struct radix_node (or two!) |
|
106 * because the code does some casts of a 'struct radix_node *' |
|
107 * to a 'struct rtentry *' |
|
108 */ |
|
109 #define rt_key(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_key))) |
|
110 #define rt_mask(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask))) |
|
111 #ifndef __SYMBIAN32__ |
|
112 struct sockaddr *rt_gateway; /* value */ |
|
113 #endif //__SYMBIAN32__ |
|
114 u_long rt_flags; /* up/down?, host/net */ |
|
115 struct ifnet *rt_ifp; /* the answer: interface to use */ |
|
116 struct ifaddr *rt_ifa; /* the answer: interface address to use */ |
|
117 struct rt_metrics_lite rt_rmx; /* metrics used by rx'ing protocols */ |
|
118 long rt_refcnt; /* # held references */ |
|
119 #ifndef __SYMBIAN32__ |
|
120 struct sockaddr *rt_genmask; /* for generation of cloned routes */ |
|
121 #endif |
|
122 caddr_t rt_llinfo; /* pointer to link level info cache */ |
|
123 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ |
|
124 struct rtentry *rt_parent; /* cloning parent of this route */ |
|
125 #ifdef _KERNEL |
|
126 /* XXX ugly, user apps use this definition but don't have a mtx def */ |
|
127 struct mtx rt_mtx; /* mutex for routing entry */ |
|
128 #endif |
|
129 |
|
130 /*to be compatible with linux */ |
|
131 #ifdef __SYMBIAN32__ |
|
132 struct sockaddr rt_gateway; /* Gateway addr (RTF_GATEWAY). */ |
|
133 char *rt_dev; /* Forcing the device at add. */ |
|
134 struct sockaddr rt_genmask; /* Target network mask (IP). */ |
|
135 short int rt_metric; /* +1 for binary compatibility! */ |
|
136 struct sockaddr rt_dst; /* Target address. */ |
|
137 #endif //__SYMBIAN32__ |
|
138 }; |
|
139 |
|
140 #define RTF_UP 0x1 /* route usable */ |
|
141 #define RTF_GATEWAY 0x2 /* destination is a gateway */ |
|
142 #define RTF_HOST 0x4 /* host entry (net otherwise) */ |
|
143 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ |
|
144 #define RTF_STATIC 0x800 /* manually added */ |
|
145 |
|
146 #ifndef __SYMBIAN32__ |
|
147 /* |
|
148 * Following structure necessary for 4.3 compatibility; |
|
149 * We should eventually move it to a compat file. |
|
150 */ |
|
151 struct ortentry { |
|
152 u_long rt_hash; /* to speed lookups */ |
|
153 struct sockaddr rt_dst; /* key */ |
|
154 struct sockaddr rt_gateway; /* value */ |
|
155 short rt_flags; /* up/down?, host/net */ |
|
156 short rt_refcnt; /* # held references */ |
|
157 u_long rt_use; /* raw # packets forwarded */ |
|
158 struct ifnet *rt_ifp; /* the answer: interface to use */ |
|
159 }; |
|
160 |
|
161 #define rt_use rt_rmx.rmx_pksent |
|
162 |
|
163 #define RTF_UP 0x1 /* route usable */ |
|
164 #define RTF_GATEWAY 0x2 /* destination is a gateway */ |
|
165 #define RTF_HOST 0x4 /* host entry (net otherwise) */ |
|
166 #define RTF_REJECT 0x8 /* host or net unreachable */ |
|
167 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ |
|
168 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ |
|
169 #define RTF_DONE 0x40 /* message confirmed */ |
|
170 /* 0x80 unused, was RTF_DELCLONE */ |
|
171 #define RTF_CLONING 0x100 /* generate new routes on use */ |
|
172 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ |
|
173 #define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */ |
|
174 #define RTF_STATIC 0x800 /* manually added */ |
|
175 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ |
|
176 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ |
|
177 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ |
|
178 |
|
179 /* XXX: temporary to stay API/ABI compatible with userland */ |
|
180 #ifndef _KERNEL |
|
181 #define RTF_PRCLONING 0x10000 /* unused, for compatibility */ |
|
182 #endif |
|
183 |
|
184 #define RTF_WASCLONED 0x20000 /* route generated through cloning */ |
|
185 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */ |
|
186 /* 0x80000 unused */ |
|
187 #define RTF_PINNED 0x100000 /* future use */ |
|
188 #define RTF_LOCAL 0x200000 /* route represents a local address */ |
|
189 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */ |
|
190 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */ |
|
191 /* 0x1000000 and up unassigned */ |
|
192 |
|
193 /* |
|
194 * Routing statistics. |
|
195 */ |
|
196 struct rtstat { |
|
197 short rts_badredirect; /* bogus redirect calls */ |
|
198 short rts_dynamic; /* routes created by redirects */ |
|
199 short rts_newgateway; /* routes modified by redirects */ |
|
200 short rts_unreach; /* lookups which failed */ |
|
201 short rts_wildcard; /* lookups satisfied by a wildcard */ |
|
202 }; |
|
203 /* |
|
204 * Structures for routing messages. |
|
205 */ |
|
206 struct rt_msghdr { |
|
207 u_short rtm_msglen; /* to skip over non-understood messages */ |
|
208 u_char rtm_version; /* future binary compatibility */ |
|
209 u_char rtm_type; /* message type */ |
|
210 u_short rtm_index; /* index for associated ifp */ |
|
211 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ |
|
212 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ |
|
213 pid_t rtm_pid; /* identify sender */ |
|
214 int rtm_seq; /* for sender to identify action */ |
|
215 int rtm_errno; /* why failed */ |
|
216 int rtm_use; /* from rtentry */ |
|
217 u_long rtm_inits; /* which metrics we are initializing */ |
|
218 struct rt_metrics rtm_rmx; /* metrics themselves */ |
|
219 }; |
|
220 |
|
221 #define RTM_VERSION 5 /* Up the ante and ignore older versions */ |
|
222 |
|
223 /* |
|
224 * Message types. |
|
225 */ |
|
226 #define RTM_ADD 0x1 /* Add Route */ |
|
227 #define RTM_DELETE 0x2 /* Delete Route */ |
|
228 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ |
|
229 #define RTM_GET 0x4 /* Report Metrics */ |
|
230 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ |
|
231 #define RTM_REDIRECT 0x6 /* Told to use different route */ |
|
232 #define RTM_MISS 0x7 /* Lookup failed on this address */ |
|
233 #define RTM_LOCK 0x8 /* fix specified metrics */ |
|
234 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ |
|
235 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ |
|
236 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ |
|
237 #define RTM_NEWADDR 0xc /* address being added to iface */ |
|
238 #define RTM_DELADDR 0xd /* address being removed from iface */ |
|
239 #define RTM_IFINFO 0xe /* iface going up/down etc. */ |
|
240 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ |
|
241 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ |
|
242 #define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */ |
|
243 #define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */ |
|
244 |
|
245 /* |
|
246 * Bitmask values for rtm_inits and rmx_locks. |
|
247 */ |
|
248 #define RTV_MTU 0x1 /* init or lock _mtu */ |
|
249 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ |
|
250 #define RTV_EXPIRE 0x4 /* init or lock _expire */ |
|
251 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ |
|
252 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ |
|
253 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ |
|
254 #define RTV_RTT 0x40 /* init or lock _rtt */ |
|
255 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ |
|
256 |
|
257 /* |
|
258 * Bitmask values for rtm_addrs. |
|
259 */ |
|
260 #define RTA_DST 0x1 /* destination sockaddr present */ |
|
261 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ |
|
262 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ |
|
263 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ |
|
264 #define RTA_IFP 0x10 /* interface name sockaddr present */ |
|
265 #define RTA_IFA 0x20 /* interface addr sockaddr present */ |
|
266 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ |
|
267 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ |
|
268 |
|
269 /* |
|
270 * Index offsets for sockaddr array for alternate internal encoding. |
|
271 */ |
|
272 #define RTAX_DST 0 /* destination sockaddr present */ |
|
273 #define RTAX_GATEWAY 1 /* gateway sockaddr present */ |
|
274 #define RTAX_NETMASK 2 /* netmask sockaddr present */ |
|
275 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ |
|
276 #define RTAX_IFP 4 /* interface name sockaddr present */ |
|
277 #define RTAX_IFA 5 /* interface addr sockaddr present */ |
|
278 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ |
|
279 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ |
|
280 #define RTAX_MAX 8 /* size of array to allocate */ |
|
281 |
|
282 struct rt_addrinfo { |
|
283 int rti_addrs; |
|
284 struct sockaddr *rti_info[RTAX_MAX]; |
|
285 int rti_flags; |
|
286 struct ifaddr *rti_ifa; |
|
287 struct ifnet *rti_ifp; |
|
288 }; |
|
289 |
|
290 /* |
|
291 * This macro returns the size of a struct sockaddr when passed |
|
292 * through a routing socket. Basically we round up sa_len to |
|
293 * a multiple of sizeof(long), with a minimum of sizeof(long). |
|
294 * The check for a NULL pointer is just a convenience, probably never used. |
|
295 * The case sa_len == 0 should only apply to empty structures. |
|
296 */ |
|
297 #define SA_SIZE(sa) \ |
|
298 ( (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ? \ |
|
299 sizeof(long) : \ |
|
300 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) ) |
|
301 |
|
302 #ifdef _KERNEL |
|
303 |
|
304 #define RT_LOCK_INIT(_rt) \ |
|
305 mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK) |
|
306 #define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx) |
|
307 #define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx) |
|
308 #define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx) |
|
309 #define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED) |
|
310 |
|
311 #define RT_ADDREF(_rt) do { \ |
|
312 RT_LOCK_ASSERT(_rt); \ |
|
313 KASSERT((_rt)->rt_refcnt >= 0, \ |
|
314 ("negative refcnt %ld", (_rt)->rt_refcnt)); \ |
|
315 (_rt)->rt_refcnt++; \ |
|
316 } while (0); |
|
317 #define RT_REMREF(_rt) do { \ |
|
318 RT_LOCK_ASSERT(_rt); \ |
|
319 KASSERT((_rt)->rt_refcnt > 0, \ |
|
320 ("bogus refcnt %ld", (_rt)->rt_refcnt)); \ |
|
321 (_rt)->rt_refcnt--; \ |
|
322 } while (0); |
|
323 |
|
324 #define RTFREE_LOCKED(_rt) do { \ |
|
325 if ((_rt)->rt_refcnt <= 1) \ |
|
326 rtfree(_rt); \ |
|
327 else { \ |
|
328 RT_REMREF(_rt); \ |
|
329 RT_UNLOCK(_rt); \ |
|
330 } \ |
|
331 /* guard against invalid refs */ \ |
|
332 _rt = 0; \ |
|
333 } while (0) |
|
334 #define RTFREE(_rt) do { \ |
|
335 RT_LOCK(_rt); \ |
|
336 RTFREE_LOCKED(_rt); \ |
|
337 } while (0) |
|
338 |
|
339 extern struct radix_node_head *rt_tables[AF_MAX+1]; |
|
340 |
|
341 struct ifmultiaddr; |
|
342 |
|
343 #endif |
|
344 #endif //__SYMBIAN32__ |
|
345 #endif |