1 | /* |
2 | * Copyright (c) 2000-2017 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 | * These numbers are used by reliable protocols for determining |
73 | * retransmission behavior and are included in the routing structure. |
74 | */ |
75 | struct rt_metrics { |
76 | u_int32_t rmx_locks; /* Kernel leaves these values alone */ |
77 | u_int32_t rmx_mtu; /* MTU for this path */ |
78 | u_int32_t rmx_hopcount; /* max hops expected */ |
79 | int32_t rmx_expire; /* lifetime for route, e.g. redirect */ |
80 | u_int32_t rmx_recvpipe; /* inbound delay-bandwidth product */ |
81 | u_int32_t rmx_sendpipe; /* outbound delay-bandwidth product */ |
82 | u_int32_t rmx_ssthresh; /* outbound gateway buffer limit */ |
83 | u_int32_t rmx_rtt; /* estimated round trip time */ |
84 | u_int32_t rmx_rttvar; /* estimated rtt variance */ |
85 | u_int32_t rmx_pksent; /* packets sent using this route */ |
86 | u_int32_t rmx_state; /* route state */ |
87 | u_int32_t rmx_filler[3]; /* will be used for T/TCP later */ |
88 | }; |
89 | |
90 | /* |
91 | * rmx_rtt and rmx_rttvar are stored as microseconds; |
92 | */ |
93 | #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ |
94 | |
95 | #ifdef PRIVATE |
96 | struct route_old { |
97 | void *ro_rt; |
98 | uint32_t ro_flags; |
99 | struct sockaddr ro_dst; |
100 | }; |
101 | #endif /* PRIVATE */ |
102 | |
103 | #ifdef BSD_KERNEL_PRIVATE |
104 | #include <kern/locks.h> |
105 | #include <net/radix.h> |
106 | #include <net/if_llatbl.h> |
107 | #include <sys/eventhandler.h> |
108 | #include <net/if_dl.h> |
109 | |
110 | /* |
111 | * Kernel resident routing tables. |
112 | * |
113 | * The routing tables are initialized when interface addresses |
114 | * are set by making entries for all directly connected interfaces. |
115 | */ |
116 | |
117 | /* forward declarations */ |
118 | struct ifnet_llreach_info; |
119 | struct rt_reach_info; |
120 | |
121 | /* |
122 | * IP route structure |
123 | * |
124 | * A route consists of a destination address and a reference |
125 | * to a routing entry. These are often held by protocols |
126 | * in their control blocks, e.g. inpcb. |
127 | */ |
128 | struct route { |
129 | /* |
130 | * N.B: struct route must begin with ro_{rt, lle, srcia, flags} |
131 | * because the code does some casts of a 'struct route_in6 *' |
132 | * to a 'struct route *'. |
133 | */ |
134 | struct rtentry *ro_rt; |
135 | struct llentry *ro_lle; |
136 | |
137 | struct ifaddr *ro_srcia; |
138 | uint32_t ro_flags; /* route flags (see below) */ |
139 | struct sockaddr ro_dst; |
140 | }; |
141 | |
142 | #define ROF_SRCIF_SELECTED 0x0001 /* source interface was selected */ |
143 | #if 0 |
144 | /* XXX These will be used in the changes coming in later */ |
145 | #define ROF_NORTREF 0x0002 /* doesn't hold reference on ro_rt */ |
146 | #define ROF_L2_ME 0x0004 /* dst L2 addr is our address */ |
147 | #define ROF_MAY_LOOP 0x0008 /* dst may require loop copy */ |
148 | #define ROF_HAS_HEADER 0x0010 /* mbuf already have its header prepended */ |
149 | #define ROF_REJECT 0x0020 /* Destination is reject */ |
150 | #define ROF_BLACKHOLE 0x0040 /* Destination is blackhole */ |
151 | #define ROF_HAS_GW 0x0080 /* Destination has GW */ |
152 | #endif |
153 | #define ROF_LLE_CACHE 0x0100 /* Cache link layer */ |
154 | |
155 | #define ROUTE_UNUSABLE(_ro) \ |
156 | ((_ro)->ro_rt == NULL || \ |
157 | ((_ro)->ro_rt->rt_flags & (RTF_UP|RTF_CONDEMNED)) != RTF_UP || \ |
158 | RT_GENID_OUTOFSYNC((_ro)->ro_rt)) |
159 | |
160 | #define _ROUTE_RELEASE_COMMON(_ro, _rnh_locked) do { \ |
161 | if ((_ro)->ro_rt != NULL) { \ |
162 | RT_LOCK_ASSERT_NOTHELD((_ro)->ro_rt); \ |
163 | if (_rnh_locked) \ |
164 | rtfree_locked((_ro)->ro_rt); \ |
165 | else \ |
166 | rtfree((_ro)->ro_rt); \ |
167 | (_ro)->ro_rt = NULL; \ |
168 | } \ |
169 | if ((_ro)->ro_srcia != NULL) { \ |
170 | IFA_REMREF((_ro)->ro_srcia); \ |
171 | (_ro)->ro_srcia = NULL; \ |
172 | (_ro)->ro_flags &= ~ROF_SRCIF_SELECTED; \ |
173 | } \ |
174 | if ((_ro)->ro_lle != NULL) { \ |
175 | LLE_REMREF((_ro)->ro_lle); \ |
176 | (_ro)->ro_lle = NULL; \ |
177 | (_ro)->ro_flags &= ~ROF_LLE_CACHE; \ |
178 | } \ |
179 | } while (0) |
180 | |
181 | #define ROUTE_RELEASE_LOCKED(_ro) _ROUTE_RELEASE_COMMON(_ro, TRUE) |
182 | #define ROUTE_RELEASE(_ro) _ROUTE_RELEASE_COMMON(_ro, FALSE) |
183 | |
184 | /* |
185 | * We distinguish between routes to hosts and routes to networks, |
186 | * preferring the former if available. For each route we infer |
187 | * the interface to use from the gateway address supplied when |
188 | * the route was entered. Routes that forward packets through |
189 | * gateways are marked so that the output routines know to address the |
190 | * gateway rather than the ultimate destination. |
191 | */ |
192 | |
193 | #define NRTT_HIST 10 |
194 | /* |
195 | * Kernel routing entry structure. |
196 | */ |
197 | struct rtentry { |
198 | struct radix_node rt_nodes[2]; /* tree glue, and other values */ |
199 | #define rt_key(r) (SA((r)->rt_nodes->rn_key)) |
200 | #define rt_mask(r) (SA((r)->rt_nodes->rn_mask)) |
201 | /* |
202 | * See bsd/net/route.c for synchronization notes. |
203 | */ |
204 | decl_lck_mtx_data(, rt_lock); /* lock for routing entry */ |
205 | uint32_t rt_refcnt; /* # held references */ |
206 | uint32_t rt_flags; /* up/down?, host/net */ |
207 | uint32_t rt_genid; /* route generation id */ |
208 | struct sockaddr *rt_gateway; /* value */ |
209 | struct ifnet *rt_ifp; /* the answer: interface to use */ |
210 | struct ifaddr *rt_ifa; /* the answer: interface addr to use */ |
211 | struct sockaddr *rt_genmask; /* for generation of cloned routes */ |
212 | void *rt_llinfo; /* pointer to link level info cache */ |
213 | void (*rt_llinfo_get_ri) /* llinfo get reachability info fn */ |
214 | (struct rtentry *, struct rt_reach_info *); |
215 | void (*rt_llinfo_get_iflri) /* ifnet llinfo get reach. info fn */ |
216 | (struct rtentry *, struct ifnet_llreach_info *); |
217 | void (*rt_llinfo_purge)(struct rtentry *); /* llinfo purge fn */ |
218 | void (*rt_llinfo_free)(void *); /* link level info free function */ |
219 | void (*rt_llinfo_refresh) (struct rtentry *); /* expedite llinfo refresh */ |
220 | struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ |
221 | #define rt_use rt_rmx.rmx_pksent |
222 | struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ |
223 | struct rtentry *rt_parent; /* cloning parent of this route */ |
224 | struct nstat_counts *rt_stats; /* route stats */ |
225 | void (*rt_if_ref_fn)(struct ifnet *, int); /* interface ref func */ |
226 | |
227 | uint32_t *rt_tree_genid; /* ptr to per-tree route_genid */ |
228 | uint64_t rt_expire; /* expiration time in uptime seconds */ |
229 | uint64_t base_calendartime; /* calendar time upon entry creation */ |
230 | uint64_t base_uptime; /* uptime upon entry creation */ |
231 | u_int32_t rtt_hist[NRTT_HIST]; /* RTT history sample by TCP connections */ |
232 | u_int32_t rtt_min; /* minimum RTT computed from history */ |
233 | u_int32_t rtt_expire_ts; /* RTT history expire timestamp */ |
234 | u_int8_t rtt_index; /* Index into RTT history */ |
235 | /* Event handler context for the rtentrt */ |
236 | struct eventhandler_lists_ctxt rt_evhdlr_ctxt; |
237 | }; |
238 | |
239 | enum { |
240 | ROUTE_STATUS_UPDATE = 1, |
241 | ROUTE_ENTRY_REFRESH, |
242 | ROUTE_ENTRY_DELETED, |
243 | ROUTE_LLENTRY_RESOLVED, |
244 | ROUTE_LLENTRY_UNREACH, |
245 | ROUTE_LLENTRY_CHANGED, |
246 | ROUTE_LLENTRY_STALE, |
247 | ROUTE_LLENTRY_TIMEDOUT, |
248 | ROUTE_LLENTRY_DELETED, |
249 | ROUTE_LLENTRY_EXPIRED, |
250 | ROUTE_LLENTRY_PROBED, |
251 | ROUTE_EVHDLR_DEREGISTER, |
252 | }; |
253 | |
254 | extern const char * route_event2str(int route_event); |
255 | |
256 | typedef void (*route_event_fn) (struct eventhandler_entry_arg, |
257 | struct sockaddr *, int, struct sockaddr *, int); |
258 | EVENTHANDLER_DECLARE(route_event, route_event_fn); |
259 | |
260 | /* |
261 | * Synchronize route entry's generation ID with the tree's. |
262 | */ |
263 | #define RT_GENID_SYNC(_rt) do { \ |
264 | if ((_rt)->rt_tree_genid != NULL) \ |
265 | (_rt)->rt_genid = *(_rt)->rt_tree_genid; \ |
266 | } while (0) |
267 | |
268 | /* |
269 | * Indicates whether or not the route entry's generation ID is stale. |
270 | */ |
271 | #define RT_GENID_OUTOFSYNC(_rt) \ |
272 | ((_rt)->rt_tree_genid != NULL && \ |
273 | *(_rt)->rt_tree_genid != (_rt)->rt_genid) |
274 | |
275 | enum { |
276 | ROUTE_OP_READ, |
277 | ROUTE_OP_WRITE, |
278 | }; |
279 | |
280 | extern int route_op_entitlement_check(struct socket *, kauth_cred_t, int, boolean_t); |
281 | #endif /* BSD_KERNEL_PRIVATE */ |
282 | |
283 | #define RTF_UP 0x1 /* route usable */ |
284 | #define RTF_GATEWAY 0x2 /* destination is a gateway */ |
285 | #define RTF_HOST 0x4 /* host entry (net otherwise) */ |
286 | #define RTF_REJECT 0x8 /* host or net unreachable */ |
287 | #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ |
288 | #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ |
289 | #define RTF_DONE 0x40 /* message confirmed */ |
290 | #define RTF_DELCLONE 0x80 /* delete cloned route */ |
291 | #define RTF_CLONING 0x100 /* generate new routes on use */ |
292 | #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ |
293 | #define RTF_LLINFO 0x400 /* DEPRECATED - exists ONLY for backward |
294 | compatibility */ |
295 | #define RTF_LLDATA 0x400 /* used by apps to add/del L2 entries */ |
296 | #define RTF_STATIC 0x800 /* manually added */ |
297 | #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ |
298 | #define RTF_NOIFREF 0x2000 /* not eligible for RTF_IFREF */ |
299 | #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ |
300 | #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ |
301 | |
302 | #define RTF_PRCLONING 0x10000 /* protocol requires cloning */ |
303 | #define RTF_WASCLONED 0x20000 /* route generated through cloning */ |
304 | #define RTF_PROTO3 0x40000 /* protocol specific routing flag */ |
305 | /* 0x80000 unused */ |
306 | #define RTF_PINNED 0x100000 /* future use */ |
307 | #define RTF_LOCAL 0x200000 /* route represents a local address */ |
308 | #define RTF_BROADCAST 0x400000 /* route represents a bcast address */ |
309 | #define RTF_MULTICAST 0x800000 /* route represents a mcast address */ |
310 | #define RTF_IFSCOPE 0x1000000 /* has valid interface scope */ |
311 | #define RTF_CONDEMNED 0x2000000 /* defunct; no longer modifiable */ |
312 | #define RTF_IFREF 0x4000000 /* route holds a ref to interface */ |
313 | #define RTF_PROXY 0x8000000 /* proxying, no interface scope */ |
314 | #define RTF_ROUTER 0x10000000 /* host is a router */ |
315 | #define RTF_DEAD 0x20000000 /* Route entry is being freed */ |
316 | /* 0x40000000 and up unassigned */ |
317 | |
318 | #define RTPRF_OURS RTF_PROTO3 /* set on routes we manage */ |
319 | #define RTF_BITS \ |
320 | "\020\1UP\2GATEWAY\3HOST\4REJECT\5DYNAMIC\6MODIFIED\7DONE" \ |
321 | "\10DELCLONE\11CLONING\12XRESOLVE\13LLINFO\14STATIC\15BLACKHOLE" \ |
322 | "\16NOIFREF\17PROTO2\20PROTO1\21PRCLONING\22WASCLONED\23PROTO3" \ |
323 | "\25PINNED\26LOCAL\27BROADCAST\30MULTICAST\31IFSCOPE\32CONDEMNED" \ |
324 | "\33IFREF\34PROXY\35ROUTER" |
325 | |
326 | #define IS_DIRECT_HOSTROUTE(rt) \ |
327 | (((rt)->rt_flags & (RTF_HOST | RTF_GATEWAY)) == RTF_HOST) |
328 | /* |
329 | * Routing statistics. |
330 | */ |
331 | struct rtstat { |
332 | short rts_badredirect; /* bogus redirect calls */ |
333 | short rts_dynamic; /* routes created by redirects */ |
334 | short rts_newgateway; /* routes modified by redirects */ |
335 | short rts_unreach; /* lookups which failed */ |
336 | short rts_wildcard; /* lookups satisfied by a wildcard */ |
337 | short rts_badrtgwroute; /* route to gateway is not direct */ |
338 | }; |
339 | |
340 | /* |
341 | * Structures for routing messages. |
342 | */ |
343 | struct rt_msghdr { |
344 | u_short rtm_msglen; /* to skip over non-understood messages */ |
345 | u_char rtm_version; /* future binary compatibility */ |
346 | u_char rtm_type; /* message type */ |
347 | u_short rtm_index; /* index for associated ifp */ |
348 | int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ |
349 | int rtm_addrs; /* bitmask identifying sockaddrs in msg */ |
350 | pid_t rtm_pid; /* identify sender */ |
351 | int rtm_seq; /* for sender to identify action */ |
352 | int rtm_errno; /* why failed */ |
353 | int rtm_use; /* from rtentry */ |
354 | u_int32_t rtm_inits; /* which metrics we are initializing */ |
355 | struct rt_metrics rtm_rmx; /* metrics themselves */ |
356 | }; |
357 | |
358 | struct rt_msghdr2 { |
359 | u_short rtm_msglen; /* to skip over non-understood messages */ |
360 | u_char rtm_version; /* future binary compatibility */ |
361 | u_char rtm_type; /* message type */ |
362 | u_short rtm_index; /* index for associated ifp */ |
363 | int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ |
364 | int rtm_addrs; /* bitmask identifying sockaddrs in msg */ |
365 | int32_t rtm_refcnt; /* reference count */ |
366 | int rtm_parentflags; /* flags of the parent route */ |
367 | int rtm_reserved; /* reserved field set to 0 */ |
368 | int rtm_use; /* from rtentry */ |
369 | u_int32_t rtm_inits; /* which metrics we are initializing */ |
370 | struct rt_metrics rtm_rmx; /* metrics themselves */ |
371 | }; |
372 | |
373 | #ifdef PRIVATE |
374 | struct kev_netevent_apnfallbk_data { |
375 | pid_t epid; /* effective PID */ |
376 | uuid_t euuid; /* effective UUID */ |
377 | }; |
378 | |
379 | /* |
380 | * Route reachability info. |
381 | */ |
382 | struct rt_reach_info { |
383 | u_int32_t ri_refcnt; /* reference count */ |
384 | u_int32_t ri_probes; /* total # of probes */ |
385 | u_int64_t ri_snd_expire; /* tx expiration (calendar) time */ |
386 | u_int64_t ri_rcv_expire; /* rx expiration (calendar) time */ |
387 | int32_t ; /* received signal strength */ |
388 | int32_t ri_lqm; /* link quality metric */ |
389 | int32_t ri_npm; /* node proximity metric */ |
390 | }; |
391 | |
392 | /* |
393 | * Extended routing message header (private). |
394 | */ |
395 | struct rt_msghdr_ext { |
396 | u_short rtm_msglen; /* to skip over non-understood messages */ |
397 | u_char rtm_version; /* future binary compatibility */ |
398 | u_char rtm_type; /* message type */ |
399 | u_int32_t rtm_index; /* index for associated ifp */ |
400 | u_int32_t rtm_flags; /* flags, incl. kern & message, e.g. DONE */ |
401 | u_int32_t rtm_reserved; /* for future use */ |
402 | u_int32_t rtm_addrs; /* bitmask identifying sockaddrs in msg */ |
403 | pid_t rtm_pid; /* identify sender */ |
404 | int rtm_seq; /* for sender to identify action */ |
405 | int rtm_errno; /* why failed */ |
406 | u_int32_t rtm_use; /* from rtentry */ |
407 | u_int32_t rtm_inits; /* which metrics we are initializing */ |
408 | struct rt_metrics rtm_rmx; /* metrics themselves */ |
409 | struct rt_reach_info rtm_ri; /* route reachability info */ |
410 | }; |
411 | #endif /* PRIVATE */ |
412 | |
413 | #define RTM_VERSION 5 /* Up the ante and ignore older versions */ |
414 | |
415 | /* |
416 | * Message types. |
417 | */ |
418 | #define RTM_ADD 0x1 /* Add Route */ |
419 | #define RTM_DELETE 0x2 /* Delete Route */ |
420 | #define RTM_CHANGE 0x3 /* Change Metrics or flags */ |
421 | #define RTM_GET 0x4 /* Report Metrics */ |
422 | #define RTM_LOSING 0x5 /* RTM_LOSING is no longer generated by xnu |
423 | and is deprecated */ |
424 | #define RTM_REDIRECT 0x6 /* Told to use different route */ |
425 | #define RTM_MISS 0x7 /* Lookup failed on this address */ |
426 | #define RTM_LOCK 0x8 /* fix specified metrics */ |
427 | #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ |
428 | #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ |
429 | #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ |
430 | #define RTM_NEWADDR 0xc /* address being added to iface */ |
431 | #define RTM_DELADDR 0xd /* address being removed from iface */ |
432 | #define RTM_IFINFO 0xe /* iface going up/down etc. */ |
433 | #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ |
434 | #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ |
435 | #ifdef PRIVATE |
436 | #define RTM_GET_SILENT 0x11 |
437 | #endif /* PRIVATE */ |
438 | #define RTM_IFINFO2 0x12 /* */ |
439 | #define RTM_NEWMADDR2 0x13 /* */ |
440 | #define RTM_GET2 0x14 /* */ |
441 | #ifdef PRIVATE |
442 | #define RTM_GET_EXT 0x15 |
443 | #endif /* PRIVATE */ |
444 | |
445 | /* |
446 | * Bitmask values for rtm_inits and rmx_locks. |
447 | */ |
448 | #define RTV_MTU 0x1 /* init or lock _mtu */ |
449 | #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ |
450 | #define RTV_EXPIRE 0x4 /* init or lock _expire */ |
451 | #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ |
452 | #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ |
453 | #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ |
454 | #define RTV_RTT 0x40 /* init or lock _rtt */ |
455 | #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ |
456 | #ifdef PRIVATE |
457 | #define RTV_REFRESH_HOST 0x100 /* init host route to expedite refresh */ |
458 | #endif |
459 | |
460 | /* |
461 | * Bitmask values for rtm_addrs. |
462 | */ |
463 | #define RTA_DST 0x1 /* destination sockaddr present */ |
464 | #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ |
465 | #define RTA_NETMASK 0x4 /* netmask sockaddr present */ |
466 | #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ |
467 | #define RTA_IFP 0x10 /* interface name sockaddr present */ |
468 | #define RTA_IFA 0x20 /* interface addr sockaddr present */ |
469 | #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ |
470 | #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ |
471 | |
472 | /* |
473 | * Index offsets for sockaddr array for alternate internal encoding. |
474 | */ |
475 | #define RTAX_DST 0 /* destination sockaddr present */ |
476 | #define RTAX_GATEWAY 1 /* gateway sockaddr present */ |
477 | #define RTAX_NETMASK 2 /* netmask sockaddr present */ |
478 | #define RTAX_GENMASK 3 /* cloning mask sockaddr present */ |
479 | #define RTAX_IFP 4 /* interface name sockaddr present */ |
480 | #define RTAX_IFA 5 /* interface addr sockaddr present */ |
481 | #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ |
482 | #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ |
483 | #define RTAX_MAX 8 /* size of array to allocate */ |
484 | |
485 | struct rt_addrinfo { |
486 | int rti_addrs; |
487 | struct sockaddr *rti_info[RTAX_MAX]; |
488 | }; |
489 | |
490 | #ifdef PRIVATE |
491 | /* |
492 | * For scoped routing; a zero interface scope value means nil/no scope. |
493 | */ |
494 | #define IFSCOPE_NONE 0 |
495 | #endif /* PRIVATE */ |
496 | |
497 | #ifdef BSD_KERNEL_PRIVATE |
498 | /* |
499 | * Generic call trace used by some subsystems (e.g. route, ifaddr) |
500 | */ |
501 | #define CTRACE_STACK_SIZE 8 /* depth of stack trace */ |
502 | #define CTRACE_HIST_SIZE 4 /* refcnt history size */ |
503 | typedef struct ctrace { |
504 | void *th; /* thread ptr */ |
505 | void *pc[CTRACE_STACK_SIZE]; /* PC stack trace */ |
506 | } ctrace_t; |
507 | |
508 | extern void ctrace_record(ctrace_t *); |
509 | |
510 | #define RT_LOCK_ASSERT_HELD(_rt) \ |
511 | LCK_MTX_ASSERT(&(_rt)->rt_lock, LCK_MTX_ASSERT_OWNED) |
512 | |
513 | #define RT_LOCK_ASSERT_NOTHELD(_rt) \ |
514 | LCK_MTX_ASSERT(&(_rt)->rt_lock, LCK_MTX_ASSERT_NOTOWNED) |
515 | |
516 | #define RT_LOCK(_rt) do { \ |
517 | rt_lock(_rt, FALSE); \ |
518 | } while (0) |
519 | |
520 | #define RT_LOCK_SPIN(_rt) do { \ |
521 | rt_lock(_rt, TRUE); \ |
522 | } while (0) |
523 | |
524 | #define RT_CONVERT_LOCK(_rt) do { \ |
525 | RT_LOCK_ASSERT_HELD(_rt); \ |
526 | lck_mtx_convert_spin(&(_rt)->rt_lock); \ |
527 | } while (0) |
528 | |
529 | #define RT_UNLOCK(_rt) do { \ |
530 | rt_unlock(_rt); \ |
531 | } while (0) |
532 | |
533 | #define RT_ADDREF_LOCKED(_rt) do { \ |
534 | rtref(_rt); \ |
535 | } while (0) |
536 | |
537 | /* |
538 | * Spin variant mutex is used here; caller is responsible for |
539 | * converting any previously-held similar lock to full mutex. |
540 | */ |
541 | #define RT_ADDREF(_rt) do { \ |
542 | RT_LOCK_SPIN(_rt); \ |
543 | RT_ADDREF_LOCKED(_rt); \ |
544 | RT_UNLOCK(_rt); \ |
545 | } while (0) |
546 | |
547 | #define RT_REMREF_LOCKED(_rt) do { \ |
548 | (void) rtunref(_rt); \ |
549 | } while (0) |
550 | |
551 | /* |
552 | * Spin variant mutex is used here; caller is responsible for |
553 | * converting any previously-held similar lock to full mutex. |
554 | */ |
555 | #define RT_REMREF(_rt) do { \ |
556 | RT_LOCK_SPIN(_rt); \ |
557 | RT_REMREF_LOCKED(_rt); \ |
558 | RT_UNLOCK(_rt); \ |
559 | } while (0) |
560 | |
561 | /* |
562 | * This macro calculates skew in wall clock, just in case the user changes the |
563 | * system time. This skew adjustment is required because we now keep the |
564 | * expiration times in uptime terms in the kernel, but the userland still |
565 | * expects expiration times in terms of calendar times. This is used when |
566 | * reporting rt_expire, ln_expire, etc. values to user space. |
567 | */ |
568 | #define NET_CALCULATE_CLOCKSKEW(cc, ic, cu, iu) \ |
569 | ((cc.tv_sec - ic) - (cu - iu)) |
570 | |
571 | extern unsigned int rt_verbose; |
572 | extern struct radix_node_head *rt_tables[AF_MAX+1]; |
573 | extern lck_mtx_t *rnh_lock; |
574 | extern uint32_t route_genid_inet; /* INET route generation count */ |
575 | #if INET6 |
576 | extern uint32_t route_genid_inet6; /* INET6 route generation count */ |
577 | #endif /* INET6 */ |
578 | extern int rttrash; |
579 | extern unsigned int rte_debug; |
580 | |
581 | struct ifmultiaddr; |
582 | struct proc; |
583 | |
584 | extern void route_init(void); |
585 | extern void routegenid_update(void); |
586 | extern void routegenid_inet_update(void); |
587 | extern void routegenid_inet6_update(void); |
588 | extern void rt_ifmsg(struct ifnet *); |
589 | extern void rt_missmsg(int, struct rt_addrinfo *, int, int); |
590 | extern void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *); |
591 | extern void rt_newmaddrmsg(int, struct ifmultiaddr *); |
592 | extern int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *); |
593 | extern void set_primary_ifscope(int, unsigned int); |
594 | extern unsigned int get_primary_ifscope(int); |
595 | extern boolean_t rt_primary_default(struct rtentry *, struct sockaddr *); |
596 | extern struct rtentry *rt_lookup(boolean_t, struct sockaddr *, |
597 | struct sockaddr *, struct radix_node_head *, unsigned int); |
598 | extern struct rtentry *rt_lookup_coarse(boolean_t, struct sockaddr *, |
599 | struct sockaddr *, struct radix_node_head *); |
600 | extern void rtalloc(struct route *); |
601 | extern void rtalloc_scoped(struct route *, unsigned int); |
602 | extern void rtalloc_ign(struct route *, uint32_t); |
603 | extern void rtalloc_scoped_ign(struct route *, uint32_t, unsigned int); |
604 | extern struct rtentry *rtalloc1(struct sockaddr *, int, uint32_t); |
605 | extern struct rtentry *rtalloc1_scoped(struct sockaddr *, int, uint32_t, |
606 | unsigned int); |
607 | extern struct rtentry *rtalloc1_scoped_locked(struct sockaddr *, int, |
608 | uint32_t, unsigned int); |
609 | extern void rtfree_locked(struct rtentry *); |
610 | extern void rtfree(struct rtentry *); |
611 | extern void rtref(struct rtentry *); |
612 | /* |
613 | * rtunref will decrement the refcount, rtfree will decrement and free if |
614 | * the refcount has reached zero and the route is not up. |
615 | * Unless you have good reason to do otherwise, use rtfree. |
616 | */ |
617 | extern int rtunref(struct rtentry *); |
618 | extern void rtsetifa(struct rtentry *, struct ifaddr *); |
619 | extern int rtinit(struct ifaddr *, int, int); |
620 | extern int rtinit_locked(struct ifaddr *, int, int); |
621 | extern int rtioctl(unsigned long, caddr_t, struct proc *); |
622 | extern void rtredirect(struct ifnet *, struct sockaddr *, struct sockaddr *, |
623 | struct sockaddr *, int, struct sockaddr *, struct rtentry **); |
624 | extern int rtrequest(int, struct sockaddr *, |
625 | struct sockaddr *, struct sockaddr *, int, struct rtentry **); |
626 | extern int rtrequest_scoped(int, struct sockaddr *, struct sockaddr *, |
627 | struct sockaddr *, int, struct rtentry **, unsigned int); |
628 | extern int rtrequest_locked(int, struct sockaddr *, |
629 | struct sockaddr *, struct sockaddr *, int, struct rtentry **); |
630 | extern int rtrequest_scoped_locked(int, struct sockaddr *, struct sockaddr *, |
631 | struct sockaddr *, int, struct rtentry **, unsigned int); |
632 | extern void sin_set_ifscope(struct sockaddr *, unsigned int); |
633 | extern unsigned int sin_get_ifscope(struct sockaddr *); |
634 | extern unsigned int sin6_get_ifscope(struct sockaddr *); |
635 | extern void rt_lock(struct rtentry *, boolean_t); |
636 | extern void rt_unlock(struct rtentry *); |
637 | extern struct sockaddr *rtm_scrub(int, int, struct sockaddr *, |
638 | struct sockaddr *, void *, uint32_t, kauth_cred_t *); |
639 | extern boolean_t rt_validate(struct rtentry *); |
640 | extern void rt_set_proxy(struct rtentry *, boolean_t); |
641 | extern void rt_set_gwroute(struct rtentry *, struct sockaddr *, |
642 | struct rtentry *); |
643 | extern void rt_revalidate_gwroute(struct rtentry *, struct rtentry *); |
644 | extern errno_t route_to_gwroute(const struct sockaddr *, struct rtentry *, |
645 | struct rtentry **); |
646 | extern void rt_setexpire(struct rtentry *, uint64_t); |
647 | extern void rt_str(struct rtentry *, char *, uint32_t, char *, uint32_t); |
648 | extern const char *rtm2str(int); |
649 | extern void route_copyin(struct route *, struct route *, size_t); |
650 | extern void route_copyout(struct route *, const struct route *, size_t); |
651 | extern boolean_t rt_ifa_is_dst(struct sockaddr *, struct ifaddr *); |
652 | extern struct sockaddr *sa_copy(struct sockaddr *, struct sockaddr_storage *, |
653 | unsigned int *); |
654 | |
655 | /* |
656 | * The following is used to enqueue work items for route events |
657 | * and also used to pass route event while walking the tree |
658 | */ |
659 | struct route_event { |
660 | struct rtentry *rt; |
661 | /* |
662 | * There's no reference taken on gwrt. |
663 | * We only use it to check whether we should |
664 | * point to rt_gateway or the embedded rt_addr |
665 | * structure. |
666 | */ |
667 | struct rtentry *gwrt; |
668 | union { |
669 | union sockaddr_in_4_6 _rtev_ipaddr; |
670 | struct sockaddr_dl _rtev_lladdr; |
671 | char _rtev_addr_bytes[DLIL_SDLMAXLEN]; |
672 | } rt_addr; |
673 | uint32_t route_event_code; |
674 | eventhandler_tag evtag; |
675 | }; |
676 | |
677 | #define rtev_ipaddr rt_addr._rtev_ipaddr |
678 | #define rtev_lladdr rt_addr._rtev_lladdr |
679 | #define rtev_addr_bytes rt_addr._rtev_addr_bytes |
680 | |
681 | extern void route_event_init(struct route_event *p_route_ev, struct rtentry *rt, |
682 | struct rtentry *gwrt, int route_ev_code); |
683 | extern int route_event_walktree(struct radix_node *rn, void *arg); |
684 | extern void route_event_enqueue_nwk_wq_entry(struct rtentry *, struct rtentry *, |
685 | uint32_t, eventhandler_tag, boolean_t); |
686 | #endif /* BSD_KERNEL_PRIVATE */ |
687 | #endif /* _NET_ROUTE_H_ */ |
688 | |