route.h revision 5099
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.5 1994/11/03 01:04:32 wollman 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 u_long rmx_ttcp_cc; /* cached last T/TCP CC option rcvd */ 73 u_long rmx_ttcp_ccsent; /* cached last T/TCP CC option sent */ 74}; 75 76/* 77 * rmx_rtt and rmx_rttvar are stored as microseconds; 78 * RTTTOPRHZ(rtt) converts to a value suitable for use 79 * by a protocol slowtimo counter. 80 */ 81#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 82#define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 83 84/* 85 * We distinguish between routes to hosts and routes to networks, 86 * preferring the former if available. For each route we infer 87 * the interface to use from the gateway address supplied when 88 * the route was entered. Routes that forward packets through 89 * gateways are marked so that the output routines know to address the 90 * gateway rather than the ultimate destination. 91 */ 92#ifndef RNF_NORMAL 93#include <net/radix.h> 94#endif 95struct rtentry { 96 struct radix_node rt_nodes[2]; /* tree glue, and other values */ 97#define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key)) 98#define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask)) 99 struct sockaddr *rt_gateway; /* value */ 100 /* XXX - rt_flags should be unified with rt_prflags */ 101 short rt_filler; /* up/down?, host/net */ 102 short rt_refcnt; /* # held references */ 103 u_long rt_flags; /* protocol-specific flags */ 104 struct ifnet *rt_ifp; /* the answer: interface to use */ 105 struct ifaddr *rt_ifa; /* the answer: interface to use */ 106 struct sockaddr *rt_genmask; /* for generation of cloned routes */ 107 caddr_t rt_llinfo; /* pointer to link level info cache */ 108 struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ 109 struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 110 int (*rt_output) __P(()); /* output routine for this (rt,if) */ 111}; 112 113/* 114 * Following structure necessary for 4.3 compatibility; 115 * We should eventually move it to a compat file. 116 */ 117struct ortentry { 118 u_long rt_hash; /* to speed lookups */ 119 struct sockaddr rt_dst; /* key */ 120 struct sockaddr rt_gateway; /* value */ 121 short rt_flags; /* up/down?, host/net */ 122 short rt_refcnt; /* # held references */ 123 u_long rt_use; /* raw # packets forwarded */ 124 struct ifnet *rt_ifp; /* the answer: interface to use */ 125}; 126 127#define rt_use rt_rmx.rmx_pksent 128 129#define RTF_UP 0x1 /* route usable */ 130#define RTF_GATEWAY 0x2 /* destination is a gateway */ 131#define RTF_HOST 0x4 /* host entry (net otherwise) */ 132#define RTF_REJECT 0x8 /* host or net unreachable */ 133#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 134#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 135#define RTF_DONE 0x40 /* message confirmed */ 136#define RTF_MASK 0x80 /* subnet mask present */ 137#define RTF_CLONING 0x100 /* generate new routes on use */ 138#define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 139#define RTF_LLINFO 0x400 /* generated by ARP or ESIS */ 140#define RTF_STATIC 0x800 /* manually added */ 141#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 142#define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 143#define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 144 145#define RTF_PRCLONING 0x10000 /* protocol requires cloning */ 146#define RTF_WASCLONED 0x20000 /* route generated through cloning */ 147#define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 148 /* 0x80000 and up unassigned */ 149 150/* 151 * Routing statistics. 152 */ 153struct rtstat { 154 short rts_badredirect; /* bogus redirect calls */ 155 short rts_dynamic; /* routes created by redirects */ 156 short rts_newgateway; /* routes modified by redirects */ 157 short rts_unreach; /* lookups which failed */ 158 short rts_wildcard; /* lookups satisfied by a wildcard */ 159}; 160/* 161 * Structures for routing messages. 162 */ 163struct rt_msghdr { 164 u_short rtm_msglen; /* to skip over non-understood messages */ 165 u_char rtm_version; /* future binary compatibility */ 166 u_char rtm_type; /* message type */ 167 u_short rtm_index; /* index for associated ifp */ 168 int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 169 int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 170 pid_t rtm_pid; /* identify sender */ 171 int rtm_seq; /* for sender to identify action */ 172 int rtm_errno; /* why failed */ 173 int rtm_use; /* from rtentry */ 174 u_long rtm_inits; /* which metrics we are initializing */ 175 struct rt_metrics rtm_rmx; /* metrics themselves */ 176}; 177 178#define RTM_VERSION 4 /* Up the ante and ignore older versions */ 179 180#define RTM_ADD 0x1 /* Add Route */ 181#define RTM_DELETE 0x2 /* Delete Route */ 182#define RTM_CHANGE 0x3 /* Change Metrics or flags */ 183#define RTM_GET 0x4 /* Report Metrics */ 184#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 185#define RTM_REDIRECT 0x6 /* Told to use different route */ 186#define RTM_MISS 0x7 /* Lookup failed on this address */ 187#define RTM_LOCK 0x8 /* fix specified metrics */ 188#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 189#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 190#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 191#define RTM_NEWADDR 0xc /* address being added to iface */ 192#define RTM_DELADDR 0xd /* address being removed from iface */ 193#define RTM_IFINFO 0xe /* iface going up/down etc. */ 194 195#define RTV_MTU 0x1 /* init or lock _mtu */ 196#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 197#define RTV_EXPIRE 0x4 /* init or lock _hopcount */ 198#define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 199#define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 200#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 201#define RTV_RTT 0x40 /* init or lock _rtt */ 202#define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 203 204/* 205 * Bitmask values for rtm_addr. 206 */ 207#define RTA_DST 0x1 /* destination sockaddr present */ 208#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 209#define RTA_NETMASK 0x4 /* netmask sockaddr present */ 210#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 211#define RTA_IFP 0x10 /* interface name sockaddr present */ 212#define RTA_IFA 0x20 /* interface addr sockaddr present */ 213#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 214#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 215 216/* 217 * Index offsets for sockaddr array for alternate internal encoding. 218 */ 219#define RTAX_DST 0 /* destination sockaddr present */ 220#define RTAX_GATEWAY 1 /* gateway sockaddr present */ 221#define RTAX_NETMASK 2 /* netmask sockaddr present */ 222#define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 223#define RTAX_IFP 4 /* interface name sockaddr present */ 224#define RTAX_IFA 5 /* interface addr sockaddr present */ 225#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 226#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 227#define RTAX_MAX 8 /* size of array to allocate */ 228 229struct rt_addrinfo { 230 int rti_addrs; 231 struct sockaddr *rti_info[RTAX_MAX]; 232}; 233 234struct route_cb { 235 int ip_count; 236 int ns_count; 237 int iso_count; 238 int any_count; 239}; 240 241#ifdef KERNEL 242#define RTFREE(rt) \ 243 if ((rt)->rt_refcnt <= 1) \ 244 rtfree(rt); \ 245 else \ 246 (rt)->rt_refcnt--; 247 248struct route_cb route_cb; 249struct rtstat rtstat; 250struct radix_node_head *rt_tables[AF_MAX+1]; 251 252void route_init __P((void)); 253int route_output __P((struct mbuf *, struct socket *)); 254int route_usrreq __P((struct socket *, 255 int, struct mbuf *, struct mbuf *, struct mbuf *)); 256void rt_ifmsg __P((struct ifnet *)); 257void rt_maskedcopy __P((struct sockaddr *, 258 struct sockaddr *, struct sockaddr *)); 259void rt_missmsg __P((int, struct rt_addrinfo *, int, int)); 260void rt_newaddrmsg __P((int, struct ifaddr *, int, struct rtentry *)); 261int rt_setgate __P((struct rtentry *, 262 struct sockaddr *, struct sockaddr *)); 263void rt_setmetrics __P((u_long, struct rt_metrics *, struct rt_metrics *)); 264void rtable_init __P((void **)); 265void rtalloc __P((struct route *)); 266void rtalloc_ign __P((struct route *, unsigned long)); 267struct rtentry * 268 rtalloc1 __P((struct sockaddr *, int, unsigned long)); 269void rtfree __P((struct rtentry *)); 270int rtinit __P((struct ifaddr *, int, int)); 271int rtioctl __P((int, caddr_t, struct proc *)); 272void rtredirect __P((struct sockaddr *, struct sockaddr *, 273 struct sockaddr *, int, struct sockaddr *, struct rtentry **)); 274int rtrequest __P((int, struct sockaddr *, 275 struct sockaddr *, struct sockaddr *, int, struct rtentry **)); 276#endif 277 278#endif 279