2 * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * Copyright (c) 1980, 1986, 1993
30 * The Regents of the University of California. All rights reserved.
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
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.
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
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 $
66 #include <sys/appleapiopts.h>
68 #include <sys/types.h>
69 #include <sys/socket.h>
72 * These numbers are used by reliable protocols for determining
73 * retransmission behavior and are included in the routing structure.
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_filler[4]; /* will be used for T/TCP later */
90 * rmx_rtt and rmx_rttvar are stored as microseconds;
92 #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
96 #define RTF_UP 0x1 /* route usable */
97 #define RTF_GATEWAY 0x2 /* destination is a gateway */
98 #define RTF_HOST 0x4 /* host entry (net otherwise) */
99 #define RTF_REJECT 0x8 /* host or net unreachable */
100 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
101 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
102 #define RTF_DONE 0x40 /* message confirmed */
103 #define RTF_DELCLONE 0x80 /* delete cloned route */
104 #define RTF_CLONING 0x100 /* generate new routes on use */
105 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
106 #define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */
107 #define RTF_STATIC 0x800 /* manually added */
108 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
109 #define RTF_NOIFREF 0x2000 /* not eligible for RTF_IFREF */
110 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
111 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
113 #define RTF_PRCLONING 0x10000 /* protocol requires cloning */
114 #define RTF_WASCLONED 0x20000 /* route generated through cloning */
115 #define RTF_PROTO3 0x40000 /* protocol specific routing flag */
117 #define RTF_PINNED 0x100000 /* future use */
118 #define RTF_LOCAL 0x200000 /* route represents a local address */
119 #define RTF_BROADCAST 0x400000 /* route represents a bcast address */
120 #define RTF_MULTICAST 0x800000 /* route represents a mcast address */
121 #define RTF_IFSCOPE 0x1000000 /* has valid interface scope */
122 #define RTF_CONDEMNED 0x2000000 /* defunct; no longer modifiable */
123 #define RTF_IFREF 0x4000000 /* route holds a ref to interface */
124 #define RTF_PROXY 0x8000000 /* proxying, no interface scope */
125 #define RTF_ROUTER 0x10000000 /* host is a router */
126 /* 0x20000000 and up unassigned */
129 "\020\1UP\2GATEWAY\3HOST\4REJECT\5DYNAMIC\6MODIFIED\7DONE" \
130 "\10DELCLONE\11CLONING\12XRESOLVE\13LLINFO\14STATIC\15BLACKHOLE" \
131 "\16NOIFREF\17PROTO2\20PROTO1\21PRCLONING\22WASCLONED\23PROTO3" \
132 "\25PINNED\26LOCAL\27BROADCAST\30MULTICAST\31IFSCOPE\32CONDEMNED" \
133 "\33IFREF\34PROXY\35ROUTER"
136 * Routing statistics.
139 short rts_badredirect; /* bogus redirect calls */
140 short rts_dynamic; /* routes created by redirects */
141 short rts_newgateway; /* routes modified by redirects */
142 short rts_unreach; /* lookups which failed */
143 short rts_wildcard; /* lookups satisfied by a wildcard */
147 * Structures for routing messages.
150 u_short rtm_msglen; /* to skip over non-understood messages */
151 u_char rtm_version; /* future binary compatibility */
152 u_char rtm_type; /* message type */
153 u_short rtm_index; /* index for associated ifp */
154 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
155 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
156 pid_t rtm_pid; /* identify sender */
157 int rtm_seq; /* for sender to identify action */
158 int rtm_errno; /* why failed */
159 int rtm_use; /* from rtentry */
160 u_int32_t rtm_inits; /* which metrics we are initializing */
161 struct rt_metrics rtm_rmx; /* metrics themselves */
165 u_short rtm_msglen; /* to skip over non-understood messages */
166 u_char rtm_version; /* future binary compatibility */
167 u_char rtm_type; /* message type */
168 u_short rtm_index; /* index for associated ifp */
169 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
170 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
171 int32_t rtm_refcnt; /* reference count */
172 int rtm_parentflags; /* flags of the parent route */
173 int rtm_reserved; /* reserved field set to 0 */
174 int rtm_use; /* from rtentry */
175 u_int32_t rtm_inits; /* which metrics we are initializing */
176 struct rt_metrics rtm_rmx; /* metrics themselves */
180 #define RTM_VERSION 5 /* Up the ante and ignore older versions */
185 #define RTM_ADD 0x1 /* Add Route */
186 #define RTM_DELETE 0x2 /* Delete Route */
187 #define RTM_CHANGE 0x3 /* Change Metrics or flags */
188 #define RTM_GET 0x4 /* Report Metrics */
189 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
190 #define RTM_REDIRECT 0x6 /* Told to use different route */
191 #define RTM_MISS 0x7 /* Lookup failed on this address */
192 #define RTM_LOCK 0x8 /* fix specified metrics */
193 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
194 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
195 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
196 #define RTM_NEWADDR 0xc /* address being added to iface */
197 #define RTM_DELADDR 0xd /* address being removed from iface */
198 #define RTM_IFINFO 0xe /* iface going up/down etc. */
199 #define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
200 #define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
201 #define RTM_IFINFO2 0x12 /* */
202 #define RTM_NEWMADDR2 0x13 /* */
203 #define RTM_GET2 0x14 /* */
206 * Bitmask values for rtm_inits and rmx_locks.
208 #define RTV_MTU 0x1 /* init or lock _mtu */
209 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
210 #define RTV_EXPIRE 0x4 /* init or lock _expire */
211 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
212 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
213 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
214 #define RTV_RTT 0x40 /* init or lock _rtt */
215 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
218 * Bitmask values for rtm_addrs.
220 #define RTA_DST 0x1 /* destination sockaddr present */
221 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
222 #define RTA_NETMASK 0x4 /* netmask sockaddr present */
223 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
224 #define RTA_IFP 0x10 /* interface name sockaddr present */
225 #define RTA_IFA 0x20 /* interface addr sockaddr present */
226 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
227 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
230 * Index offsets for sockaddr array for alternate internal encoding.
232 #define RTAX_DST 0 /* destination sockaddr present */
233 #define RTAX_GATEWAY 1 /* gateway sockaddr present */
234 #define RTAX_NETMASK 2 /* netmask sockaddr present */
235 #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
236 #define RTAX_IFP 4 /* interface name sockaddr present */
237 #define RTAX_IFA 5 /* interface addr sockaddr present */
238 #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
239 #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
240 #define RTAX_MAX 8 /* size of array to allocate */
244 struct sockaddr *rti_info[RTAX_MAX];
248 #endif /* _NET_ROUTE_H_ */