master
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 */
75struct 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_filler[4]; /* will be used for TCP's peer-MSS cache */
87};
88
89/*
90 * rmx_rtt and rmx_rttvar are stored as microseconds;
91 */
92#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
93
94#define RTF_UP 0x1 /* route usable */
95#define RTF_GATEWAY 0x2 /* destination is a gateway */
96#define RTF_HOST 0x4 /* host entry (net otherwise) */
97#define RTF_REJECT 0x8 /* host or net unreachable */
98#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
99#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
100#define RTF_DONE 0x40 /* message confirmed */
101#define RTF_DELCLONE 0x80 /* delete cloned route */
102#define RTF_CLONING 0x100 /* generate new routes on use */
103#define RTF_XRESOLVE 0x200 /* external daemon resolves name */
104#define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */
105#define RTF_STATIC 0x800 /* manually added */
106#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
107#define RTF_NOIFREF 0x2000 /* not eligible for RTF_IFREF */
108#define RTF_PROTO2 0x4000 /* protocol specific routing flag */
109#define RTF_PROTO1 0x8000 /* protocol specific routing flag */
110
111#define RTF_PRCLONING 0x10000 /* protocol requires cloning */
112#define RTF_WASCLONED 0x20000 /* route generated through cloning */
113#define RTF_PROTO3 0x40000 /* protocol specific routing flag */
114 /* 0x80000 unused */
115#define RTF_PINNED 0x100000 /* future use */
116#define RTF_LOCAL 0x200000 /* route represents a local address */
117#define RTF_BROADCAST 0x400000 /* route represents a bcast address */
118#define RTF_MULTICAST 0x800000 /* route represents a mcast address */
119#define RTF_IFSCOPE 0x1000000 /* has valid interface scope */
120#define RTF_CONDEMNED 0x2000000 /* defunct; no longer modifiable */
121#define RTF_IFREF 0x4000000 /* route holds a ref to interface */
122#define RTF_PROXY 0x8000000 /* proxying, no interface scope */
123#define RTF_ROUTER 0x10000000 /* host is a router */
124#define RTF_DEAD 0x20000000 /* Route entry is being freed */
125#define RTF_GLOBAL 0x40000000 /* route to destination of the global internet */
126 /* 0x80000000 unassigned */
127
128#define RTPRF_OURS RTF_PROTO3 /* set on routes we manage */
129
130#define IS_DIRECT_HOSTROUTE(rt) \
131 (((rt)->rt_flags & (RTF_HOST | RTF_GATEWAY)) == RTF_HOST)
132
133#define IS_DYNAMIC_DIRECT_HOSTROUTE(rt) \
134 (((rt)->rt_flags & (RTF_CLONING | RTF_PRCLONING | RTF_HOST | RTF_LLINFO |\
135 RTF_WASCLONED | RTF_GATEWAY)) ==\
136 (RTF_HOST | RTF_LLINFO | RTF_WASCLONED))
137
138#define IS_LOCALNET_ROUTE(rt) \
139 (!((rt)->rt_flags & RTF_LOCAL) && \
140 ((((rt)->rt_flags & (RTF_HOST | RTF_GATEWAY)) == RTF_HOST) || \
141 ((rt)->rt_flags & (RTF_MULTICAST | RTF_BROADCAST))))
142
143/*
144 * Routing statistics.
145 */
146struct rtstat {
147 short rts_badredirect; /* bogus redirect calls */
148 short rts_dynamic; /* routes created by redirects */
149 short rts_newgateway; /* routes modified by redirects */
150 short rts_unreach; /* lookups which failed */
151 short rts_wildcard; /* lookups satisfied by a wildcard */
152 short rts_badrtgwroute; /* route to gateway is not direct */
153};
154
155/*
156 * Structures for routing messages.
157 */
158struct rt_msghdr {
159 u_short rtm_msglen; /* to skip over non-understood messages */
160 u_char rtm_version; /* future binary compatibility */
161 u_char rtm_type; /* message type */
162 u_short rtm_index; /* index for associated ifp */
163 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
164 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
165 pid_t rtm_pid; /* identify sender */
166 int rtm_seq; /* for sender to identify action */
167 int rtm_errno; /* why failed */
168 int rtm_use; /* from rtentry */
169 u_int32_t rtm_inits; /* which metrics we are initializing */
170 struct rt_metrics rtm_rmx; /* metrics themselves */
171};
172
173struct rt_msghdr2 {
174 u_short rtm_msglen; /* to skip over non-understood messages */
175 u_char rtm_version; /* future binary compatibility */
176 u_char rtm_type; /* message type */
177 u_short rtm_index; /* index for associated ifp */
178 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
179 int rtm_addrs; /* bitmask identifying sockaddrs in msg */
180 int32_t rtm_refcnt; /* reference count */
181 int rtm_parentflags; /* flags of the parent route */
182 int rtm_reserved; /* reserved field set to 0 */
183 int rtm_use; /* from rtentry */
184 u_int32_t rtm_inits; /* which metrics we are initializing */
185 struct rt_metrics rtm_rmx; /* metrics themselves */
186};
187
188struct rt_msghdr_prelude {
189 u_short rtm_msglen; /* to skip over non-understood messages */
190};
191
192#define RTM_VERSION 5 /* Up the ante and ignore older versions */
193
194/*
195 * Message types.
196 */
197#define RTM_ADD 0x1 /* Add Route */
198#define RTM_DELETE 0x2 /* Delete Route */
199#define RTM_CHANGE 0x3 /* Change Metrics or flags */
200#define RTM_GET 0x4 /* Report Metrics */
201#define RTM_LOSING 0x5 /* RTM_LOSING is no longer generated by xnu
202 * and is deprecated */
203#define RTM_REDIRECT 0x6 /* Told to use different route */
204#define RTM_MISS 0x7 /* Lookup failed on this address */
205#define RTM_LOCK 0x8 /* fix specified metrics */
206#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
207#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
208#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
209#define RTM_NEWADDR 0xc /* address being added to iface */
210#define RTM_DELADDR 0xd /* address being removed from iface */
211#define RTM_IFINFO 0xe /* iface going up/down etc. */
212#define RTM_NEWMADDR 0xf /* mcast group membership being added to if */
213#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
214#define RTM_IFINFO2 0x12 /* */
215#define RTM_NEWMADDR2 0x13 /* */
216#define RTM_GET2 0x14 /* */
217
218/*
219 * Bitmask values for rtm_inits and rmx_locks.
220 */
221#define RTV_MTU 0x1 /* init or lock _mtu */
222#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
223#define RTV_EXPIRE 0x4 /* init or lock _expire */
224#define RTV_RPIPE 0x8 /* init or lock _recvpipe */
225#define RTV_SPIPE 0x10 /* init or lock _sendpipe */
226#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
227#define RTV_RTT 0x40 /* init or lock _rtt */
228#define RTV_RTTVAR 0x80 /* init or lock _rttvar */
229
230/*
231 * Bitmask values for rtm_addrs.
232 */
233#define RTA_DST 0x1 /* destination sockaddr present */
234#define RTA_GATEWAY 0x2 /* gateway sockaddr present */
235#define RTA_NETMASK 0x4 /* netmask sockaddr present */
236#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
237#define RTA_IFP 0x10 /* interface name sockaddr present */
238#define RTA_IFA 0x20 /* interface addr sockaddr present */
239#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
240#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
241
242/*
243 * Index offsets for sockaddr array for alternate internal encoding.
244 */
245#define RTAX_DST 0 /* destination sockaddr present */
246#define RTAX_GATEWAY 1 /* gateway sockaddr present */
247#define RTAX_NETMASK 2 /* netmask sockaddr present */
248#define RTAX_GENMASK 3 /* cloning mask sockaddr present */
249#define RTAX_IFP 4 /* interface name sockaddr present */
250#define RTAX_IFA 5 /* interface addr sockaddr present */
251#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
252#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
253#define RTAX_MAX 8 /* size of array to allocate */
254
255struct rt_addrinfo {
256 int rti_addrs;
257 struct sockaddr *rti_info[RTAX_MAX];
258};
259
260
261#endif /* _NET_ROUTE_H_ */