]> git.saurik.com Git - apple/xnu.git/blob - bsd/net/route.h
xnu-1504.15.3.tar.gz
[apple/xnu.git] / bsd / net / route.h
1 /*
2 * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28 /*
29 * Copyright (c) 1980, 1986, 1993
30 * The Regents of the University of California. All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 * This product includes software developed by the University of
43 * California, Berkeley and its contributors.
44 * 4. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 *
60 * @(#)route.h 8.3 (Berkeley) 4/19/94
61 * $FreeBSD: src/sys/net/route.h,v 1.36.2.1 2000/08/16 06:14:23 jayanth Exp $
62 */
63
64 #ifndef _NET_ROUTE_H_
65 #define _NET_ROUTE_H_
66 #include <sys/appleapiopts.h>
67 #include <stdint.h>
68 #include <sys/types.h>
69 #include <sys/socket.h>
70
71 /*
72 * Kernel resident routing tables.
73 *
74 * The routing tables are initialized when interface addresses
75 * are set by making entries for all directly connected interfaces.
76 */
77
78 /*
79 * A route consists of a destination address and a reference
80 * to a routing entry. These are often held by protocols
81 * in their control blocks, e.g. inpcb.
82 */
83 #ifdef PRIVATE
84 struct rtentry;
85 struct route {
86 /*
87 * N.B: struct route must begin with ro_rt and ro_flags
88 * because the code does some casts of a 'struct route_in6 *'
89 * to a 'struct route *'.
90 */
91 struct rtentry *ro_rt;
92 uint32_t ro_flags; /* route flags (see below) */
93 struct sockaddr ro_dst;
94 };
95
96 #define ROF_SRCIF_SELECTED 0x1 /* source interface was selected */
97
98 #else
99 struct route;
100 #endif /* PRIVATE */
101
102 /*
103 * These numbers are used by reliable protocols for determining
104 * retransmission behavior and are included in the routing structure.
105 */
106 struct rt_metrics {
107 u_int32_t rmx_locks; /* Kernel must leave these values alone */
108 u_int32_t rmx_mtu; /* MTU for this path */
109 u_int32_t rmx_hopcount; /* max hops expected */
110 int32_t rmx_expire; /* lifetime for route, e.g. redirect */
111 u_int32_t rmx_recvpipe; /* inbound delay-bandwidth product */
112 u_int32_t rmx_sendpipe; /* outbound delay-bandwidth product */
113 u_int32_t rmx_ssthresh; /* outbound gateway buffer limit */
114 u_int32_t rmx_rtt; /* estimated round trip time */
115 u_int32_t rmx_rttvar; /* estimated rtt variance */
116 u_int32_t rmx_pksent; /* packets sent using this route */
117 u_int32_t rmx_filler[4]; /* will be used for T/TCP later */
118 };
119
120 /*
121 * rmx_rtt and rmx_rttvar are stored as microseconds;
122 */
123 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
124
125 #ifdef KERNEL_PRIVATE
126 /*
127 * New expiry value (in seconds) when dealing with interfaces which implement
128 * the if_want_aggressive_drain behavior. Otherwise the event mechanism wouldn't
129 * fire quick enough to cause any sort of significant gains in performance.
130 */
131 #define RT_IF_IDLE_EXPIRE_TIMEOUT 30
132 #define RT_IF_IDLE_DRAIN_INTERVAL 10
133 #endif /* KERNEL_PRIVATE */
134
135 /*
136 * We distinguish between routes to hosts and routes to networks,
137 * preferring the former if available. For each route we infer
138 * the interface to use from the gateway address supplied when
139 * the route was entered. Routes that forward packets through
140 * gateways are marked so that the output routines know to address the
141 * gateway rather than the ultimate destination.
142 */
143 #ifdef KERNEL_PRIVATE
144 #include <kern/locks.h>
145 #ifndef RNF_NORMAL
146 #include <net/radix.h>
147 #endif
148 /*
149 * Kernel routing entry structure (private).
150 */
151 struct rtentry {
152 struct radix_node rt_nodes[2]; /* tree glue, and other values */
153 #define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key))
154 #define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask))
155 struct sockaddr *rt_gateway; /* value */
156 int32_t rt_refcnt; /* # held references */
157 uint32_t rt_flags; /* up/down?, host/net */
158 struct ifnet *rt_ifp; /* the answer: interface to use */
159 struct ifaddr *rt_ifa; /* the answer: interface addr to use */
160 struct sockaddr *rt_genmask; /* for generation of cloned routes */
161 void *rt_llinfo; /* pointer to link level info cache */
162 void (*rt_llinfo_free)(void *); /* link level info free function */
163 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */
164 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */
165 struct rtentry *rt_parent; /* cloning parent of this route */
166 uint32_t generation_id; /* route generation id */
167 /*
168 * See bsd/net/route.c for synchronization notes.
169 */
170 decl_lck_mtx_data(, rt_lock); /* lock for routing entry */
171 #if IFNET_ROUTE_REFCNT
172 void (*rt_if_ref_fn)(struct ifnet *, int); /* interface ref func */
173 #endif /* IFNET_ROUTE_REFCNT */
174 };
175 #endif /* KERNEL_PRIVATE */
176
177 #ifdef KERNEL_PRIVATE
178 #define rt_use rt_rmx.rmx_pksent
179 #endif /* KERNEL_PRIVATE */
180
181 #define RTF_UP 0x1 /* route usable */
182 #define RTF_GATEWAY 0x2 /* destination is a gateway */
183 #define RTF_HOST 0x4 /* host entry (net otherwise) */
184 #define RTF_REJECT 0x8 /* host or net unreachable */
185 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
186 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
187 #define RTF_DONE 0x40 /* message confirmed */
188 #define RTF_DELCLONE 0x80 /* delete cloned route */
189 #define RTF_CLONING 0x100 /* generate new routes on use */
190 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
191 #define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */
192 #define RTF_STATIC 0x800 /* manually added */
193 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
194 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
195 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
196
197 #define RTF_PRCLONING 0x10000 /* protocol requires cloning */
198 #define RTF_WASCLONED 0x20000 /* route generated through cloning */
199 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */
200 /* 0x80000 unused */
201 #define RTF_PINNED 0x100000 /* future use */
202 #define RTF_LOCAL 0x200000 /* route represents a local address */
203 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */
204 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */
205 #define RTF_IFSCOPE 0x1000000 /* has valid interface scope */
206 #define RTF_CONDEMNED 0x2000000 /* defunct; no longer modifiable */
207 #define RTF_IFREF 0x4000000 /* route holds a ref to interface */
208 /* 0x8000000 and up unassigned */
209
210 /*
211 * Routing statistics.
212 */
213 struct rtstat {
214 short rts_badredirect; /* bogus redirect calls */
215 short rts_dynamic; /* routes created by redirects */
216 short rts_newgateway; /* routes modified by redirects */
217 short rts_unreach; /* lookups which failed */
218 short rts_wildcard; /* lookups satisfied by a wildcard */
219 };
220
221 /*
222 * Structures for routing messages.
223 */
224 struct rt_msghdr {
225 u_short rtm_msglen; /* to skip over non-understood messages */
226 u_char rtm_version; /* future binary compatibility */
227 u_char rtm_type; /* message type */
228 u_short rtm_index; /* index for associated ifp */
229 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
230 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
231 pid_t rtm_pid; /* identify sender */
232 int rtm_seq; /* for sender to identify action */
233 int rtm_errno; /* why failed */
234 int rtm_use; /* from rtentry */
235 u_int32_t rtm_inits; /* which metrics we are initializing */
236 struct rt_metrics rtm_rmx; /* metrics themselves */
237 };
238
239 struct rt_msghdr2 {
240 u_short rtm_msglen; /* to skip over non-understood messages */
241 u_char rtm_version; /* future binary compatibility */
242 u_char rtm_type; /* message type */
243 u_short rtm_index; /* index for associated ifp */
244 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
245 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
246 int32_t rtm_refcnt; /* reference count */
247 int rtm_parentflags; /* flags of the parent route */
248 int rtm_reserved; /* reserved field set to 0 */
249 int rtm_use; /* from rtentry */
250 u_int32_t rtm_inits; /* which metrics we are initializing */
251 struct rt_metrics rtm_rmx; /* metrics themselves */
252 };
253
254
255 #define RTM_VERSION 5 /* Up the ante and ignore older versions */
256
257 /*
258 * Message types.
259 */
260 #define RTM_ADD 0x1 /* Add Route */
261 #define RTM_DELETE 0x2 /* Delete Route */
262 #define RTM_CHANGE 0x3 /* Change Metrics or flags */
263 #define RTM_GET 0x4 /* Report Metrics */
264 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
265 #define RTM_REDIRECT 0x6 /* Told to use different route */
266 #define RTM_MISS 0x7 /* Lookup failed on this address */
267 #define RTM_LOCK 0x8 /* fix specified metrics */
268 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
269 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
270 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
271 #define RTM_NEWADDR 0xc /* address being added to iface */
272 #define RTM_DELADDR 0xd /* address being removed from iface */
273 #define RTM_IFINFO 0xe /* iface going up/down etc. */
274 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
275 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
276 #ifdef PRIVATE
277 #define RTM_GET_SILENT 0x11
278 #endif /* PRIVATE */
279 #define RTM_IFINFO2 0x12 /* */
280 #define RTM_NEWMADDR2 0x13 /* */
281 #define RTM_GET2 0x14 /* */
282
283 /*
284 * Bitmask values for rtm_inits and rmx_locks.
285 */
286 #define RTV_MTU 0x1 /* init or lock _mtu */
287 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
288 #define RTV_EXPIRE 0x4 /* init or lock _expire */
289 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
290 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
291 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
292 #define RTV_RTT 0x40 /* init or lock _rtt */
293 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
294
295 /*
296 * Bitmask values for rtm_addrs.
297 */
298 #define RTA_DST 0x1 /* destination sockaddr present */
299 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
300 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
301 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
302 #define RTA_IFP 0x10 /* interface name sockaddr present */
303 #define RTA_IFA 0x20 /* interface addr sockaddr present */
304 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
305 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
306
307 /*
308 * Index offsets for sockaddr array for alternate internal encoding.
309 */
310 #define RTAX_DST 0 /* destination sockaddr present */
311 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
312 #define RTAX_NETMASK 2 /* netmask sockaddr present */
313 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
314 #define RTAX_IFP 4 /* interface name sockaddr present */
315 #define RTAX_IFA 5 /* interface addr sockaddr present */
316 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
317 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
318 #define RTAX_MAX 8 /* size of array to allocate */
319
320 struct rt_addrinfo {
321 int rti_addrs;
322 struct sockaddr *rti_info[RTAX_MAX];
323 };
324
325 struct route_cb {
326 int ip_count;
327 int ip6_count;
328 int ipx_count;
329 int ns_count;
330 int iso_count;
331 int any_count;
332 };
333
334 #ifdef PRIVATE
335 /*
336 * For scoped routing; a zero interface scope value means nil/no scope.
337 */
338 #define IFSCOPE_NONE 0
339 #endif /* PRIVATE */
340
341 #ifdef KERNEL_PRIVATE
342 /*
343 * Generic call trace used by some subsystems (e.g. route, ifaddr)
344 */
345 #define CTRACE_STACK_SIZE 8 /* depth of stack trace */
346 #define CTRACE_HIST_SIZE 4 /* refcnt history size */
347 typedef struct ctrace {
348 void *th; /* thread ptr */
349 void *pc[CTRACE_STACK_SIZE]; /* PC stack trace */
350 } ctrace_t;
351
352 extern void ctrace_record(ctrace_t *);
353
354 #define RT_LOCK_ASSERT_HELD(_rt) \
355 lck_mtx_assert(&(_rt)->rt_lock, LCK_MTX_ASSERT_OWNED)
356
357 #define RT_LOCK_ASSERT_NOTHELD(_rt) \
358 lck_mtx_assert(&(_rt)->rt_lock, LCK_MTX_ASSERT_NOTOWNED)
359
360 #define RT_LOCK(_rt) do { \
361 if (!rte_debug) \
362 lck_mtx_lock(&(_rt)->rt_lock); \
363 else \
364 rt_lock(_rt, FALSE); \
365 } while (0)
366
367 #define RT_LOCK_SPIN(_rt) do { \
368 if (!rte_debug) \
369 lck_mtx_lock_spin(&(_rt)->rt_lock); \
370 else \
371 rt_lock(_rt, TRUE); \
372 } while (0)
373
374 #define RT_CONVERT_LOCK(_rt) do { \
375 RT_LOCK_ASSERT_HELD(_rt); \
376 lck_mtx_convert_spin(&(_rt)->rt_lock); \
377 } while (0)
378
379 #define RT_UNLOCK(_rt) do { \
380 if (!rte_debug) \
381 lck_mtx_unlock(&(_rt)->rt_lock); \
382 else \
383 rt_unlock(_rt); \
384 } while (0)
385
386 #define RT_ADDREF_LOCKED(_rt) do { \
387 if (!rte_debug) { \
388 RT_LOCK_ASSERT_HELD(_rt); \
389 if (++(_rt)->rt_refcnt == 0) \
390 panic("RT_ADDREF(%p) bad refcnt\n", _rt); \
391 } else { \
392 rtref(_rt); \
393 } \
394 } while (0)
395
396 /*
397 * Spin variant mutex is used here; caller is responsible for
398 * converting any previously-held similar lock to full mutex.
399 */
400 #define RT_ADDREF(_rt) do { \
401 RT_LOCK_SPIN(_rt); \
402 RT_ADDREF_LOCKED(_rt); \
403 RT_UNLOCK(_rt); \
404 } while (0)
405
406 #define RT_REMREF_LOCKED(_rt) do { \
407 if (!rte_debug) { \
408 RT_LOCK_ASSERT_HELD(_rt); \
409 if ((_rt)->rt_refcnt == 0) \
410 panic("RT_REMREF(%p) bad refcnt\n", _rt); \
411 --(_rt)->rt_refcnt; \
412 } else { \
413 (void) rtunref(_rt); \
414 } \
415 } while (0)
416
417 /*
418 * Spin variant mutex is used here; caller is responsible for
419 * converting any previously-held similar lock to full mutex.
420 */
421 #define RT_REMREF(_rt) do { \
422 RT_LOCK_SPIN(_rt); \
423 RT_REMREF_LOCKED(_rt); \
424 RT_UNLOCK(_rt); \
425 } while (0)
426
427 #define RTFREE(_rt) rtfree(_rt)
428 #define RTFREE_LOCKED(_rt) rtfree_locked(_rt)
429
430 extern struct route_cb route_cb;
431 extern struct radix_node_head *rt_tables[AF_MAX+1];
432 __private_extern__ lck_mtx_t *rnh_lock;
433 __private_extern__ int use_routegenid;
434 __private_extern__ uint32_t route_generation;
435 __private_extern__ int rttrash;
436 __private_extern__ unsigned int rte_debug;
437
438 struct ifmultiaddr;
439 struct proc;
440
441 extern void route_init(void) __attribute__((section("__TEXT, initcode")));
442 extern void routegenid_update(void);
443 extern void rt_ifmsg(struct ifnet *);
444 extern void rt_missmsg(int, struct rt_addrinfo *, int, int);
445 extern void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
446 extern void rt_newmaddrmsg(int, struct ifmultiaddr *);
447 extern int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
448 extern void set_primary_ifscope(unsigned int);
449 extern unsigned int get_primary_ifscope(void);
450 extern boolean_t rt_inet_default(struct rtentry *, struct sockaddr *);
451 extern struct rtentry *rt_lookup(boolean_t, struct sockaddr *,
452 struct sockaddr *, struct radix_node_head *, unsigned int);
453 extern void rtalloc(struct route *);
454 extern void rtalloc_ign(struct route *, uint32_t);
455 extern void rtalloc_ign_locked(struct route *, uint32_t);
456 extern void rtalloc_scoped_ign(struct route *, uint32_t, unsigned int);
457 extern void rtalloc_scoped_ign_locked(struct route *, uint32_t, unsigned int);
458 extern struct rtentry *rtalloc1(struct sockaddr *, int, uint32_t);
459 extern struct rtentry *rtalloc1_locked(struct sockaddr *, int, uint32_t);
460 extern struct rtentry *rtalloc1_scoped(struct sockaddr *, int, uint32_t,
461 unsigned int);
462 extern struct rtentry *rtalloc1_scoped_locked(struct sockaddr *, int,
463 uint32_t, unsigned int);
464 extern void rtfree(struct rtentry *);
465 extern void rtfree_locked(struct rtentry *);
466 extern void rtref(struct rtentry *);
467 /*
468 * rtunref will decrement the refcount, rtfree will decrement and free if
469 * the refcount has reached zero and the route is not up.
470 * Unless you have good reason to do otherwise, use rtfree.
471 */
472 extern int rtunref(struct rtentry *);
473 extern void rtsetifa(struct rtentry *, struct ifaddr *);
474 extern int rtinit(struct ifaddr *, int, int);
475 extern int rtinit_locked(struct ifaddr *, int, int);
476 extern int rtioctl(unsigned long, caddr_t, struct proc *);
477 extern void rtredirect(struct ifnet *, struct sockaddr *, struct sockaddr *,
478 struct sockaddr *, int, struct sockaddr *, struct rtentry **);
479 extern int rtrequest(int, struct sockaddr *,
480 struct sockaddr *, struct sockaddr *, int, struct rtentry **);
481 extern int rtrequest_locked(int, struct sockaddr *,
482 struct sockaddr *, struct sockaddr *, int, struct rtentry **);
483 extern int rtrequest_scoped_locked(int, struct sockaddr *, struct sockaddr *,
484 struct sockaddr *, int, struct rtentry **, unsigned int);
485 extern unsigned int sa_get_ifscope(struct sockaddr *);
486 extern void rt_lock(struct rtentry *, boolean_t);
487 extern void rt_unlock(struct rtentry *);
488 extern struct sockaddr *rtm_scrub_ifscope(int, struct sockaddr *,
489 struct sockaddr *, struct sockaddr_storage *);
490 extern u_int64_t rt_expiry(struct rtentry *, u_int64_t, u_int32_t);
491 #if IFNET_ROUTE_REFCNT
492 extern void rt_aggdrain(int);
493 #endif /* IFNET_ROUTE_REFCNT */
494 #endif /* KERNEL_PRIVATE */
495
496 #endif