1 /* 2 * Copyright 1992-2002 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 #pragma ident "%Z%%M% %I% %E% SMI" 49 /* from UCB 8.5 (Berkeley) 2/8/95 */ 50 51 #ifdef __cplusplus 52 extern "C" { 53 #endif 54 55 /* 56 * A route consists of a destination address and a reference 57 * to a routing entry. These are often held by protocols 58 * in their control blocks, e.g. inpcb. 59 */ 60 struct route { 61 struct rtentry *ro_rt; 62 struct sockaddr ro_dst; 63 }; 64 65 /* 66 * These numbers are used by reliable protocols for determining 67 * retransmission behavior and are included in the routing structure. 68 * 69 * rmx_rtt and rmx_rttvar are stored as microseconds; 70 */ 71 typedef struct rt_metrics { 72 uint32_t rmx_locks; /* Kernel must leave these values */ 73 /* alone */ 74 uint32_t rmx_mtu; /* MTU for this path */ 75 uint32_t rmx_hopcount; /* max hops expected */ 76 uint32_t rmx_expire; /* lifetime for route, e.g. redirect */ 77 uint32_t rmx_recvpipe; /* inbound delay-bandwith product */ 78 uint32_t rmx_sendpipe; /* outbound delay-bandwith product */ 79 uint32_t rmx_ssthresh; /* outbound gateway buffer limit */ 80 uint32_t rmx_rtt; /* estimated round trip time */ 81 uint32_t rmx_rttvar; /* estimated rtt variance */ 82 uint32_t rmx_pksent; /* packets sent using this route */ 83 } rt_metrics_t; 84 85 /* 86 * OLD rtentry structure not used in the kernel. Instead the kernel 87 * uses struct ire defined in <inet/ip.h>. 88 * 89 * We distinguish between routes to hosts and routes to networks, 90 * preferring the former if available. For each route we infer 91 * the interface to use from the gateway address supplied when 92 * the route was entered. Routes that forward packets through 93 * gateways are marked so that the output routines know to address the 94 * gateway rather than the ultimate destination. 95 */ 96 struct rtentry { 97 uint_t rt_hash; /* to speed lookups */ 98 struct sockaddr rt_dst; /* key */ 99 struct sockaddr rt_gateway; /* value */ 100 short rt_flags; /* up/down?, host/net */ 101 short rt_refcnt; /* # held references */ 102 uint_t rt_use; /* raw # packets forwarded */ 103 104 /* 105 * The kernel does not use this field, and without it the structure is 106 * datamodel independent. 107 */ 108 #if !defined(_KERNEL) 109 struct ifnet *rt_ifp; /* the answer: interface to use */ 110 #endif /* !defined(_KERNEL) */ 111 }; 112 113 #define RTF_UP 0x1 /* route usable */ 114 #define RTF_GATEWAY 0x2 /* destination is a gateway */ 115 #define RTF_HOST 0x4 /* host entry (net otherwise) */ 116 #define RTF_REJECT 0x8 /* host or net unreachable */ 117 #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 118 #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 119 #define RTF_DONE 0x40 /* message confirmed */ 120 #define RTF_MASK 0x80 /* subnet mask present */ 121 #define RTF_CLONING 0x100 /* generate new routes on use */ 122 #define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 123 #define RTF_LLINFO 0x400 /* generated by ARP or ESIS */ 124 #define RTF_STATIC 0x800 /* manually added */ 125 #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 126 #define RTF_PRIVATE 0x2000 /* do not advertise this route */ 127 #define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 128 #define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 129 #define RTF_MULTIRT 0x10000 /* multiroute */ 130 #define RTF_SETSRC 0x20000 /* set default outgoing src address */ 131 132 133 /* 134 * OLD statistics not used by the kernel. The kernel uses <inet/mib2.h>. 135 * 136 * Routing statistics. 137 */ 138 struct rtstat { 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 */ 144 }; 145 146 /* 147 * Structures for routing messages. 148 */ 149 typedef struct rt_msghdr { 150 ushort_t rtm_msglen; /* to skip over non-understood messages */ 151 uchar_t rtm_version; /* future binary compatibility */ 152 uchar_t rtm_type; /* message type */ 153 ushort_t 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 uint_t rtm_inits; /* which metrics we are initializing */ 161 struct rt_metrics rtm_rmx; /* metrics themselves */ 162 } rt_msghdr_t; 163 164 #define RTM_VERSION 3 /* Up the ante and ignore older versions */ 165 166 #define RTM_ADD 0x1 /* Add Route */ 167 #define RTM_DELETE 0x2 /* Delete Route */ 168 #define RTM_CHANGE 0x3 /* Change Metrics or flags */ 169 #define RTM_GET 0x4 /* Report Metrics */ 170 #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 171 #define RTM_REDIRECT 0x6 /* Told to use different route */ 172 #define RTM_MISS 0x7 /* Lookup failed on this address */ 173 #define RTM_LOCK 0x8 /* fix specified metrics */ 174 #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 175 #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 176 #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 177 #define RTM_NEWADDR 0xc /* address being added to iface */ 178 #define RTM_DELADDR 0xd /* address being removed from iface */ 179 #define RTM_IFINFO 0xe /* iface going up/down etc. */ 180 181 #define RTV_MTU 0x1 /* init or lock _mtu */ 182 #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 183 #define RTV_EXPIRE 0x4 /* init or lock _expire */ 184 #define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 185 #define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 186 #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 187 #define RTV_RTT 0x40 /* init or lock _rtt */ 188 #define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 189 190 /* 191 * Bitmask values for rtm_addr. 192 */ 193 #define RTA_DST 0x1 /* destination sockaddr present */ 194 #define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 195 #define RTA_NETMASK 0x4 /* netmask sockaddr present */ 196 #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 197 #define RTA_IFP 0x10 /* interface name sockaddr present */ 198 #define RTA_IFA 0x20 /* interface addr sockaddr present */ 199 #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 200 #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 201 #define RTA_SRC 0x100 /* source sockaddr present */ 202 #define RTA_SRCIFP 0x200 /* source interface index sockaddr present */ 203 204 #define RTA_NUMBITS 10 /* Number of bits used in RTA_* */ 205 206 /* 207 * Index offsets for sockaddr_storage array for alternate internal encoding. 208 * There should be an RTAX_* associated with each RTA_*. 209 */ 210 #define RTAX_DST 0 211 #define RTAX_GATEWAY 1 212 #define RTAX_NETMASK 2 213 #define RTAX_GENMASK 3 214 #define RTAX_IFP 4 215 #define RTAX_IFA 5 216 #define RTAX_AUTHOR 6 217 #define RTAX_BRD 7 218 #define RTAX_SRC 8 219 #define RTAX_SRCIFP 9 220 #define RTAX_MAX RTA_NUMBITS /* size of array to allocate */ 221 222 #ifdef __cplusplus 223 } 224 #endif 225 226 #endif /* _NET_ROUTE_H */ 227