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