route.h revision 2168
1/* 2 * Copyright (c) 1980, 1986, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)route.h 8.3 (Berkeley) 4/19/94 34 * $Id: route.h,v 1.3 1994/08/02 07:46:42 davidg Exp $ 35 */ 36 37#ifndef _NET_ROUTE_H_ 38#define _NET_ROUTE_H_ 39 40/* 41 * Kernel resident routing tables. 42 * 43 * The routing tables are initialized when interface addresses 44 * are set by making entries for all directly connected interfaces. 45 */ 46 47/* 48 * A route consists of a destination address and a reference 49 * to a routing entry. These are often held by protocols 50 * in their control blocks, e.g. inpcb. 51 */ 52struct route { 53 struct rtentry *ro_rt; 54 struct sockaddr ro_dst; 55}; 56 57/* 58 * These numbers are used by reliable protocols for determining 59 * retransmission behavior and are included in the routing structure. 60 */ 61struct rt_metrics { 62 u_long rmx_locks; /* Kernel must leave these values alone */ 63 u_long rmx_mtu; /* MTU for this path */ 64 u_long rmx_hopcount; /* max hops expected */ 65 u_long rmx_expire; /* lifetime for route, e.g. redirect */ 66 u_long rmx_recvpipe; /* inbound delay-bandwith product */ 67 u_long rmx_sendpipe; /* outbound delay-bandwith product */ 68 u_long rmx_ssthresh; /* outbound gateway buffer limit */ 69 u_long rmx_rtt; /* estimated round trip time */ 70 u_long rmx_rttvar; /* estimated rtt variance */ 71 u_long rmx_pksent; /* packets sent using this route */ 72}; 73 74/* 75 * rmx_rtt and rmx_rttvar are stored as microseconds; 76 * RTTTOPRHZ(rtt) converts to a value suitable for use 77 * by a protocol slowtimo counter. 78 */ 79#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 80#define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 81 82/* 83 * We distinguish between routes to hosts and routes to networks, 84 * preferring the former if available. For each route we infer 85 * the interface to use from the gateway address supplied when 86 * the route was entered. Routes that forward packets through 87 * gateways are marked so that the output routines know to address the 88 * gateway rather than the ultimate destination. 89 */ 90#ifndef RNF_NORMAL 91#include <net/radix.h> 92#endif 93struct rtentry { 94 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 95#define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key)) 96#define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask)) 97 struct sockaddr *rt_gateway; /* value */ 98 short rt_flags; /* up/down?, host/net */ 99 short rt_refcnt; /* # held references */ 100 u_long rt_use; /* raw # packets forwarded */ 101 struct ifnet *rt_ifp; /* the answer: interface to use */ 102 struct ifaddr *rt_ifa; /* the answer: interface to use */ 103 struct sockaddr *rt_genmask; /* for generation of cloned routes */ 104 caddr_t rt_llinfo; /* pointer to link level info cache */ 105 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ 106 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 107}; 108 109/* 110 * Following structure necessary for 4.3 compatibility; 111 * We should eventually move it to a compat file. 112 */ 113struct ortentry { 114 u_long rt_hash; /* to speed lookups */ 115 struct sockaddr rt_dst; /* key */ 116 struct sockaddr rt_gateway; /* value */ 117 short rt_flags; /* up/down?, host/net */ 118 short rt_refcnt; /* # held references */ 119 u_long rt_use; /* raw # packets forwarded */ 120 struct ifnet *rt_ifp; /* the answer: interface to use */ 121}; 122 123#define RTF_UP 0x1 /* route usable */ 124#define RTF_GATEWAY 0x2 /* destination is a gateway */ 125#define RTF_HOST 0x4 /* host entry (net otherwise) */ 126#define RTF_REJECT 0x8 /* host or net unreachable */ 127#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 128#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 129#define RTF_DONE 0x40 /* message confirmed */ 130#define RTF_MASK 0x80 /* subnet mask present */ 131#define RTF_CLONING 0x100 /* generate new routes on use */ 132#define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 133#define RTF_LLINFO 0x400 /* generated by ARP or ESIS */ 134#define RTF_STATIC 0x800 /* manually added */ 135#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 136#define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 137#define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 138 139 140/* 141 * Routing statistics. 142 */ 143struct rtstat { 144 short rts_badredirect; /* bogus redirect calls */ 145 short rts_dynamic; /* routes created by redirects */ 146 short rts_newgateway; /* routes modified by redirects */ 147 short rts_unreach; /* lookups which failed */ 148 short rts_wildcard; /* lookups satisfied by a wildcard */ 149}; 150/* 151 * Structures for routing messages. 152 */ 153struct rt_msghdr { 154 u_short rtm_msglen; /* to skip over non-understood messages */ 155 u_char rtm_version; /* future binary compatibility */ 156 u_char rtm_type; /* message type */ 157 u_short rtm_index; /* index for associated ifp */ 158 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 159 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 160 pid_t rtm_pid; /* identify sender */ 161 int rtm_seq; /* for sender to identify action */ 162 int rtm_errno; /* why failed */ 163 int rtm_use; /* from rtentry */ 164 u_long rtm_inits; /* which metrics we are initializing */ 165 struct rt_metrics rtm_rmx; /* metrics themselves */ 166}; 167 168#define RTM_VERSION 3 /* Up the ante and ignore older versions */ 169 170#define RTM_ADD 0x1 /* Add Route */ 171#define RTM_DELETE 0x2 /* Delete Route */ 172#define RTM_CHANGE 0x3 /* Change Metrics or flags */ 173#define RTM_GET 0x4 /* Report Metrics */ 174#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 175#define RTM_REDIRECT 0x6 /* Told to use different route */ 176#define RTM_MISS 0x7 /* Lookup failed on this address */ 177#define RTM_LOCK 0x8 /* fix specified metrics */ 178#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 179#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 180#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 181#define RTM_NEWADDR 0xc /* address being added to iface */ 182#define RTM_DELADDR 0xd /* address being removed from iface */ 183#define RTM_IFINFO 0xe /* iface going up/down etc. */ 184 185#define RTV_MTU 0x1 /* init or lock _mtu */ 186#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 187#define RTV_EXPIRE 0x4 /* init or lock _hopcount */ 188#define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 189#define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 190#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 191#define RTV_RTT 0x40 /* init or lock _rtt */ 192#define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 193 194/* 195 * Bitmask values for rtm_addr. 196 */ 197#define RTA_DST 0x1 /* destination sockaddr present */ 198#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 199#define RTA_NETMASK 0x4 /* netmask sockaddr present */ 200#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 201#define RTA_IFP 0x10 /* interface name sockaddr present */ 202#define RTA_IFA 0x20 /* interface addr sockaddr present */ 203#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 204#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 205 206/* 207 * Index offsets for sockaddr array for alternate internal encoding. 208 */ 209#define RTAX_DST 0 /* destination sockaddr present */ 210#define RTAX_GATEWAY 1 /* gateway sockaddr present */ 211#define RTAX_NETMASK 2 /* netmask sockaddr present */ 212#define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 213#define RTAX_IFP 4 /* interface name sockaddr present */ 214#define RTAX_IFA 5 /* interface addr sockaddr present */ 215#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 216#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 217#define RTAX_MAX 8 /* size of array to allocate */ 218 219struct rt_addrinfo { 220 int rti_addrs; 221 struct sockaddr *rti_info[RTAX_MAX]; 222}; 223 224struct route_cb { 225 int ip_count; 226 int ns_count; 227 int iso_count; 228 int any_count; 229}; 230 231#ifdef KERNEL 232#define RTFREE(rt) \ 233 if ((rt)->rt_refcnt <= 1) \ 234 rtfree(rt); \ 235 else \ 236 (rt)->rt_refcnt--; 237 238struct route_cb route_cb; 239struct rtstat rtstat; 240struct radix_node_head *rt_tables[AF_MAX+1]; 241 242void route_init __P((void)); 243int route_output __P((struct mbuf *, struct socket *)); 244int route_usrreq __P((struct socket *, 245 int, struct mbuf *, struct mbuf *, struct mbuf *)); 246void rt_ifmsg __P((struct ifnet *)); 247void rt_maskedcopy __P((struct sockaddr *, 248 struct sockaddr *, struct sockaddr *)); 249void rt_missmsg __P((int, struct rt_addrinfo *, int, int)); 250void rt_newaddrmsg __P((int, struct ifaddr *, int, struct rtentry *)); 251int rt_setgate __P((struct rtentry *, 252 struct sockaddr *, struct sockaddr *)); 253void rt_setmetrics __P((u_long, struct rt_metrics *, struct rt_metrics *)); 254void rtable_init __P((void **)); 255void rtalloc __P((struct route *)); 256struct rtentry * 257 rtalloc1 __P((struct sockaddr *, int)); 258void rtfree __P((struct rtentry *)); 259int rtinit __P((struct ifaddr *, int, int)); 260int rtioctl __P((int, caddr_t, struct proc *)); 261void rtredirect __P((struct sockaddr *, struct sockaddr *, 262 struct sockaddr *, int, struct sockaddr *, struct rtentry **)); 263int rtrequest __P((int, struct sockaddr *, 264 struct sockaddr *, struct sockaddr *, int, struct rtentry **)); 265#endif 266 267#endif 268