xref: /netbsd-src/sys/netinet/ip_var.h (revision 9fbd88883c38d0c0fbfcbe66d76fe6b0fab3f9de)
1 /*	$NetBSD: ip_var.h,v 1.46 2001/12/21 02:51:47 itojun Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1986, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)ip_var.h	8.2 (Berkeley) 1/9/95
36  */
37 
38 #ifndef _NETINET_IP_VAR_H_
39 #define _NETINET_IP_VAR_H_
40 
41 #include <sys/queue.h>
42 #include <net/route.h>
43 
44 /*
45  * Overlay for ip header used by other protocols (tcp, udp).
46  */
47 struct ipovly {
48 	u_int8_t  ih_x1[9];		/* (unused) */
49 	u_int8_t  ih_pr;		/* protocol */
50 	u_int16_t ih_len;		/* protocol length */
51 	struct	  in_addr ih_src;	/* source internet address */
52 	struct	  in_addr ih_dst;	/* destination internet address */
53 } __attribute__((__packed__));
54 
55 /*
56  * Ip (reassembly or sequence) queue structures.
57  *
58  * XXX -- The following explains why the ipqe_m field is here, for TCP's use:
59  * We want to avoid doing m_pullup on incoming packets but that
60  * means avoiding dtom on the tcp reassembly code.  That in turn means
61  * keeping an mbuf pointer in the reassembly queue (since we might
62  * have a cluster).  As a quick hack, the source & destination
63  * port numbers (which are no longer needed once we've located the
64  * tcpcb) are overlayed with an mbuf pointer.
65  */
66 LIST_HEAD(ipqehead, ipqent);
67 struct ipqent {
68 	LIST_ENTRY(ipqent) ipqe_q;
69 	union {
70 		struct ip	*_ip;
71 		struct tcpiphdr *_tcp;
72 	} _ipqe_u1;
73 	struct mbuf	*ipqe_m;	/* mbuf contains packet */
74 	u_int8_t	ipqe_mff;	/* for IP fragmentation */
75 	/*
76 	 * The following are used in TCP reassembly
77 	 */
78 	LIST_ENTRY(ipqent) ipqe_timeq;
79 	u_int32_t ipqe_seq;
80 	u_int32_t ipqe_len;
81 	u_int32_t ipqe_flags;
82 };
83 #define	ipqe_ip		_ipqe_u1._ip
84 #define	ipqe_tcp	_ipqe_u1._tcp
85 
86 /*
87  * Ip reassembly queue structure.  Each fragment
88  * being reassembled is attached to one of these structures.
89  * They are timed out after ipq_ttl drops to 0, and may also
90  * be reclaimed if memory becomes tight.
91  */
92 struct ipq {
93 	LIST_ENTRY(ipq) ipq_q;		/* to other reass headers */
94 	u_int8_t  ipq_ttl;		/* time for reass q to live */
95 	u_int8_t  ipq_p;		/* protocol of this fragment */
96 	u_int16_t ipq_id;		/* sequence id for reassembly */
97 	struct	  ipqehead ipq_fragq;	/* to ip fragment queue */
98 	struct	  in_addr ipq_src, ipq_dst;
99 };
100 
101 /*
102  * Structure stored in mbuf in inpcb.ip_options
103  * and passed to ip_output when ip options are in use.
104  * The actual length of the options (including ipopt_dst)
105  * is in m_len.
106  */
107 #define	MAX_IPOPTLEN	40
108 
109 struct ipoption {
110 	struct	in_addr ipopt_dst;	/* first-hop dst if source routed */
111 	int8_t	ipopt_list[MAX_IPOPTLEN];	/* options proper */
112 };
113 
114 /*
115  * Structure attached to inpcb.ip_moptions and
116  * passed to ip_output when IP multicast options are in use.
117  */
118 struct ip_moptions {
119 	struct	  ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
120 	struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
121 	u_int8_t  imo_multicast_ttl;	/* TTL for outgoing multicasts */
122 	u_int8_t  imo_multicast_loop;	/* 1 => hear sends if a member */
123 	u_int16_t imo_num_memberships;	/* no. memberships this socket */
124 	struct	  in_multi *imo_membership[IP_MAX_MEMBERSHIPS];
125 };
126 
127 struct	ipstat {
128 	u_quad_t ips_total;		/* total packets received */
129 	u_quad_t ips_badsum;		/* checksum bad */
130 	u_quad_t ips_tooshort;		/* packet too short */
131 	u_quad_t ips_toosmall;		/* not enough data */
132 	u_quad_t ips_badhlen;		/* ip header length < data size */
133 	u_quad_t ips_badlen;		/* ip length < ip header length */
134 	u_quad_t ips_fragments;		/* fragments received */
135 	u_quad_t ips_fragdropped;	/* frags dropped (dups, out of space) */
136 	u_quad_t ips_fragtimeout;	/* fragments timed out */
137 	u_quad_t ips_forward;		/* packets forwarded */
138 	u_quad_t ips_fastforward;	/* packets fast forwarded */
139 	u_quad_t ips_cantforward;	/* packets rcvd for unreachable dest */
140 	u_quad_t ips_redirectsent;	/* packets forwarded on same net */
141 	u_quad_t ips_noproto;		/* unknown or unsupported protocol */
142 	u_quad_t ips_delivered;		/* datagrams delivered to upper level*/
143 	u_quad_t ips_localout;		/* total ip packets generated here */
144 	u_quad_t ips_odropped;		/* lost packets due to nobufs, etc. */
145 	u_quad_t ips_reassembled;	/* total packets reassembled ok */
146 	u_quad_t ips_fragmented;	/* datagrams sucessfully fragmented */
147 	u_quad_t ips_ofragments;	/* output fragments created */
148 	u_quad_t ips_cantfrag;		/* don't fragment flag was set, etc. */
149 	u_quad_t ips_badoptions;	/* error in option processing */
150 	u_quad_t ips_noroute;		/* packets discarded due to no route */
151 	u_quad_t ips_badvers;		/* ip version != 4 */
152 	u_quad_t ips_rawout;		/* total raw ip packets generated */
153 	u_quad_t ips_badfrags;		/* malformed fragments (bad length) */
154 	u_quad_t ips_rcvmemdrop;	/* frags dropped for lack of memory */
155 	u_quad_t ips_toolong;		/* ip length > max ip packet size */
156 	u_quad_t ips_nogif;		/* no match gif found */
157 	u_quad_t ips_badaddr;		/* invalid address on header */
158 };
159 
160 #define	IPFLOW_HASHBITS			6 /* should not be a multiple of 8 */
161 struct ipflow {
162 	LIST_ENTRY(ipflow) ipf_list;	/* next in active list */
163 	LIST_ENTRY(ipflow) ipf_hash;	/* next ipflow in bucket */
164 	struct in_addr ipf_dst;		/* destination address */
165 	struct in_addr ipf_src;		/* source address */
166 	u_int8_t ipf_tos;		/* type-of-service */
167 	struct route ipf_ro;		/* associated route entry */
168 	u_long ipf_uses;		/* number of uses in this period */
169 	u_long ipf_last_uses;		/* number of uses in last period */
170 	u_long ipf_dropped;		/* ENOBUFS returned by if_output */
171 	u_long ipf_errors;		/* other errors returned by if_output */
172 	u_int ipf_timer;		/* lifetime timer */
173 	time_t ipf_start;		/* creation time */
174 };
175 
176 #ifdef _KERNEL
177 /* flags passed to ip_output as last parameter */
178 #define	IP_FORWARDING		0x1		/* most of ip header exists */
179 #define	IP_RAWOUTPUT		0x2		/* raw ip header exists */
180 #define	IP_RETURNMTU		0x4		/* pass back mtu on EMSGSIZE */
181 #define	IP_ROUTETOIF		SO_DONTROUTE	/* bypass routing tables */
182 #define	IP_ALLOWBROADCAST	SO_BROADCAST	/* can send broadcast packets */
183 #define	IP_MTUDISC		0x0400		/* Path MTU Discovery; set DF */
184 
185 extern struct ipstat ipstat;		/* ip statistics */
186 extern LIST_HEAD(ipqhead, ipq) ipq;	/* ip reass. queue */
187 extern u_int16_t ip_id;			/* ip packet ctr, for ids */
188 extern int   ip_defttl;			/* default IP ttl */
189 extern int   ipforwarding;		/* ip forwarding */
190 extern int   ip_mtudisc;		/* mtu discovery */
191 extern u_int ip_mtudisc_timeout;	/* seconds to timeout mtu discovery */
192 extern int   anonportmin;		/* minimum ephemeral port */
193 extern int   anonportmax;		/* maximum ephemeral port */
194 extern int   lowportmin;		/* minimum reserved port */
195 extern int   lowportmax;		/* maximum reserved port */
196 extern struct rttimer_queue *ip_mtudisc_timeout_q;
197 #ifdef GATEWAY
198 extern int ip_maxflows;
199 #endif
200 extern struct pool ipqent_pool;
201 struct	 inpcb;
202 
203 int	 ip_ctloutput __P((int, struct socket *, int, int, struct mbuf **));
204 int	 ip_dooptions __P((struct mbuf *));
205 void	 ip_drain __P((void));
206 void	 ip_forward __P((struct mbuf *, int));
207 void	 ip_freef __P((struct ipq *));
208 void	 ip_freemoptions __P((struct ip_moptions *));
209 int	 ip_getmoptions __P((int, struct ip_moptions *, struct mbuf **));
210 void	 ip_init __P((void));
211 int	 ip_optcopy __P((struct ip *, struct ip *));
212 u_int	 ip_optlen __P((struct inpcb *));
213 int	 ip_output __P((struct mbuf *, ...));
214 int	 ip_pcbopts __P((struct mbuf **, struct mbuf *));
215 struct mbuf *
216 	 ip_reass __P((struct ipqent *, struct ipq *));
217 struct in_ifaddr *
218 	 ip_rtaddr __P((struct in_addr));
219 void	 ip_savecontrol __P((struct inpcb *, struct mbuf **, struct ip *,
220 	   struct mbuf *));
221 int	 ip_setmoptions __P((int, struct ip_moptions **, struct mbuf *));
222 void	 ip_slowtimo __P((void));
223 struct mbuf *
224 	 ip_srcroute __P((void));
225 void	 ip_stripoptions __P((struct mbuf *, struct mbuf *));
226 int	 ip_sysctl __P((int *, u_int, void *, size_t *, void *, size_t));
227 void	 ipintr __P((void));
228 void *	 rip_ctlinput __P((int, struct sockaddr *, void *));
229 int	 rip_ctloutput __P((int, struct socket *, int, int, struct mbuf **));
230 void	 rip_init __P((void));
231 void	 rip_input __P((struct mbuf *, ...));
232 int	 rip_output __P((struct mbuf *, ...));
233 int	 rip_usrreq __P((struct socket *,
234 	    int, struct mbuf *, struct mbuf *, struct mbuf *, struct proc *));
235 void	ipflow_init __P((void));
236 struct	ipflow *ipflow_reap __P((int));
237 void	ipflow_create __P((const struct route *, struct mbuf *));
238 void	ipflow_slowtimo __P((void));
239 #endif
240 
241 #endif /* _NETINET_IP_VAR_H_ */
242