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