route.h revision 34823
138889Sjdp/* 2218822Sdim * Copyright (c) 1980, 1986, 1993 3218822Sdim * The Regents of the University of California. All rights reserved. 438889Sjdp * 538889Sjdp * Redistribution and use in source and binary forms, with or without 6130561Sobrien * modification, are permitted provided that the following conditions 738889Sjdp * are met: 8130561Sobrien * 1. Redistributions of source code must retain the above copyright 9130561Sobrien * notice, this list of conditions and the following disclaimer. 10130561Sobrien * 2. Redistributions in binary form must reproduce the above copyright 11130561Sobrien * notice, this list of conditions and the following disclaimer in the 1238889Sjdp * documentation and/or other materials provided with the distribution. 13130561Sobrien * 3. All advertising materials mentioning features or use of this software 14130561Sobrien * must display the following acknowledgement: 15130561Sobrien * This product includes software developed by the University of 16130561Sobrien * California, Berkeley and its contributors. 1738889Sjdp * 4. Neither the name of the University nor the names of its contributors 18130561Sobrien * may be used to endorse or promote products derived from this software 19130561Sobrien * without specific prior written permission. 20218822Sdim * 2138889Sjdp * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2238889Sjdp * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2338889Sjdp * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2438889Sjdp * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2538889Sjdp * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2638889Sjdp * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2738889Sjdp * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2838889Sjdp * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2938889Sjdp * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3038889Sjdp * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3138889Sjdp * SUCH DAMAGE. 3238889Sjdp * 3338889Sjdp * @(#)route.h 8.3 (Berkeley) 4/19/94 3438889Sjdp * $Id: route.h,v 1.27 1997/09/07 05:26:27 bde Exp $ 3538889Sjdp */ 3660484Sobrien 3760484Sobrien#ifndef _NET_ROUTE_H_ 3838889Sjdp#define _NET_ROUTE_H_ 39130561Sobrien 40130561Sobrien/* 4138889Sjdp * Kernel resident routing tables. 4260484Sobrien * 43130561Sobrien * The routing tables are initialized when interface addresses 44218822Sdim * are set by making entries for all directly connected interfaces. 45218822Sdim */ 46218822Sdim 47130561Sobrien/* 4838889Sjdp * A route consists of a destination address and a reference 49130561Sobrien * to a routing entry. These are often held by protocols 5060484Sobrien * in their control blocks, e.g. inpcb. 5138889Sjdp */ 5260484Sobrienstruct route { 5360484Sobrien struct rtentry *ro_rt; 5460484Sobrien struct sockaddr ro_dst; 5560484Sobrien}; 5660484Sobrien 5760484Sobrien/* 5860484Sobrien * These numbers are used by reliable protocols for determining 59130561Sobrien * retransmission behavior and are included in the routing structure. 6060484Sobrien */ 6160484Sobrienstruct rt_metrics { 6260484Sobrien u_long rmx_locks; /* Kernel must leave these values alone */ 6360484Sobrien u_long rmx_mtu; /* MTU for this path */ 6460484Sobrien u_long rmx_hopcount; /* max hops expected */ 6560484Sobrien u_long rmx_expire; /* lifetime for route, e.g. redirect */ 6660484Sobrien u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 6760484Sobrien u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 6860484Sobrien u_long rmx_ssthresh; /* outbound gateway buffer limit */ 6960484Sobrien u_long rmx_rtt; /* estimated round trip time */ 7060484Sobrien u_long rmx_rttvar; /* estimated rtt variance */ 7160484Sobrien u_long rmx_pksent; /* packets sent using this route */ 7260484Sobrien u_long rmx_filler[4]; /* will be used for T/TCP later */ 7360484Sobrien}; 7460484Sobrien 7560484Sobrien/* 7660484Sobrien * rmx_rtt and rmx_rttvar are stored as microseconds; 7760484Sobrien * RTTTOPRHZ(rtt) converts to a value suitable for use 78130561Sobrien * by a protocol slowtimo counter. 79130561Sobrien */ 80130561Sobrien#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 81130561Sobrien#define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 82218822Sdim 8377298Sobrien/* 8460484Sobrien * XXX kernel function pointer `rt_output' is visible to applications. 8538889Sjdp */ 8638889Sjdpstruct mbuf; 8738889Sjdp 8838889Sjdp/* 8938889Sjdp * We distinguish between routes to hosts and routes to networks, 9038889Sjdp * preferring the former if available. For each route we infer 9138889Sjdp * the interface to use from the gateway address supplied when 9238889Sjdp * the route was entered. Routes that forward packets through 9338889Sjdp * gateways are marked so that the output routines know to address the 9438889Sjdp * gateway rather than the ultimate destination. 9538889Sjdp */ 9638889Sjdp#ifndef RNF_NORMAL 9738889Sjdp#include <net/radix.h> 9838889Sjdp#endif 9938889Sjdpstruct rtentry { 10038889Sjdp struct radix_node rt_nodes[2]; /* tree glue, and other values */ 10138889Sjdp#define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key)) 10238889Sjdp#define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask)) 10338889Sjdp struct sockaddr *rt_gateway; /* value */ 10438889Sjdp short rt_filler; /* was short flags field */ 10538889Sjdp short rt_refcnt; /* # held references */ 10638889Sjdp u_long rt_flags; /* up/down?, host/net */ 10738889Sjdp struct ifnet *rt_ifp; /* the answer: interface to use */ 10838889Sjdp struct ifaddr *rt_ifa; /* the answer: interface to use */ 10938889Sjdp struct sockaddr *rt_genmask; /* for generation of cloned routes */ 11038889Sjdp caddr_t rt_llinfo; /* pointer to link level info cache */ 111130561Sobrien struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ 11238889Sjdp struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 113130561Sobrien int (*rt_output) __P((struct ifnet *, struct mbuf *, 114130561Sobrien struct sockaddr *, struct rtentry *)); 115130561Sobrien /* output routine for this (rt,if) */ 116130561Sobrien struct rtentry *rt_parent; /* cloning parent of this route */ 117130561Sobrien void *rt_filler2; /* more filler */ 118130561Sobrien}; 119130561Sobrien 120130561Sobrien/* 121130561Sobrien * Following structure necessary for 4.3 compatibility; 12238889Sjdp * We should eventually move it to a compat file. 123 */ 124struct ortentry { 125 u_long rt_hash; /* to speed lookups */ 126 struct sockaddr rt_dst; /* key */ 127 struct sockaddr rt_gateway; /* value */ 128 short rt_flags; /* up/down?, host/net */ 129 short rt_refcnt; /* # held references */ 130 u_long rt_use; /* raw # packets forwarded */ 131 struct ifnet *rt_ifp; /* the answer: interface to use */ 132}; 133 134#define rt_use rt_rmx.rmx_pksent 135 136#define RTF_UP 0x1 /* route usable */ 137#define RTF_GATEWAY 0x2 /* destination is a gateway */ 138#define RTF_HOST 0x4 /* host entry (net otherwise) */ 139#define RTF_REJECT 0x8 /* host or net unreachable */ 140#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 141#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 142#define RTF_DONE 0x40 /* message confirmed */ 143/* 0x80 unused */ 144#define RTF_CLONING 0x100 /* generate new routes on use */ 145#define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 146#define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */ 147#define RTF_STATIC 0x800 /* manually added */ 148#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 149#define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 150#define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 151 152#define RTF_PRCLONING 0x10000 /* protocol requires cloning */ 153#define RTF_WASCLONED 0x20000 /* route generated through cloning */ 154#define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 155/* 0x80000 unused */ 156#define RTF_PINNED 0x100000 /* future use */ 157#define RTF_LOCAL 0x200000 /* route represents a local address */ 158#define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 159#define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 160 /* 0x1000000 and up unassigned */ 161 162/* 163 * Routing statistics. 164 */ 165struct rtstat { 166 short rts_badredirect; /* bogus redirect calls */ 167 short rts_dynamic; /* routes created by redirects */ 168 short rts_newgateway; /* routes modified by redirects */ 169 short rts_unreach; /* lookups which failed */ 170 short rts_wildcard; /* lookups satisfied by a wildcard */ 171}; 172/* 173 * Structures for routing messages. 174 */ 175struct rt_msghdr { 176 u_short rtm_msglen; /* to skip over non-understood messages */ 177 u_char rtm_version; /* future binary compatibility */ 178 u_char rtm_type; /* message type */ 179 u_short rtm_index; /* index for associated ifp */ 180 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 181 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 182 pid_t rtm_pid; /* identify sender */ 183 int rtm_seq; /* for sender to identify action */ 184 int rtm_errno; /* why failed */ 185 int rtm_use; /* from rtentry */ 186 u_long rtm_inits; /* which metrics we are initializing */ 187 struct rt_metrics rtm_rmx; /* metrics themselves */ 188}; 189 190#define RTM_VERSION 5 /* Up the ante and ignore older versions */ 191 192#define RTM_ADD 0x1 /* Add Route */ 193#define RTM_DELETE 0x2 /* Delete Route */ 194#define RTM_CHANGE 0x3 /* Change Metrics or flags */ 195#define RTM_GET 0x4 /* Report Metrics */ 196#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 197#define RTM_REDIRECT 0x6 /* Told to use different route */ 198#define RTM_MISS 0x7 /* Lookup failed on this address */ 199#define RTM_LOCK 0x8 /* fix specified metrics */ 200#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 201#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 202#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 203#define RTM_NEWADDR 0xc /* address being added to iface */ 204#define RTM_DELADDR 0xd /* address being removed from iface */ 205#define RTM_IFINFO 0xe /* iface going up/down etc. */ 206#define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ 207#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ 208 209#define RTV_MTU 0x1 /* init or lock _mtu */ 210#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 211#define RTV_EXPIRE 0x4 /* init or lock _hopcount */ 212#define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 213#define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 214#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 215#define RTV_RTT 0x40 /* init or lock _rtt */ 216#define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 217 218/* 219 * Bitmask values for rtm_addr. 220 */ 221#define RTA_DST 0x1 /* destination sockaddr present */ 222#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 223#define RTA_NETMASK 0x4 /* netmask sockaddr present */ 224#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 225#define RTA_IFP 0x10 /* interface name sockaddr present */ 226#define RTA_IFA 0x20 /* interface addr sockaddr present */ 227#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 228#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 229 230/* 231 * Index offsets for sockaddr array for alternate internal encoding. 232 */ 233#define RTAX_DST 0 /* destination sockaddr present */ 234#define RTAX_GATEWAY 1 /* gateway sockaddr present */ 235#define RTAX_NETMASK 2 /* netmask sockaddr present */ 236#define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 237#define RTAX_IFP 4 /* interface name sockaddr present */ 238#define RTAX_IFA 5 /* interface addr sockaddr present */ 239#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 240#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 241#define RTAX_MAX 8 /* size of array to allocate */ 242 243struct rt_addrinfo { 244 int rti_addrs; 245 struct sockaddr *rti_info[RTAX_MAX]; 246}; 247 248struct route_cb { 249 int ip_count; 250 int ipx_count; 251 int ns_count; 252 int iso_count; 253 int any_count; 254}; 255 256#ifdef KERNEL 257#define RTFREE(rt) \ 258 if ((rt)->rt_refcnt <= 1) \ 259 rtfree(rt); \ 260 else \ 261 (rt)->rt_refcnt--; 262 263extern struct route_cb route_cb; 264extern struct radix_node_head *rt_tables[AF_MAX+1]; 265 266struct ifmultiaddr; 267struct proc; 268 269void route_init __P((void)); 270void rt_ifmsg __P((struct ifnet *)); 271void rt_missmsg __P((int, struct rt_addrinfo *, int, int)); 272void rt_newaddrmsg __P((int, struct ifaddr *, int, struct rtentry *)); 273void rt_newmaddrmsg __P((int, struct ifmultiaddr *)); 274int rt_setgate __P((struct rtentry *, 275 struct sockaddr *, struct sockaddr *)); 276void rtalloc __P((struct route *)); 277void rtalloc_ign __P((struct route *, unsigned long)); 278struct rtentry * 279 rtalloc1 __P((struct sockaddr *, int, unsigned long)); 280void rtfree __P((struct rtentry *)); 281int rtinit __P((struct ifaddr *, int, int)); 282int rtioctl __P((int, caddr_t, struct proc *)); 283void rtredirect __P((struct sockaddr *, struct sockaddr *, 284 struct sockaddr *, int, struct sockaddr *, struct rtentry **)); 285int rtrequest __P((int, struct sockaddr *, 286 struct sockaddr *, struct sockaddr *, int, struct rtentry **)); 287#endif 288 289#endif 290