1 /* 2 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 3 * Use is subject to license terms. 4 */ 5 /* 6 * Copyright (c) 1980, 1986, 1993 7 * The Regents of the University of California. All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed by the University of 20 * California, Berkeley and its contributors. 21 * 4. Neither the name of the University nor the names of its contributors 22 * may be used to endorse or promote products derived from this software 23 * without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35 * SUCH DAMAGE. 36 */ 37 38 /* 39 * Kernel resident routing tables. 40 * 41 * The routing tables are initialized when interface addresses 42 * are set by making entries for all directly connected interfaces. 43 */ 44 45 #ifndef _NET_ROUTE_H 46 #define _NET_ROUTE_H 47 48 /* from UCB 8.5 (Berkeley) 2/8/95 */ 49 50 #include <sys/tsol/label.h> 51 #include <sys/tsol/label_macro.h> 52 53 #ifdef __cplusplus 54 extern "C" { 55 #endif 56 57 /* 58 * A route consists of a destination address and a reference 59 * to a routing entry. These are often held by protocols 60 * in their control blocks, e.g. inpcb. 61 */ 62 struct route { 63 struct rtentry *ro_rt; 64 struct sockaddr ro_dst; 65 }; 66 67 /* 68 * These numbers are used by reliable protocols for determining 69 * retransmission behavior and are included in the routing structure. 70 * 71 * rmx_rtt and rmx_rttvar are stored as microseconds; 72 */ 73 typedef struct rt_metrics { 74 uint32_t rmx_locks; /* Kernel must leave these values */ 75 /* alone */ 76 uint32_t rmx_mtu; /* MTU for this path */ 77 uint32_t rmx_hopcount; /* max hops expected */ 78 uint32_t rmx_expire; /* lifetime for route, e.g. redirect */ 79 uint32_t rmx_recvpipe; /* inbound delay-bandwith product */ 80 uint32_t rmx_sendpipe; /* outbound delay-bandwith product */ 81 uint32_t rmx_ssthresh; /* outbound gateway buffer limit */ 82 uint32_t rmx_rtt; /* estimated round trip time */ 83 uint32_t rmx_rttvar; /* estimated rtt variance */ 84 uint32_t rmx_pksent; /* packets sent using this route */ 85 } rt_metrics_t; 86 87 /* 88 * OLD rtentry structure not used in the kernel. Instead the kernel 89 * uses struct ire defined in <inet/ip.h>. 90 * 91 * We distinguish between routes to hosts and routes to networks, 92 * preferring the former if available. For each route we infer 93 * the interface to use from the gateway address supplied when 94 * the route was entered. Routes that forward packets through 95 * gateways are marked so that the output routines know to address the 96 * gateway rather than the ultimate destination. 97 */ 98 struct rtentry { 99 uint_t rt_hash; /* to speed lookups */ 100 struct sockaddr rt_dst; /* key */ 101 struct sockaddr rt_gateway; /* value */ 102 short rt_flags; /* up/down?, host/net */ 103 short rt_refcnt; /* # held references */ 104 uint_t rt_use; /* raw # packets forwarded */ 105 106 /* 107 * The kernel does not use this field, and without it the structure is 108 * datamodel independent. 109 */ 110 #if !defined(_KERNEL) 111 struct ifnet *rt_ifp; /* the answer: interface to use */ 112 #endif /* !defined(_KERNEL) */ 113 }; 114 115 #define RTF_UP 0x1 /* route usable */ 116 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 117 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 118 #define RTF_REJECT 0x8 /* host or net unreachable */ 119 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 120 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 121 #define RTF_DONE 0x40 /* message confirmed */ 122 #define RTF_MASK 0x80 /* subnet mask present */ 123 #define RTF_CLONING 0x100 /* generate new routes on use */ 124 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 125 #define RTF_LLINFO 0x400 /* generated by ARP or ESIS */ 126 #define RTF_STATIC 0x800 /* manually added */ 127 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 128 #define RTF_PRIVATE 0x2000 /* do not advertise this route */ 129 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 130 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 131 #define RTF_MULTIRT 0x10000 /* multiroute */ 132 #define RTF_SETSRC 0x20000 /* set default outgoing src address */ 133 #define RTF_INDIRECT 0x40000 /* gateway not directly reachable */ 134 #define RTF_KERNEL 0x80000 /* created by kernel; can't delete */ 135 136 /* 137 * OLD statistics not used by the kernel. The kernel uses <inet/mib2.h>. 138 * 139 * Routing statistics. 140 */ 141 struct rtstat { 142 short rts_badredirect; /* bogus redirect calls */ 143 short rts_dynamic; /* routes created by redirects */ 144 short rts_newgateway; /* routes modified by redirects */ 145 short rts_unreach; /* lookups which failed */ 146 short rts_wildcard; /* lookups satisfied by a wildcard */ 147 }; 148 149 /* 150 * Structures for routing messages. 151 */ 152 typedef struct rt_msghdr { 153 ushort_t rtm_msglen; /* to skip over non-understood messages */ 154 uchar_t rtm_version; /* future binary compatibility */ 155 uchar_t rtm_type; /* message type */ 156 ushort_t rtm_index; /* index for associated ifp */ 157 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 158 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 159 pid_t rtm_pid; /* identify sender */ 160 int rtm_seq; /* for sender to identify action */ 161 int rtm_errno; /* why failed */ 162 int rtm_use; /* from rtentry */ 163 uint_t rtm_inits; /* which metrics we are initializing */ 164 struct rt_metrics rtm_rmx; /* metrics themselves */ 165 } rt_msghdr_t; 166 167 #define RTM_VERSION 3 /* Up the ante and ignore older versions */ 168 169 #define RTM_ADD 0x1 /* Add Route */ 170 #define RTM_DELETE 0x2 /* Delete Route */ 171 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ 172 #define RTM_GET 0x4 /* Report Metrics */ 173 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 174 #define RTM_REDIRECT 0x6 /* Told to use different route */ 175 #define RTM_MISS 0x7 /* Lookup failed on this address */ 176 #define RTM_LOCK 0x8 /* fix specified metrics */ 177 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 178 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 179 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 180 #define RTM_NEWADDR 0xc /* address being added to iface */ 181 #define RTM_DELADDR 0xd /* address being removed from iface */ 182 #define RTM_IFINFO 0xe /* iface going up/down etc. */ 183 184 #define RTV_MTU 0x1 /* init or lock _mtu */ 185 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 186 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 187 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 188 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 189 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 190 #define RTV_RTT 0x40 /* init or lock _rtt */ 191 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 192 193 /* 194 * Bitmask values for rtm_addr. 195 */ 196 #define RTA_DST 0x1 /* destination sockaddr present */ 197 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 198 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 199 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 200 #define RTA_IFP 0x10 /* interface name sockaddr present */ 201 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 202 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 203 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 204 #define RTA_SRC 0x100 /* source sockaddr present */ 205 206 #define RTA_NUMBITS 9 /* Number of bits used in RTA_* */ 207 208 /* 209 * Index offsets for sockaddr_storage array for alternate internal encoding. 210 * There should be an RTAX_* associated with each RTA_*. 211 */ 212 #define RTAX_DST 0 213 #define RTAX_GATEWAY 1 214 #define RTAX_NETMASK 2 215 #define RTAX_GENMASK 3 216 #define RTAX_IFP 4 217 #define RTAX_IFA 5 218 #define RTAX_AUTHOR 6 219 #define RTAX_BRD 7 220 #define RTAX_SRC 8 221 #define RTAX_MAX RTA_NUMBITS /* size of array to allocate */ 222 223 /* 224 * Routing socket message extension after sockaddrs. 225 */ 226 typedef struct rtm_ext_s { 227 uint32_t rtmex_type; /* identifier for type of extension */ 228 uint32_t rtmex_len; /* length of this extension */ 229 } rtm_ext_t; 230 231 #define RTMEX_GATEWAY_SECATTR 1 /* extension is tsol_rtsecattr */ 232 #define RTMEX_MAX RTMEX_GATEWAY_SECATTR 233 234 /* 235 * Trusted Solaris route security attributes extension. 236 */ 237 typedef struct rtsa_s { 238 uint32_t rtsa_mask; /* see RTSA_* below */ 239 uint32_t rtsa_doi; /* domain of interpretation */ 240 brange_t rtsa_slrange; /* sensitivity label range */ 241 } rtsa_t; 242 243 typedef struct tsol_rtsecattr_s { 244 uint32_t rtsa_cnt; /* number of attributes */ 245 rtsa_t rtsa_attr[1]; 246 } tsol_rtsecattr_t; 247 248 #define TSOL_RTSECATTR_SIZE(n) \ 249 (sizeof (tsol_rtsecattr_t) + (((n) - 1) * sizeof (struct rtsa_s))) 250 251 #define RTSA_MINSL 0x1 /* minimum sensitivity label is valid */ 252 #define RTSA_MAXSL 0x2 /* maximum sensitivity label is valid */ 253 #define RTSA_DOI 0x4 /* domain of interpretation is valid */ 254 #define RTSA_CIPSO 0x100 /* CIPSO protocol */ 255 #define RTSA_SLRANGE (RTSA_MINSL|RTSA_MAXSL) 256 257 /* 258 * Routing socket options. 259 */ 260 #define RT_AWARE 0x0001 /* set awareness of hidden interfaces */ 261 262 /* 263 * Supported RT_AWARE values. As a convenience, the bit-values here mirror 264 * the LIFC_* values. 265 */ 266 #define RTAW_DEFAULT 0x0000 /* unaware application */ 267 #define RTAW_UNDER_IPMP 0x0010 /* aware of underlying IPMP interfaces */ 268 269 #ifdef __cplusplus 270 } 271 #endif 272 273 #endif /* _NET_ROUTE_H */ 274