route.h revision 122334
11541Srgrimes/* 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 * 3. All advertising materials mentioning features or use of this software 141541Srgrimes * must display the following acknowledgement: 151541Srgrimes * This product includes software developed by the University of 161541Srgrimes * California, Berkeley and its contributors. 171541Srgrimes * 4. Neither the name of the University nor the names of its contributors 181541Srgrimes * may be used to endorse or promote products derived from this software 191541Srgrimes * without specific prior written permission. 201541Srgrimes * 211541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 221541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 231541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 241541Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 251541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 261541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 271541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 281541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 291541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 301541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 311541Srgrimes * SUCH DAMAGE. 321541Srgrimes * 3385052Sru * @(#)route.h 8.4 (Berkeley) 1/9/95 3450477Speter * $FreeBSD: head/sys/net/route.h 122334 2003-11-08 23:36:32Z sam $ 351541Srgrimes */ 361541Srgrimes 372168Spaul#ifndef _NET_ROUTE_H_ 382168Spaul#define _NET_ROUTE_H_ 392168Spaul 401541Srgrimes/* 411541Srgrimes * Kernel resident routing tables. 428876Srgrimes * 431541Srgrimes * The routing tables are initialized when interface addresses 441541Srgrimes * are set by making entries for all directly connected interfaces. 451541Srgrimes */ 461541Srgrimes 471541Srgrimes/* 481541Srgrimes * A route consists of a destination address and a reference 491541Srgrimes * to a routing entry. These are often held by protocols 501541Srgrimes * in their control blocks, e.g. inpcb. 511541Srgrimes */ 521541Srgrimesstruct route { 531541Srgrimes struct rtentry *ro_rt; 541541Srgrimes struct sockaddr ro_dst; 551541Srgrimes}; 561541Srgrimes 571541Srgrimes/* 581541Srgrimes * These numbers are used by reliable protocols for determining 591541Srgrimes * retransmission behavior and are included in the routing structure. 601541Srgrimes */ 611541Srgrimesstruct rt_metrics { 621541Srgrimes u_long rmx_locks; /* Kernel must leave these values alone */ 631541Srgrimes u_long rmx_mtu; /* MTU for this path */ 641541Srgrimes u_long rmx_hopcount; /* max hops expected */ 651541Srgrimes u_long rmx_expire; /* lifetime for route, e.g. redirect */ 6613765Smpp u_long rmx_recvpipe; /* inbound delay-bandwidth product */ 6713765Smpp u_long rmx_sendpipe; /* outbound delay-bandwidth product */ 681541Srgrimes u_long rmx_ssthresh; /* outbound gateway buffer limit */ 691541Srgrimes u_long rmx_rtt; /* estimated round trip time */ 701541Srgrimes u_long rmx_rttvar; /* estimated rtt variance */ 711541Srgrimes u_long rmx_pksent; /* packets sent using this route */ 725791Swollman u_long rmx_filler[4]; /* will be used for T/TCP later */ 731541Srgrimes}; 741541Srgrimes 751541Srgrimes/* 761541Srgrimes * rmx_rtt and rmx_rttvar are stored as microseconds; 771541Srgrimes * RTTTOPRHZ(rtt) converts to a value suitable for use 781541Srgrimes * by a protocol slowtimo counter. 791541Srgrimes */ 801541Srgrimes#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */ 811541Srgrimes#define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ)) 821541Srgrimes 831541Srgrimes/* 845833Sbde * XXX kernel function pointer `rt_output' is visible to applications. 855833Sbde */ 865833Sbdestruct mbuf; 875833Sbde 885833Sbde/* 891541Srgrimes * We distinguish between routes to hosts and routes to networks, 901541Srgrimes * preferring the former if available. For each route we infer 911541Srgrimes * the interface to use from the gateway address supplied when 921541Srgrimes * the route was entered. Routes that forward packets through 931541Srgrimes * gateways are marked so that the output routines know to address the 941541Srgrimes * gateway rather than the ultimate destination. 951541Srgrimes */ 961541Srgrimes#ifndef RNF_NORMAL 971541Srgrimes#include <net/radix.h> 981541Srgrimes#endif 991541Srgrimesstruct rtentry { 1001541Srgrimes struct radix_node rt_nodes[2]; /* tree glue, and other values */ 1011541Srgrimes#define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key)) 1021541Srgrimes#define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask)) 1031541Srgrimes struct sockaddr *rt_gateway; /* value */ 10448381Smsmith long rt_refcnt; /* # held references */ 1057197Swollman u_long rt_flags; /* up/down?, host/net */ 1061541Srgrimes struct ifnet *rt_ifp; /* the answer: interface to use */ 1071541Srgrimes struct ifaddr *rt_ifa; /* the answer: interface to use */ 1081541Srgrimes struct sockaddr *rt_genmask; /* for generation of cloned routes */ 1091541Srgrimes caddr_t rt_llinfo; /* pointer to link level info cache */ 1101541Srgrimes struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */ 1111541Srgrimes struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */ 11293084Sbde int (*rt_output)(struct ifnet *, struct mbuf *, struct sockaddr *, 11393084Sbde struct rtentry *); 1145791Swollman /* output routine for this (rt,if) */ 1155791Swollman struct rtentry *rt_parent; /* cloning parent of this route */ 116120727Ssam#ifdef _KERNEL 117120727Ssam /* XXX ugly, user apps use this definition but don't have a mtx def */ 118120727Ssam struct mtx rt_mtx; /* mutex for routing entry */ 119120727Ssam#endif 1201541Srgrimes}; 1211541Srgrimes 1221541Srgrimes/* 1231541Srgrimes * Following structure necessary for 4.3 compatibility; 1241541Srgrimes * We should eventually move it to a compat file. 1251541Srgrimes */ 1261541Srgrimesstruct ortentry { 1271541Srgrimes u_long rt_hash; /* to speed lookups */ 1281541Srgrimes struct sockaddr rt_dst; /* key */ 1291541Srgrimes struct sockaddr rt_gateway; /* value */ 1301541Srgrimes short rt_flags; /* up/down?, host/net */ 1311541Srgrimes short rt_refcnt; /* # held references */ 1321541Srgrimes u_long rt_use; /* raw # packets forwarded */ 1331541Srgrimes struct ifnet *rt_ifp; /* the answer: interface to use */ 1341541Srgrimes}; 1351541Srgrimes 1364104Swollman#define rt_use rt_rmx.rmx_pksent 1374104Swollman 1381541Srgrimes#define RTF_UP 0x1 /* route usable */ 1391541Srgrimes#define RTF_GATEWAY 0x2 /* destination is a gateway */ 1401541Srgrimes#define RTF_HOST 0x4 /* host entry (net otherwise) */ 1411541Srgrimes#define RTF_REJECT 0x8 /* host or net unreachable */ 1421541Srgrimes#define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */ 1431541Srgrimes#define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */ 1441541Srgrimes#define RTF_DONE 0x40 /* message confirmed */ 14586764Sjlemon/* 0x80 unused, was RTF_DELCLONE */ 1461541Srgrimes#define RTF_CLONING 0x100 /* generate new routes on use */ 1471541Srgrimes#define RTF_XRESOLVE 0x200 /* external daemon resolves name */ 14817835Sjulian#define RTF_LLINFO 0x400 /* generated by link layer (e.g. ARP) */ 1491541Srgrimes#define RTF_STATIC 0x800 /* manually added */ 1501541Srgrimes#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */ 1511541Srgrimes#define RTF_PROTO2 0x4000 /* protocol specific routing flag */ 1521541Srgrimes#define RTF_PROTO1 0x8000 /* protocol specific routing flag */ 1531541Srgrimes 1545099Swollman#define RTF_PRCLONING 0x10000 /* protocol requires cloning */ 1555099Swollman#define RTF_WASCLONED 0x20000 /* route generated through cloning */ 1565099Swollman#define RTF_PROTO3 0x40000 /* protocol specific routing flag */ 15718839Swollman/* 0x80000 unused */ 1586245Swollman#define RTF_PINNED 0x100000 /* future use */ 15915652Swollman#define RTF_LOCAL 0x200000 /* route represents a local address */ 16015652Swollman#define RTF_BROADCAST 0x400000 /* route represents a bcast address */ 16115652Swollman#define RTF_MULTICAST 0x800000 /* route represents a mcast address */ 16215652Swollman /* 0x1000000 and up unassigned */ 1631541Srgrimes 1641541Srgrimes/* 1651541Srgrimes * Routing statistics. 1661541Srgrimes */ 1671541Srgrimesstruct rtstat { 1681541Srgrimes short rts_badredirect; /* bogus redirect calls */ 1691541Srgrimes short rts_dynamic; /* routes created by redirects */ 1701541Srgrimes short rts_newgateway; /* routes modified by redirects */ 1711541Srgrimes short rts_unreach; /* lookups which failed */ 1721541Srgrimes short rts_wildcard; /* lookups satisfied by a wildcard */ 1731541Srgrimes}; 1741541Srgrimes/* 1751541Srgrimes * Structures for routing messages. 1761541Srgrimes */ 1771541Srgrimesstruct rt_msghdr { 1781541Srgrimes u_short rtm_msglen; /* to skip over non-understood messages */ 1791541Srgrimes u_char rtm_version; /* future binary compatibility */ 1801541Srgrimes u_char rtm_type; /* message type */ 1811541Srgrimes u_short rtm_index; /* index for associated ifp */ 1821541Srgrimes int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ 1831541Srgrimes int rtm_addrs; /* bitmask identifying sockaddrs in msg */ 1841541Srgrimes pid_t rtm_pid; /* identify sender */ 1851541Srgrimes int rtm_seq; /* for sender to identify action */ 1861541Srgrimes int rtm_errno; /* why failed */ 1871541Srgrimes int rtm_use; /* from rtentry */ 1881541Srgrimes u_long rtm_inits; /* which metrics we are initializing */ 1891541Srgrimes struct rt_metrics rtm_rmx; /* metrics themselves */ 1901541Srgrimes}; 1911541Srgrimes 1925791Swollman#define RTM_VERSION 5 /* Up the ante and ignore older versions */ 1931541Srgrimes 19451252Sru/* 19551252Sru * Message types. 19651252Sru */ 1971541Srgrimes#define RTM_ADD 0x1 /* Add Route */ 1981541Srgrimes#define RTM_DELETE 0x2 /* Delete Route */ 1991541Srgrimes#define RTM_CHANGE 0x3 /* Change Metrics or flags */ 2001541Srgrimes#define RTM_GET 0x4 /* Report Metrics */ 2011541Srgrimes#define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */ 2021541Srgrimes#define RTM_REDIRECT 0x6 /* Told to use different route */ 2031541Srgrimes#define RTM_MISS 0x7 /* Lookup failed on this address */ 2041541Srgrimes#define RTM_LOCK 0x8 /* fix specified metrics */ 2051541Srgrimes#define RTM_OLDADD 0x9 /* caused by SIOCADDRT */ 2061541Srgrimes#define RTM_OLDDEL 0xa /* caused by SIOCDELRT */ 2071541Srgrimes#define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */ 2081541Srgrimes#define RTM_NEWADDR 0xc /* address being added to iface */ 2091541Srgrimes#define RTM_DELADDR 0xd /* address being removed from iface */ 2101541Srgrimes#define RTM_IFINFO 0xe /* iface going up/down etc. */ 21121666Swollman#define RTM_NEWMADDR 0xf /* mcast group membership being added to if */ 21221666Swollman#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */ 21389498Sru#define RTM_IFANNOUNCE 0x11 /* iface arrival/departure */ 2141541Srgrimes 21551252Sru/* 21651252Sru * Bitmask values for rtm_inits and rmx_locks. 21751252Sru */ 2181541Srgrimes#define RTV_MTU 0x1 /* init or lock _mtu */ 2191541Srgrimes#define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */ 22051252Sru#define RTV_EXPIRE 0x4 /* init or lock _expire */ 2211541Srgrimes#define RTV_RPIPE 0x8 /* init or lock _recvpipe */ 2221541Srgrimes#define RTV_SPIPE 0x10 /* init or lock _sendpipe */ 2231541Srgrimes#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */ 2241541Srgrimes#define RTV_RTT 0x40 /* init or lock _rtt */ 2251541Srgrimes#define RTV_RTTVAR 0x80 /* init or lock _rttvar */ 2261541Srgrimes 2271541Srgrimes/* 22851252Sru * Bitmask values for rtm_addrs. 2291541Srgrimes */ 2301541Srgrimes#define RTA_DST 0x1 /* destination sockaddr present */ 2311541Srgrimes#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ 2321541Srgrimes#define RTA_NETMASK 0x4 /* netmask sockaddr present */ 2331541Srgrimes#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */ 2341541Srgrimes#define RTA_IFP 0x10 /* interface name sockaddr present */ 2351541Srgrimes#define RTA_IFA 0x20 /* interface addr sockaddr present */ 2361541Srgrimes#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */ 2371541Srgrimes#define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */ 2381541Srgrimes 2391541Srgrimes/* 2401541Srgrimes * Index offsets for sockaddr array for alternate internal encoding. 2411541Srgrimes */ 2421541Srgrimes#define RTAX_DST 0 /* destination sockaddr present */ 2431541Srgrimes#define RTAX_GATEWAY 1 /* gateway sockaddr present */ 2441541Srgrimes#define RTAX_NETMASK 2 /* netmask sockaddr present */ 2451541Srgrimes#define RTAX_GENMASK 3 /* cloning mask sockaddr present */ 2461541Srgrimes#define RTAX_IFP 4 /* interface name sockaddr present */ 2471541Srgrimes#define RTAX_IFA 5 /* interface addr sockaddr present */ 2481541Srgrimes#define RTAX_AUTHOR 6 /* sockaddr for author of redirect */ 2491541Srgrimes#define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */ 2501541Srgrimes#define RTAX_MAX 8 /* size of array to allocate */ 2511541Srgrimes 2521541Srgrimesstruct rt_addrinfo { 2531541Srgrimes int rti_addrs; 2541541Srgrimes struct sockaddr *rti_info[RTAX_MAX]; 25585074Sru int rti_flags; 25685074Sru struct ifaddr *rti_ifa; 25785074Sru struct ifnet *rti_ifp; 2581541Srgrimes}; 2591541Srgrimes 26055205Speter#ifdef _KERNEL 261117752Shsu 262120727Ssam#define RT_LOCK_INIT(_rt) \ 263120727Ssam mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK) 264120727Ssam#define RT_LOCK(_rt) mtx_lock(&(_rt)->rt_mtx) 265120727Ssam#define RT_UNLOCK(_rt) mtx_unlock(&(_rt)->rt_mtx) 266120727Ssam#define RT_LOCK_DESTROY(_rt) mtx_destroy(&(_rt)->rt_mtx) 267120727Ssam#define RT_LOCK_ASSERT(_rt) mtx_assert(&(_rt)->rt_mtx, MA_OWNED) 268117752Shsu 269122334Ssam#define RT_ADDREF(_rt) do { \ 270122334Ssam RT_LOCK_ASSERT(_rt); \ 271122334Ssam KASSERT((_rt)->rt_refcnt >= 0, \ 272122334Ssam ("negative refcnt %ld", (_rt)->rt_refcnt)); \ 273122334Ssam (_rt)->rt_refcnt++; \ 274122334Ssam} while (0); 275122334Ssam#define RT_REMREF(_rt) do { \ 276122334Ssam RT_LOCK_ASSERT(_rt); \ 277122334Ssam KASSERT((_rt)->rt_refcnt > 0, \ 278122334Ssam ("bogus refcnt %ld", (_rt)->rt_refcnt)); \ 279122334Ssam (_rt)->rt_refcnt--; \ 280122334Ssam} while (0); 281122334Ssam 282122334Ssam#define RTFREE_LOCKED(_rt) do { \ 283122334Ssam if ((_rt)->rt_refcnt <= 1) \ 284122334Ssam rtfree(_rt); \ 285122334Ssam else { \ 286122334Ssam RT_REMREF(_rt); \ 287122334Ssam RT_UNLOCK(_rt); \ 288122334Ssam } \ 289122334Ssam /* guard against invalid refs */ \ 290122334Ssam _rt = 0; \ 29146568Speter } while (0) 292122334Ssam#define RTFREE(_rt) do { \ 293122334Ssam RT_LOCK(_rt); \ 294122334Ssam RTFREE_LOCKED(_rt); \ 295120727Ssam } while (0) 2961541Srgrimes 2979759Sbdeextern struct radix_node_head *rt_tables[AF_MAX+1]; 2981541Srgrimes 29921666Swollmanstruct ifmultiaddr; 30021666Swollman 30192725Salfredvoid route_init(void); 30292725Salfredint rt_getifa(struct rt_addrinfo *); 30392725Salfredvoid rt_ifannouncemsg(struct ifnet *, int); 30492725Salfredvoid rt_ifmsg(struct ifnet *); 30592725Salfredvoid rt_missmsg(int, struct rt_addrinfo *, int, int); 30692725Salfredvoid rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *); 30792725Salfredvoid rt_newmaddrmsg(int, struct ifmultiaddr *); 308120727Ssamvoid rtalloc(struct route *); 30992725Salfredint rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *); 31092725Salfredvoid rtalloc_ign(struct route *, u_long); 311120727Ssam/* NB: the rtentry is returned locked */ 312120727Ssamstruct rtentry *rtalloc1(struct sockaddr *, int, u_long); 313121770Ssamint rtexpunge(struct rtentry *); 31492725Salfredvoid rtfree(struct rtentry *); 31592725Salfredint rtinit(struct ifaddr *, int, int); 31692725Salfredint rtioctl(u_long, caddr_t); 31792725Salfredvoid rtredirect(struct sockaddr *, struct sockaddr *, 318120727Ssam struct sockaddr *, int, struct sockaddr *); 31992725Salfredint rtrequest(int, struct sockaddr *, 32092725Salfred struct sockaddr *, struct sockaddr *, int, struct rtentry **); 32192725Salfredint rtrequest1(int, struct rt_addrinfo *, struct rtentry **); 322111767Smdoddint rt_check(struct rtentry **, struct rtentry **, struct sockaddr *); 3231541Srgrimes#endif 3242168Spaul 3252168Spaul#endif 326