xref: /original-bsd/sys/net/route.h (revision e0c0d005)
1 /*
2  * Copyright (c) 1980, 1986 Regents of the University of California.
3  * All rights reserved.
4  *
5  * %sccs.include.redist.c%
6  *
7  *	@(#)route.h	7.12 (Berkeley) 07/26/90
8  */
9 
10 /*
11  * Kernel resident routing tables.
12  *
13  * The routing tables are initialized when interface addresses
14  * are set by making entries for all directly connected interfaces.
15  */
16 
17 /*
18  * A route consists of a destination address and a reference
19  * to a routing entry.  These are often held by protocols
20  * in their control blocks, e.g. inpcb.
21  */
22 struct route {
23 	struct	rtentry *ro_rt;
24 	struct	sockaddr ro_dst;
25 };
26 
27 /*
28  * These numbers are used by reliable protocols for determining
29  * retransmission behavior and are included in the routing structure.
30  */
31 struct rt_metrics {
32 	u_long	rmx_locks;	/* Kernel must leave these values alone */
33 	u_long	rmx_mtu;	/* MTU for this path */
34 	u_long	rmx_hopcount;	/* max hops expected */
35 	u_long	rmx_expire;	/* lifetime for route, e.g. redirect */
36 	u_long	rmx_recvpipe;	/* inbound delay-bandwith product */
37 	u_long	rmx_sendpipe;	/* outbound delay-bandwith product */
38 	u_long	rmx_ssthresh;	/* outbound gateway buffer limit */
39 	u_long	rmx_rtt;	/* estimated round trip time */
40 	u_long	rmx_rttvar;	/* estimated rtt variance */
41 };
42 
43 /*
44  * rmx_rtt and rmx_rttvar are stored as microseconds;
45  * RTTTOPRHZ(rtt) converts to a value suitable for use
46  * by a protocol slowtimo counter.
47  */
48 #define	RTM_RTTUNIT	1000000	/* units for rtt, rttvar, as units per sec */
49 #define	RTTTOPRHZ(r)	((r) / (RTM_RTTUNIT / PR_SLOWHZ))
50 
51 /*
52  * We distinguish between routes to hosts and routes to networks,
53  * preferring the former if available.  For each route we infer
54  * the interface to use from the gateway address supplied when
55  * the route was entered.  Routes that forward packets through
56  * gateways are marked so that the output routines know to address the
57  * gateway rather than the ultimate destination.
58  */
59 #include "radix.h"
60 struct rtentry {
61 	struct	radix_node rt_nodes[2];	/* tree glue, and other values */
62 #define	rt_key(r)	((struct sockaddr *)((r)->rt_nodes->rn_key))
63 #define	rt_mask(r)	((struct sockaddr *)((r)->rt_nodes->rn_mask))
64 	struct	sockaddr *rt_gateway;	/* value */
65 	short	rt_flags;		/* up/down?, host/net */
66 	short	rt_refcnt;		/* # held references */
67 	u_long	rt_use;			/* raw # packets forwarded */
68 	struct	ifnet *rt_ifp;		/* the answer: interface to use */
69 	struct	ifaddr *rt_ifa;		/* the answer: interface to use */
70 	struct	sockaddr *rt_genmask;	/* for generation of cloned routes */
71 	caddr_t	rt_llinfo;		/* pointer to link level info cache */
72 	struct	rt_metrics rt_rmx;	/* metrics used by rx'ing protocols */
73 	short	rt_idle;		/* easy to tell llayer still live */
74 };
75 
76 /*
77  * Following structure necessary for 4.3 compatibility;
78  * We should eventually move it to a compat file.
79  */
80 struct ortentry {
81 	u_long	rt_hash;		/* to speed lookups */
82 	struct	sockaddr rt_dst;	/* key */
83 	struct	sockaddr rt_gateway;	/* value */
84 	short	rt_flags;		/* up/down?, host/net */
85 	short	rt_refcnt;		/* # held references */
86 	u_long	rt_use;			/* raw # packets forwarded */
87 	struct	ifnet *rt_ifp;		/* the answer: interface to use */
88 };
89 
90 #define	RTF_UP		0x1		/* route useable */
91 #define	RTF_GATEWAY	0x2		/* destination is a gateway */
92 #define	RTF_HOST	0x4		/* host entry (net otherwise) */
93 #define	RTF_REJECT	0x8		/* host or net unreachable */
94 #define	RTF_DYNAMIC	0x10		/* created dynamically (by redirect) */
95 #define	RTF_MODIFIED	0x20		/* modified dynamically (by redirect) */
96 #define RTF_DONE	0x40		/* message confirmed */
97 #define RTF_MASK	0x80		/* subnet mask present */
98 #define RTF_CLONING	0x100		/* generate new routes on use */
99 #define RTF_XRESOLVE	0x200		/* external daemon resolves name */
100 #define RTF_LLINFO	0x400		/* generated by ARP or ESIS */
101 
102 
103 /*
104  * Routing statistics.
105  */
106 struct	rtstat {
107 	short	rts_badredirect;	/* bogus redirect calls */
108 	short	rts_dynamic;		/* routes created by redirects */
109 	short	rts_newgateway;		/* routes modified by redirects */
110 	short	rts_unreach;		/* lookups which failed */
111 	short	rts_wildcard;		/* lookups satisfied by a wildcard */
112 };
113 /*
114  * Structures for routing messages.
115  */
116 struct rt_msghdr {
117 	u_short	rtm_msglen;	/* to skip over non-understood messages */
118 	u_char	rtm_version;	/* future binary compatability */
119 	u_char	rtm_type;	/* message type */
120 	u_short	rtm_index;	/* index for associated ifp */
121 	pid_t	rtm_pid;	/* identify sender */
122 	int	rtm_addrs;	/* bitmask identifying sockaddrs in msg */
123 	int	rtm_seq;	/* for sender to identify action */
124 	int	rtm_errno;	/* why failed */
125 	int	rtm_flags;	/* flags, incl. kern & message, e.g. DONE */
126 	int	rtm_use;	/* from rtentry */
127 	u_long	rtm_inits;	/* which metrics we are initializing */
128 	struct	rt_metrics rtm_rmx; /* metrics themselves */
129 };
130 
131 struct route_cb {
132 	int	ip_count;
133 	int	ns_count;
134 	int	iso_count;
135 	int	any_count;
136 };
137 #define RTM_VERSION	2	/* Up the ante and ignore older versions */
138 
139 #define RTM_ADD		0x1	/* Add Route */
140 #define RTM_DELETE	0x2	/* Delete Route */
141 #define RTM_CHANGE	0x3	/* Change Metrics or flags */
142 #define RTM_GET		0x4	/* Report Metrics */
143 #define RTM_LOSING	0x5	/* Kernel Suspects Partitioning */
144 #define RTM_REDIRECT	0x6	/* Told to use different route */
145 #define RTM_MISS	0x7	/* Lookup failed on this address */
146 #define RTM_LOCK	0x8	/* fix specified metrics */
147 #define RTM_OLDADD	0x9	/* caused by SIOCADDRT */
148 #define RTM_OLDDEL	0xa	/* caused by SIOCDELRT */
149 #define RTM_RESOLVE	0xb	/* req to resolve dst to LL addr */
150 
151 #define RTV_MTU		0x1	/* init or lock _mtu */
152 #define RTV_HOPCOUNT	0x2	/* init or lock _hopcount */
153 #define RTV_EXPIRE	0x4	/* init or lock _hopcount */
154 #define RTV_RPIPE	0x8	/* init or lock _recvpipe */
155 #define RTV_SPIPE	0x10	/* init or lock _sendpipe */
156 #define RTV_SSTHRESH	0x20	/* init or lock _ssthresh */
157 #define RTV_RTT		0x40	/* init or lock _rtt */
158 #define RTV_RTTVAR	0x80	/* init or lock _rttvar */
159 
160 #define RTA_DST		0x1	/* destination sockaddr present */
161 #define RTA_GATEWAY	0x2	/* gateway sockaddr present */
162 #define RTA_NETMASK	0x4	/* netmask sockaddr present */
163 #define RTA_GENMASK	0x8	/* cloning mask sockaddr present */
164 #define RTA_IFP		0x10	/* interface name sockaddr present */
165 #define RTA_IFA		0x20	/* interface addr sockaddr present */
166 #define RTA_AUTHOR	0x40	/* sockaddr for author of redirect */
167 
168 #ifdef KERNEL
169 struct route_cb route_cb;
170 #endif
171 
172 #ifdef KERNEL
173 #define	RTFREE(rt) \
174 	if ((rt)->rt_refcnt <= 1) \
175 		rtfree(rt); \
176 	else \
177 		(rt)->rt_refcnt--;
178 
179 #ifdef	GATEWAY
180 #define	RTHASHSIZ	64
181 #else
182 #define	RTHASHSIZ	8
183 #endif
184 #if	(RTHASHSIZ & (RTHASHSIZ - 1)) == 0
185 #define RTHASHMOD(h)	((h) & (RTHASHSIZ - 1))
186 #else
187 #define RTHASHMOD(h)	((h) % RTHASHSIZ)
188 #endif
189 struct	mbuf *rthost[RTHASHSIZ];
190 struct	mbuf *rtnet[RTHASHSIZ];
191 struct	rtstat	rtstat;
192 struct	rtentry *rtalloc1();
193 #endif
194