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