route.h revision 139823
1139823Simp/*- 21541Srgrimes * Copyright (c) 1980, 1986, 1993 31541Srgrimes * The Regents of the University of California. All rights reserved. 41541Srgrimes * 51541Srgrimes * Redistribution and use in source and binary forms, with or without 61541Srgrimes * modification, are permitted provided that the following conditions 71541Srgrimes * are met: 81541Srgrimes * 1. Redistributions of source code must retain the above copyright 91541Srgrimes * notice, this list of conditions and the following disclaimer. 101541Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 111541Srgrimes * notice, this list of conditions and the following disclaimer in the 121541Srgrimes * documentation and/or other materials provided with the distribution. 131541Srgrimes * 4. Neither the name of the University nor the names of its contributors 141541Srgrimes * may be used to endorse or promote products derived from this software 151541Srgrimes * without specific prior written permission. 161541Srgrimes * 171541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 181541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 191541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 201541Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 211541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 221541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 231541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 241541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 251541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 261541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 271541Srgrimes * SUCH DAMAGE. 281541Srgrimes * 2985052Sru * @(#)route.h 8.4 (Berkeley) 1/9/95 3050477Speter * $FreeBSD: head/sys/net/route.h 139823 2005-01-07 01:45:51Z imp $ 311541Srgrimes */ 321541Srgrimes 332168Spaul#ifndef _NET_ROUTE_H_ 342168Spaul#define _NET_ROUTE_H_ 352168Spaul 361541Srgrimes/* 371541Srgrimes * Kernel resident routing tables. 388876Srgrimes * 391541Srgrimes * The routing tables are initialized when interface addresses 401541Srgrimes * are set by making entries for all directly connected interfaces. 411541Srgrimes */ 421541Srgrimes 431541Srgrimes/* 441541Srgrimes * A route consists of a destination address and a reference 451541Srgrimes * to a routing entry. These are often held by protocols 461541Srgrimes * in their control blocks, e.g. inpcb. 471541Srgrimes */ 481541Srgrimesstruct route { 491541Srgrimes struct rtentry *ro_rt; 501541Srgrimes struct sockaddr ro_dst; 511541Srgrimes}; 521541Srgrimes 531541Srgrimes/* 541541Srgrimes * These numbers are used by reliable protocols for determining 551541Srgrimes * retransmission behavior and are included in the routing structure. 561541Srgrimes */ 57122922Sandrestruct rt_metrics_lite { 58122922Sandre u_long rmx_mtu; /* MTU for this path */ 59122922Sandre u_long rmx_expire; /* lifetime for route, e.g. redirect */ 60122922Sandre u_long rmx_pksent; /* packets sent using this route */ 61122922Sandre}; 62122922Sandre 631541Srgrimesstruct rt_metrics { 641541Srgrimes u_long rmx_locks; /* Kernel must leave these values alone */ 651541Srgrimes u_long rmx_mtu; /* MTU for this path */ 661541Srgrimes u_long rmx_hopcount; /* max hops expected */ 671541Srgrimes u_long rmx_expire; /* lifetime for route, e.g. redirect */ 6813765Smpp u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 6913765Smpp u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 701541Srgrimes u_long rmx_ssthresh; /* outbound gateway buffer limit */ 711541Srgrimes u_long rmx_rtt; /* estimated round trip time */ 721541Srgrimes u_long rmx_rttvar; /* estimated rtt variance */ 731541Srgrimes u_long rmx_pksent; /* packets sent using this route */ 745791Swollman u_long rmx_filler[4]; /* will be used for T/TCP later */ 751541Srgrimes}; 761541Srgrimes 771541Srgrimes/* 781541Srgrimes * rmx_rtt and rmx_rttvar are stored as microseconds; 791541Srgrimes * RTTTOPRHZ(rtt) converts to a value suitable for use 801541Srgrimes * by a protocol slowtimo counter. 811541Srgrimes */ 821541Srgrimes#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 831541Srgrimes#define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 841541Srgrimes 851541Srgrimes/* 865833Sbde * XXX kernel function pointer `rt_output' is visible to applications. 875833Sbde */ 885833Sbdestruct mbuf; 895833Sbde 905833Sbde/* 911541Srgrimes * We distinguish between routes to hosts and routes to networks, 921541Srgrimes * preferring the former if available. For each route we infer 931541Srgrimes * the interface to use from the gateway address supplied when 941541Srgrimes * the route was entered. Routes that forward packets through 951541Srgrimes * gateways are marked so that the output routines know to address the 961541Srgrimes * gateway rather than the ultimate destination. 971541Srgrimes */ 981541Srgrimes#ifndef RNF_NORMAL 991541Srgrimes#include <net/radix.h> 1001541Srgrimes#endif 1011541Srgrimesstruct rtentry { 1021541Srgrimes struct radix_node rt_nodes[2]; /* tree glue, and other values */ 103128454Sluigi /* 104128454Sluigi * XXX struct rtentry must begin with a struct radix_node (or two!) 105128454Sluigi * because the code does some casts of a 'struct radix_node *' 106128454Sluigi * to a 'struct rtentry *' 107128454Sluigi */ 108132780Skan#define rt_key(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_key))) 109132780Skan#define rt_mask(r) (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask))) 1101541Srgrimes struct sockaddr *rt_gateway; /* value */ 1117197Swollman u_long rt_flags; /* up/down?, host/net */ 1121541Srgrimes struct ifnet *rt_ifp; /* the answer: interface to use */ 113122922Sandre struct ifaddr *rt_ifa; /* the answer: interface address to use */ 114127828Sluigi struct rt_metrics_lite rt_rmx; /* metrics used by rx'ing protocols */ 115127828Sluigi long rt_refcnt; /* # held references */ 1161541Srgrimes struct sockaddr *rt_genmask; /* for generation of cloned routes */ 1171541Srgrimes caddr_t rt_llinfo; /* pointer to link level info cache */ 1181541Srgrimes struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 1195791Swollman struct rtentry *rt_parent; /* cloning parent of this route */ 120120727Ssam#ifdef _KERNEL 121120727Ssam /* XXX ugly, user apps use this definition but don't have a mtx def */ 122120727Ssam struct mtx rt_mtx; /* mutex for routing entry */ 123120727Ssam#endif 1241541Srgrimes}; 1251541Srgrimes 1261541Srgrimes/* 1271541Srgrimes * Following structure necessary for 4.3 compatibility; 1281541Srgrimes * We should eventually move it to a compat file. 1291541Srgrimes */ 1301541Srgrimesstruct ortentry { 1311541Srgrimes u_long rt_hash; /* to speed lookups */ 1321541Srgrimes struct sockaddr rt_dst; /* key */ 1331541Srgrimes struct sockaddr rt_gateway; /* value */ 1341541Srgrimes short rt_flags; /* up/down?, host/net */ 1351541Srgrimes short rt_refcnt; /* # held references */ 1361541Srgrimes u_long rt_use; /* raw # packets forwarded */ 1371541Srgrimes struct ifnet *rt_ifp; /* the answer: interface to use */ 1381541Srgrimes}; 1391541Srgrimes 1404104Swollman#define rt_use rt_rmx.rmx_pksent 1414104Swollman 1421541Srgrimes#define RTF_UP 0x1 /* route usable */ 1431541Srgrimes#define RTF_GATEWAY 0x2 /* destination is a gateway */ 1441541Srgrimes#define RTF_HOST 0x4 /* host entry (net otherwise) */ 1451541Srgrimes#define RTF_REJECT 0x8 /* host or net unreachable */ 1461541Srgrimes#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 1471541Srgrimes#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 1481541Srgrimes#define RTF_DONE 0x40 /* message confirmed */ 14986764Sjlemon/* 0x80 unused, was RTF_DELCLONE */ 1501541Srgrimes#define RTF_CLONING 0x100 /* generate new routes on use */ 1511541Srgrimes#define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 15217835Sjulian#define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */ 1531541Srgrimes#define RTF_STATIC 0x800 /* manually added */ 1541541Srgrimes#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 1551541Srgrimes#define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 1561541Srgrimes#define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 1571541Srgrimes 158122921Sandre/* XXX: temporary to stay API/ABI compatible with userland */ 159122921Sandre#ifndef _KERNEL 160122921Sandre#define RTF_PRCLONING 0x10000 /* unused, for compatibility */ 161122921Sandre#endif 162122921Sandre 1635099Swollman#define RTF_WASCLONED 0x20000 /* route generated through cloning */ 1645099Swollman#define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 16518839Swollman/* 0x80000 unused */ 1666245Swollman#define RTF_PINNED 0x100000 /* future use */ 16715652Swollman#define RTF_LOCAL 0x200000 /* route represents a local address */ 16815652Swollman#define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 16915652Swollman#define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 17015652Swollman /* 0x1000000 and up unassigned */ 1711541Srgrimes 1721541Srgrimes/* 1731541Srgrimes * Routing statistics. 1741541Srgrimes */ 1751541Srgrimesstruct rtstat { 1761541Srgrimes short rts_badredirect; /* bogus redirect calls */ 1771541Srgrimes short rts_dynamic; /* routes created by redirects */ 1781541Srgrimes short rts_newgateway; /* routes modified by redirects */ 1791541Srgrimes short rts_unreach; /* lookups which failed */ 1801541Srgrimes short rts_wildcard; /* lookups satisfied by a wildcard */ 1811541Srgrimes}; 1821541Srgrimes/* 1831541Srgrimes * Structures for routing messages. 1841541Srgrimes */ 1851541Srgrimesstruct rt_msghdr { 1861541Srgrimes u_short rtm_msglen; /* to skip over non-understood messages */ 1871541Srgrimes u_char rtm_version; /* future binary compatibility */ 1881541Srgrimes u_char rtm_type; /* message type */ 1891541Srgrimes u_short rtm_index; /* index for associated ifp */ 1901541Srgrimes int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 1911541Srgrimes int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 1921541Srgrimes pid_t rtm_pid; /* identify sender */ 1931541Srgrimes int rtm_seq; /* for sender to identify action */ 1941541Srgrimes int rtm_errno; /* why failed */ 1951541Srgrimes int rtm_use; /* from rtentry */ 1961541Srgrimes u_long rtm_inits; /* which metrics we are initializing */ 1971541Srgrimes struct rt_metrics rtm_rmx; /* metrics themselves */ 1981541Srgrimes}; 1991541Srgrimes 2005791Swollman#define RTM_VERSION 5 /* Up the ante and ignore older versions */ 2011541Srgrimes 20251252Sru/* 20351252Sru * Message types. 20451252Sru */ 2051541Srgrimes#define RTM_ADD 0x1 /* Add Route */ 2061541Srgrimes#define RTM_DELETE 0x2 /* Delete Route */ 2071541Srgrimes#define RTM_CHANGE 0x3 /* Change Metrics or flags */ 2081541Srgrimes#define RTM_GET 0x4 /* Report Metrics */ 2091541Srgrimes#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 2101541Srgrimes#define RTM_REDIRECT 0x6 /* Told to use different route */ 2111541Srgrimes#define RTM_MISS 0x7 /* Lookup failed on this address */ 2121541Srgrimes#define RTM_LOCK 0x8 /* fix specified metrics */ 2131541Srgrimes#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 2141541Srgrimes#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 2151541Srgrimes#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 2161541Srgrimes#define RTM_NEWADDR 0xc /* address being added to iface */ 2171541Srgrimes#define RTM_DELADDR 0xd /* address being removed from iface */ 2181541Srgrimes#define RTM_IFINFO 0xe /* iface going up/down etc. */ 21921666Swollman#define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ 22021666Swollman#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ 22189498Sru#define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */ 222136155Ssam#define RTM_IEEE80211 0x12 /* IEEE80211 wireless event */ 2231541Srgrimes 22451252Sru/* 22551252Sru * Bitmask values for rtm_inits and rmx_locks. 22651252Sru */ 2271541Srgrimes#define RTV_MTU 0x1 /* init or lock _mtu */ 2281541Srgrimes#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 22951252Sru#define RTV_EXPIRE 0x4 /* init or lock _expire */ 2301541Srgrimes#define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 2311541Srgrimes#define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 2321541Srgrimes#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 2331541Srgrimes#define RTV_RTT 0x40 /* init or lock _rtt */ 2341541Srgrimes#define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 2351541Srgrimes 2361541Srgrimes/* 23751252Sru * Bitmask values for rtm_addrs. 2381541Srgrimes */ 2391541Srgrimes#define RTA_DST 0x1 /* destination sockaddr present */ 2401541Srgrimes#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 2411541Srgrimes#define RTA_NETMASK 0x4 /* netmask sockaddr present */ 2421541Srgrimes#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 2431541Srgrimes#define RTA_IFP 0x10 /* interface name sockaddr present */ 2441541Srgrimes#define RTA_IFA 0x20 /* interface addr sockaddr present */ 2451541Srgrimes#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 2461541Srgrimes#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 2471541Srgrimes 2481541Srgrimes/* 2491541Srgrimes * Index offsets for sockaddr array for alternate internal encoding. 2501541Srgrimes */ 2511541Srgrimes#define RTAX_DST 0 /* destination sockaddr present */ 2521541Srgrimes#define RTAX_GATEWAY 1 /* gateway sockaddr present */ 2531541Srgrimes#define RTAX_NETMASK 2 /* netmask sockaddr present */ 2541541Srgrimes#define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 2551541Srgrimes#define RTAX_IFP 4 /* interface name sockaddr present */ 2561541Srgrimes#define RTAX_IFA 5 /* interface addr sockaddr present */ 2571541Srgrimes#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 2581541Srgrimes#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 2591541Srgrimes#define RTAX_MAX 8 /* size of array to allocate */ 2601541Srgrimes 2611541Srgrimesstruct rt_addrinfo { 2621541Srgrimes int rti_addrs; 2631541Srgrimes struct sockaddr *rti_info[RTAX_MAX]; 26485074Sru int rti_flags; 26585074Sru struct ifaddr *rti_ifa; 26685074Sru struct ifnet *rti_ifp; 2671541Srgrimes}; 2681541Srgrimes 269128185Sluigi/* 270128185Sluigi * This macro returns the size of a struct sockaddr when passed 271128185Sluigi * through a routing socket. Basically we round up sa_len to 272128185Sluigi * a multiple of sizeof(long), with a minimum of sizeof(long). 273128185Sluigi * The check for a NULL pointer is just a convenience, probably never used. 274128185Sluigi * The case sa_len == 0 should only apply to empty structures. 275128185Sluigi */ 276128185Sluigi#define SA_SIZE(sa) \ 277128185Sluigi ( (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ? \ 278128185Sluigi sizeof(long) : \ 279128185Sluigi 1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) ) 280128185Sluigi 28155205Speter#ifdef _KERNEL 282117752Shsu 283120727Ssam#define RT_LOCK_INIT(_rt) \ 284120727Ssam mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK) 285120727Ssam#define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx) 286120727Ssam#define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx) 287120727Ssam#define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx) 288120727Ssam#define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED) 289117752Shsu 290122334Ssam#define RT_ADDREF(_rt) do { \ 291122334Ssam RT_LOCK_ASSERT(_rt); \ 292122334Ssam KASSERT((_rt)->rt_refcnt >= 0, \ 293122334Ssam ("negative refcnt %ld", (_rt)->rt_refcnt)); \ 294122334Ssam (_rt)->rt_refcnt++; \ 295122334Ssam} while (0); 296122334Ssam#define RT_REMREF(_rt) do { \ 297122334Ssam RT_LOCK_ASSERT(_rt); \ 298122334Ssam KASSERT((_rt)->rt_refcnt > 0, \ 299122334Ssam ("bogus refcnt %ld", (_rt)->rt_refcnt)); \ 300122334Ssam (_rt)->rt_refcnt--; \ 301122334Ssam} while (0); 302122334Ssam 303122334Ssam#define RTFREE_LOCKED(_rt) do { \ 304122334Ssam if ((_rt)->rt_refcnt <= 1) \ 305122334Ssam rtfree(_rt); \ 306122334Ssam else { \ 307122334Ssam RT_REMREF(_rt); \ 308122334Ssam RT_UNLOCK(_rt); \ 309122334Ssam } \ 310122334Ssam /* guard against invalid refs */ \ 311122334Ssam _rt = 0; \ 31246568Speter } while (0) 313122334Ssam#define RTFREE(_rt) do { \ 314122334Ssam RT_LOCK(_rt); \ 315122334Ssam RTFREE_LOCKED(_rt); \ 316120727Ssam } while (0) 3171541Srgrimes 3189759Sbdeextern struct radix_node_head *rt_tables[AF_MAX+1]; 3191541Srgrimes 32021666Swollmanstruct ifmultiaddr; 32121666Swollman 32292725Salfredint rt_getifa(struct rt_addrinfo *); 323136155Ssamvoid rt_ieee80211msg(struct ifnet *, int, void *, size_t); 32492725Salfredvoid rt_ifannouncemsg(struct ifnet *, int); 32592725Salfredvoid rt_ifmsg(struct ifnet *); 32692725Salfredvoid rt_missmsg(int, struct rt_addrinfo *, int, int); 32792725Salfredvoid rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *); 32892725Salfredvoid rt_newmaddrmsg(int, struct ifmultiaddr *); 32992725Salfredint rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *); 330128621Sluigi 331128621Sluigi/* 332128621Sluigi * Note the following locking behavior: 333128621Sluigi * 334128621Sluigi * rtalloc_ign() and rtalloc() return ro->ro_rt unlocked 335128621Sluigi * 336128621Sluigi * rtalloc1() returns a locked rtentry 337128621Sluigi * 338128621Sluigi * rtfree() and RTFREE_LOCKED() require a locked rtentry 339128621Sluigi * 340128621Sluigi * RTFREE() uses an unlocked entry. 341128621Sluigi */ 342128621Sluigi 343128621Sluigivoid rtalloc_ign(struct route *ro, u_long ignflags); 344128621Sluigivoid rtalloc(struct route *ro); /* XXX deprecated, use rtalloc_ign(ro, 0) */ 345120727Ssamstruct rtentry *rtalloc1(struct sockaddr *, int, u_long); 346121770Ssamint rtexpunge(struct rtentry *); 34792725Salfredvoid rtfree(struct rtentry *); 34892725Salfredint rtinit(struct ifaddr *, int, int); 34992725Salfredint rtioctl(u_long, caddr_t); 35092725Salfredvoid rtredirect(struct sockaddr *, struct sockaddr *, 351120727Ssam struct sockaddr *, int, struct sockaddr *); 35292725Salfredint rtrequest(int, struct sockaddr *, 35392725Salfred struct sockaddr *, struct sockaddr *, int, struct rtentry **); 35492725Salfredint rtrequest1(int, struct rt_addrinfo *, struct rtentry **); 355111767Smdoddint rt_check(struct rtentry **, struct rtentry **, struct sockaddr *); 3561541Srgrimes#endif 3572168Spaul 3582168Spaul#endif 359