e6a84e3842b5df774e4c04787c29af0a98fd25a0
[dragonfly.git] / sys / net / route.h
1 /*
2  * Copyright (c) 2004, 2005 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Jeffrey M. Hsu.
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 DragonFly Project nor the names of its
16  *    contributors may be used to endorse or promote products derived
17  *    from this software without specific, prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32
33 /*
34  * Copyright (c) 2004, 2005 Jeffrey M. Hsu.  All rights reserved.
35  *
36  * License terms: all terms for the DragonFly license above plus the following:
37  *
38  * 4. All advertising materials mentioning features or use of this software
39  *    must display the following acknowledgement:
40  *
41  *      This product includes software developed by Jeffrey M. Hsu
42  *      for the DragonFly Project.
43  *
44  *    This requirement may be waived with permission from Jeffrey Hsu.
45  *    Permission will be granted to any DragonFly user for free.
46  *    This requirement will sunset and may be removed on Jan 31, 2006,
47  *    after which the standard DragonFly license (as shown above) will
48  *    apply.
49  */
50
51 /*
52  * Copyright (c) 1980, 1986, 1993
53  *      The Regents of the University of California.  All rights reserved.
54  *
55  * Redistribution and use in source and binary forms, with or without
56  * modification, are permitted provided that the following conditions
57  * are met:
58  * 1. Redistributions of source code must retain the above copyright
59  *    notice, this list of conditions and the following disclaimer.
60  * 2. Redistributions in binary form must reproduce the above copyright
61  *    notice, this list of conditions and the following disclaimer in the
62  *    documentation and/or other materials provided with the distribution.
63  * 3. All advertising materials mentioning features or use of this software
64  *    must display the following acknowledgement:
65  *      This product includes software developed by the University of
66  *      California, Berkeley and its contributors.
67  * 4. Neither the name of the University nor the names of its contributors
68  *    may be used to endorse or promote products derived from this software
69  *    without specific prior written permission.
70  *
71  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
72  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
73  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
74  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
75  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
76  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
77  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
78  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
79  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
80  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
81  * SUCH DAMAGE.
82  *
83  *      @(#)route.h     8.4 (Berkeley) 1/9/95
84  * $FreeBSD: src/sys/net/route.h,v 1.36.2.5 2002/02/01 11:48:01 ru Exp $
85  * $DragonFly: src/sys/net/route.h,v 1.10 2005/01/06 17:59:32 hsu Exp $
86  */
87
88 #ifndef _NET_ROUTE_H_
89 #define _NET_ROUTE_H_
90
91 /*
92  * Kernel resident routing tables.
93  *
94  * The routing tables are initialized when interface addresses
95  * are set by making entries for all directly connected interfaces.
96  */
97
98 /*
99  * A route consists of a destination address and a reference
100  * to a routing entry.  These are often held by protocols
101  * in their control blocks, e.g. inpcb.
102  */
103 struct route {
104         struct  rtentry *ro_rt;
105         struct  sockaddr ro_dst;
106 };
107
108 /*
109  * These numbers are used by reliable protocols for determining
110  * retransmission behavior and are included in the routing structure.
111  */
112 struct rt_metrics {     /* grouped for locality of reference */
113         u_long  rmx_locks;      /* Kernel must leave these values alone */
114         u_long  rmx_mtu;        /* MTU for this path */
115         u_long  rmx_pksent;     /* packets sent using this route */
116         u_long  rmx_expire;     /* lifetime for route */
117
118         u_long  rmx_sendpipe;   /* outbound delay-bandwidth product */
119         u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
120         u_long  rmx_rtt;        /* estimated round trip time */
121         u_long  rmx_rttvar;     /* estimated rtt variance */
122
123         u_long  rmx_recvpipe;   /* inbound delay-bandwidth product */
124         u_long  rmx_hopcount;   /* max hops expected */
125         u_long  rmx_filler[4];  /* will be used for T/TCP later */
126 };
127
128 /*
129  * rmx_rtt and rmx_rttvar are stored as microseconds;
130  * RTTTOPRHZ(rtt) converts to a value suitable for use
131  * by a protocol slowtimo counter.
132  */
133 #define RTM_RTTUNIT     1000000 /* units for rtt, rttvar, as units per sec */
134 #define RTTTOPRHZ(r)    ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
135
136 /*
137  * XXX kernel function pointer `rt_output' is visible to applications.
138  */
139 struct mbuf;
140
141 /*
142  * We distinguish between routes to hosts and routes to networks,
143  * preferring the former if available.  For each route we infer
144  * the interface to use from the gateway address supplied when
145  * the route was entered.  Routes that forward packets through
146  * gateways are marked so that the output routines know to address the
147  * gateway rather than the ultimate destination.
148  */
149 #ifndef RNF_NORMAL
150 #include <net/radix.h>
151 #endif
152
153 struct rtentry {
154         struct  radix_node rt_nodes[2]; /* tree glue, and other values */
155 #define rt_key(r)       ((struct sockaddr *)((r)->rt_nodes->rn_key))
156 #define rt_mask(r)      ((struct sockaddr *)((r)->rt_nodes->rn_mask))
157         struct  sockaddr *rt_gateway;   /* value */
158         long    rt_refcnt;              /* # held references */
159         u_long  rt_flags;               /* up/down?, host/net */
160         struct  ifnet *rt_ifp;          /* the answer: interface to use */
161         struct  ifaddr *rt_ifa;         /* the answer: interface to use */
162         struct  sockaddr *rt_genmask;   /* for generation of cloned routes */
163         void    *rt_llinfo;             /* pointer to link level info cache */
164         struct  rt_metrics rt_rmx;      /* metrics used by rx'ing protocols */
165         struct  rtentry *rt_gwroute;    /* implied entry for gatewayed routes */
166         int     (*rt_output) (struct ifnet *, struct mbuf *, struct sockaddr *,
167                               struct rtentry *);
168                                         /* output routine for this (rt,if) */
169         struct  rtentry *rt_parent;     /* cloning parent of this route */
170         void    *rt_filler2;            /* more filler */
171 };
172
173 /*
174  * Following structure necessary for 4.3 compatibility;
175  * We should eventually move it to a compat file.
176  */
177 struct ortentry {
178         u_long  rt_hash;                /* to speed lookups */
179         struct  sockaddr rt_dst;        /* key */
180         struct  sockaddr rt_gateway;    /* value */
181         short   rt_flags;               /* up/down?, host/net */
182         short   rt_refcnt;              /* # held references */
183         u_long  rt_use;                 /* raw # packets forwarded */
184         struct  ifnet *rt_ifp;          /* the answer: interface to use */
185 };
186
187 #define rt_use rt_rmx.rmx_pksent
188
189 #define RTF_UP          0x1             /* route usable */
190 #define RTF_GATEWAY     0x2             /* destination is a gateway */
191 #define RTF_HOST        0x4             /* host entry (net otherwise) */
192 #define RTF_REJECT      0x8             /* host or net unreachable */
193 #define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
194 #define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
195 #define RTF_DONE        0x40            /* message confirmed */
196 /*                      0x80               unused, was RTF_DELCLONE */
197 #define RTF_CLONING     0x100           /* generate new routes on use */
198 #define RTF_XRESOLVE    0x200           /* external daemon resolves name */
199 #define RTF_LLINFO      0x400           /* generated by link layer (e.g. ARP) */
200 #define RTF_STATIC      0x800           /* manually added */
201 #define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
202 #define RTF_PROTO2      0x4000          /* protocol specific routing flag */
203 #define RTF_PROTO1      0x8000          /* protocol specific routing flag */
204
205 #define RTF_PRCLONING   0x10000         /* protocol requires cloning */
206 #define RTF_WASCLONED   0x20000         /* route generated through cloning */
207 #define RTF_PROTO3      0x40000         /* protocol specific routing flag */
208 /*                      0x80000            unused */
209 #define RTF_PINNED      0x100000        /* future use */
210 #define RTF_LOCAL       0x200000        /* route represents a local address */
211 #define RTF_BROADCAST   0x400000        /* route represents a bcast address */
212 #define RTF_MULTICAST   0x800000        /* route represents a mcast address */
213                                         /* 0x1000000 and up unassigned */
214
215 /*
216  * Routing statistics.
217  */
218 struct  rtstat {
219         short   rts_badredirect;        /* bogus redirect calls */
220         short   rts_dynamic;            /* routes created by redirects */
221         short   rts_newgateway;         /* routes modified by redirects */
222         short   rts_unreach;            /* lookups which failed */
223         short   rts_wildcard;           /* lookups satisfied by a wildcard */
224 };
225 /*
226  * Structures for routing messages.
227  */
228 struct rt_msghdr {
229         u_short rtm_msglen;     /* to skip over non-understood messages */
230         u_char  rtm_version;    /* future binary compatibility */
231         u_char  rtm_type;       /* message type */
232         u_short rtm_index;      /* index for associated ifp */
233         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
234         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
235         pid_t   rtm_pid;        /* identify sender */
236         int     rtm_seq;        /* for sender to identify action */
237         int     rtm_errno;      /* why failed */
238         int     rtm_use;        /* from rtentry */
239         u_long  rtm_inits;      /* which metrics we are initializing */
240         struct  rt_metrics rtm_rmx; /* metrics themselves */
241 };
242
243 #define RTM_VERSION     5       /* Up the ante and ignore older versions */
244
245 /*
246  * Message types.
247  */
248 #define RTM_ADD         0x1     /* Add Route */
249 #define RTM_DELETE      0x2     /* Delete Route */
250 #define RTM_CHANGE      0x3     /* Change Metrics or flags */
251 #define RTM_GET         0x4     /* Report Metrics */
252 #define RTM_LOSING      0x5     /* Kernel Suspects Partitioning */
253 #define RTM_REDIRECT    0x6     /* Told to use different route */
254 #define RTM_MISS        0x7     /* Lookup failed on this address */
255 #define RTM_LOCK        0x8     /* fix specified metrics */
256 #define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
257 #define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
258 #define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
259 #define RTM_NEWADDR     0xc     /* address being added to iface */
260 #define RTM_DELADDR     0xd     /* address being removed from iface */
261 #define RTM_IFINFO      0xe     /* iface going up/down etc. */
262 #define RTM_NEWMADDR    0xf     /* mcast group membership being added to if */
263 #define RTM_DELMADDR    0x10    /* mcast group membership being deleted */
264 #define RTM_IFANNOUNCE  0x11    /* iface arrival/departure */
265
266 /*
267  * Bitmask values for rtm_inits and rmx_locks.
268  */
269 #define RTV_MTU         0x1     /* init or lock _mtu */
270 #define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
271 #define RTV_EXPIRE      0x4     /* init or lock _expire */
272 #define RTV_RPIPE       0x8     /* init or lock _recvpipe */
273 #define RTV_SPIPE       0x10    /* init or lock _sendpipe */
274 #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
275 #define RTV_RTT         0x40    /* init or lock _rtt */
276 #define RTV_RTTVAR      0x80    /* init or lock _rttvar */
277
278 /*
279  * Bitmask values for rtm_addrs.
280  */
281 #define RTA_DST         0x1     /* destination sockaddr present */
282 #define RTA_GATEWAY     0x2     /* gateway sockaddr present */
283 #define RTA_NETMASK     0x4     /* netmask sockaddr present */
284 #define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
285 #define RTA_IFP         0x10    /* interface name sockaddr present */
286 #define RTA_IFA         0x20    /* interface addr sockaddr present */
287 #define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
288 #define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
289
290 /*
291  * Index offsets for sockaddr array for alternate internal encoding.
292  */
293 #define RTAX_DST        0       /* destination sockaddr present */
294 #define RTAX_GATEWAY    1       /* gateway sockaddr present */
295 #define RTAX_NETMASK    2       /* netmask sockaddr present */
296 #define RTAX_GENMASK    3       /* cloning mask sockaddr present */
297 #define RTAX_IFP        4       /* interface name sockaddr present */
298 #define RTAX_IFA        5       /* interface addr sockaddr present */
299 #define RTAX_AUTHOR     6       /* sockaddr for author of redirect */
300 #define RTAX_BRD        7       /* for NEWADDR, broadcast or p-p dest addr */
301 #define RTAX_MAX        8       /* size of array to allocate */
302
303 struct rt_addrinfo {
304         int     rti_addrs;
305         struct  sockaddr *rti_info[RTAX_MAX];
306         int     rti_flags;
307         struct  ifaddr *rti_ifa;
308         struct  ifnet *rti_ifp;
309 };
310
311 #ifdef _KERNEL
312
313 #define sa_dst          rti_info[RTAX_DST]
314 #define sa_gateway      rti_info[RTAX_GATEWAY]
315 #define sa_netmask      rti_info[RTAX_NETMASK]
316 #define sa_genmask      rti_info[RTAX_GENMASK]
317 #define sa_ifpaddr      rti_info[RTAX_IFP]
318 #define sa_ifaaddr      rti_info[RTAX_IFA]
319 #define sa_author       rti_info[RTAX_AUTHOR]
320 #define sa_bcastaddr    rti_info[RTAX_BRD]
321
322 extern struct radix_node_head *rt_tables[AF_MAX+1];
323
324 struct ifmultiaddr;
325 struct proc;
326
327 void     route_init (void);
328 void     rt_dstmsg(int type, struct sockaddr *dst, int error);
329 int      rt_getifa (struct rt_addrinfo *);
330 void     rt_ifannouncemsg (struct ifnet *, int);
331 void     rt_ifmsg (struct ifnet *);
332 int      rt_llroute (struct sockaddr *dst, struct rtentry *rt0,
333             struct rtentry **drt);
334 void     rt_missmsg (int, struct rt_addrinfo *, int, int);
335 void     rt_newaddrmsg (int, struct ifaddr *, int, struct rtentry *);
336 void     rt_newmaddrmsg (int, struct ifmultiaddr *);
337 void     rt_rtmsg(int cmd, struct rtentry *rt, struct ifnet *ifp, int error);
338 int      rt_setgate (struct rtentry *,
339             struct sockaddr *, struct sockaddr *);
340 void     rtalloc (struct route *);
341 void     rtalloc_ign (struct route *, u_long);
342
343 struct rtentry *
344          _rtlookup (struct sockaddr *, boolean_t, u_long);
345 #define         RTL_REPORTMSG   TRUE
346 #define         RTL_DONTREPORT  FALSE
347
348 /* flags to ignore */
349 #define         RTL_DOCLONE     0UL
350 #define         RTL_DONTCLONE   (RTF_CLONING | RTF_PRCLONING)
351
352 /*
353  * Look up a route with no cloning side-effects or miss reports generated.
354  */
355 static __inline struct rtentry *
356 rtpurelookup(struct sockaddr *dst)
357 {
358         return _rtlookup(dst, RTL_DONTREPORT, RTL_DONTCLONE);
359 }
360
361 /*
362  * Do full route lookup with cloning and reporting on misses.
363  */
364 static __inline struct rtentry *
365 rtlookup(struct sockaddr *dst)
366 {
367         return _rtlookup(dst, RTL_REPORTMSG, RTL_DOCLONE);
368 }
369
370 void     rtfree (struct rtentry *);
371 int      rtinit (struct ifaddr *, int, int);
372 int      rtioctl (u_long, caddr_t, struct thread *);
373 void     rtredirect (struct sockaddr *, struct sockaddr *,
374             struct sockaddr *, int, struct sockaddr *, struct rtentry **);
375 int      rtrequest (int, struct sockaddr *,
376             struct sockaddr *, struct sockaddr *, int, struct rtentry **);
377 int      rtrequest1 (int, struct rt_addrinfo *, struct rtentry **);
378
379 static __inline void
380 RTFREE(struct rtentry *rt)
381 {
382         if (rt->rt_refcnt <= 1)
383                 rtfree(rt);
384         else
385                 --rt->rt_refcnt;
386 }
387 #endif
388
389 #endif