xref: /freebsd/sys/netinet/ip_var.h (revision 830940567b49bb0c08dfaed40418999e76616909)
1 /*-
2  * Copyright (c) 1982, 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  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)ip_var.h	8.2 (Berkeley) 1/9/95
30  * $FreeBSD$
31  */
32 
33 #ifndef _NETINET_IP_VAR_H_
34 #define	_NETINET_IP_VAR_H_
35 
36 #include <sys/queue.h>
37 
38 /*
39  * Overlay for ip header used by other protocols (tcp, udp).
40  */
41 struct ipovly {
42 	u_char	ih_x1[9];		/* (unused) */
43 	u_char	ih_pr;			/* protocol */
44 	u_short	ih_len;			/* protocol length */
45 	struct	in_addr ih_src;		/* source internet address */
46 	struct	in_addr ih_dst;		/* destination internet address */
47 };
48 
49 #ifdef _KERNEL
50 /*
51  * Ip reassembly queue structure.  Each fragment
52  * being reassembled is attached to one of these structures.
53  * They are timed out after ipq_ttl drops to 0, and may also
54  * be reclaimed if memory becomes tight.
55  */
56 struct ipq {
57 	TAILQ_ENTRY(ipq) ipq_list;	/* to other reass headers */
58 	u_char	ipq_ttl;		/* time for reass q to live */
59 	u_char	ipq_p;			/* protocol of this fragment */
60 	u_short	ipq_id;			/* sequence id for reassembly */
61 	struct mbuf *ipq_frags;		/* to ip headers of fragments */
62 	struct	in_addr ipq_src,ipq_dst;
63 	u_char	ipq_nfrags;		/* # frags in this packet */
64 	struct label *ipq_label;	/* MAC label */
65 };
66 #endif /* _KERNEL */
67 
68 /*
69  * Structure stored in mbuf in inpcb.ip_options
70  * and passed to ip_output when ip options are in use.
71  * The actual length of the options (including ipopt_dst)
72  * is in m_len.
73  */
74 #define MAX_IPOPTLEN	40
75 
76 struct ipoption {
77 	struct	in_addr ipopt_dst;	/* first-hop dst if source routed */
78 	char	ipopt_list[MAX_IPOPTLEN];	/* options proper */
79 };
80 
81 /*
82  * Structure attached to inpcb.ip_moptions and
83  * passed to ip_output when IP multicast options are in use.
84  * This structure is lazy-allocated.
85  */
86 struct ip_moptions {
87 	struct	ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
88 	struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
89 	u_long	imo_multicast_vif;	/* vif num outgoing multicasts */
90 	u_char	imo_multicast_ttl;	/* TTL for outgoing multicasts */
91 	u_char	imo_multicast_loop;	/* 1 => hear sends if a member */
92 	u_short	imo_num_memberships;	/* no. memberships this socket */
93 	u_short	imo_max_memberships;	/* max memberships this socket */
94 	struct	in_multi **imo_membership;	/* group memberships */
95 	struct	in_mfilter *imo_mfilters;	/* source filters */
96 };
97 
98 struct	ipstat {
99 	u_long	ips_total;		/* total packets received */
100 	u_long	ips_badsum;		/* checksum bad */
101 	u_long	ips_tooshort;		/* packet too short */
102 	u_long	ips_toosmall;		/* not enough data */
103 	u_long	ips_badhlen;		/* ip header length < data size */
104 	u_long	ips_badlen;		/* ip length < ip header length */
105 	u_long	ips_fragments;		/* fragments received */
106 	u_long	ips_fragdropped;	/* frags dropped (dups, out of space) */
107 	u_long	ips_fragtimeout;	/* fragments timed out */
108 	u_long	ips_forward;		/* packets forwarded */
109 	u_long	ips_fastforward;	/* packets fast forwarded */
110 	u_long	ips_cantforward;	/* packets rcvd for unreachable dest */
111 	u_long	ips_redirectsent;	/* packets forwarded on same net */
112 	u_long	ips_noproto;		/* unknown or unsupported protocol */
113 	u_long	ips_delivered;		/* datagrams delivered to upper level*/
114 	u_long	ips_localout;		/* total ip packets generated here */
115 	u_long	ips_odropped;		/* lost packets due to nobufs, etc. */
116 	u_long	ips_reassembled;	/* total packets reassembled ok */
117 	u_long	ips_fragmented;		/* datagrams successfully fragmented */
118 	u_long	ips_ofragments;		/* output fragments created */
119 	u_long	ips_cantfrag;		/* don't fragment flag was set, etc. */
120 	u_long	ips_badoptions;		/* error in option processing */
121 	u_long	ips_noroute;		/* packets discarded due to no route */
122 	u_long	ips_badvers;		/* ip version != 4 */
123 	u_long	ips_rawout;		/* total raw ip packets generated */
124 	u_long	ips_toolong;		/* ip length > max ip packet size */
125 	u_long	ips_notmember;		/* multicasts for unregistered grps */
126 	u_long	ips_nogif;		/* no match gif found */
127 	u_long	ips_badaddr;		/* invalid address on header */
128 };
129 
130 #ifdef _KERNEL
131 
132 #include <net/vnet.h>
133 
134 /*
135  * In-kernel consumers can use these accessor macros directly to update
136  * stats.
137  */
138 #define	IPSTAT_ADD(name, val)	V_ipstat.name += (val)
139 #define	IPSTAT_SUB(name, val)	V_ipstat.name -= (val)
140 #define	IPSTAT_INC(name)	IPSTAT_ADD(name, 1)
141 #define	IPSTAT_DEC(name)	IPSTAT_SUB(name, 1)
142 
143 /*
144  * Kernel module consumers must use this accessor macro.
145  */
146 void	kmod_ipstat_inc(int statnum);
147 #define	KMOD_IPSTAT_INC(name)						\
148 	kmod_ipstat_inc(offsetof(struct ipstat, name) / sizeof(u_long))
149 void	kmod_ipstat_dec(int statnum);
150 #define	KMOD_IPSTAT_DEC(name)						\
151 	kmod_ipstat_dec(offsetof(struct ipstat, name) / sizeof(u_long))
152 
153 /* flags passed to ip_output as last parameter */
154 #define	IP_FORWARDING		0x1		/* most of ip header exists */
155 #define	IP_RAWOUTPUT		0x2		/* raw ip header exists */
156 #define	IP_SENDONES		0x4		/* send all-ones broadcast */
157 #define	IP_SENDTOIF		0x8		/* send on specific ifnet */
158 #define IP_ROUTETOIF		SO_DONTROUTE	/* 0x10 bypass routing tables */
159 #define IP_ALLOWBROADCAST	SO_BROADCAST	/* 0x20 can send broadcast packets */
160 
161 /*
162  * mbuf flag used by ip_fastfwd
163  */
164 #define	M_FASTFWD_OURS		M_PROTO1	/* changed dst to local */
165 
166 #ifdef __NO_STRICT_ALIGNMENT
167 #define IP_HDR_ALIGNED_P(ip)	1
168 #else
169 #define IP_HDR_ALIGNED_P(ip)	((((intptr_t) (ip)) & 3) == 0)
170 #endif
171 
172 struct ip;
173 struct inpcb;
174 struct route;
175 struct sockopt;
176 
177 VNET_DECLARE(struct ipstat, ipstat);
178 VNET_DECLARE(u_short, ip_id);			/* ip packet ctr, for ids */
179 VNET_DECLARE(int, ip_defttl);			/* default IP ttl */
180 VNET_DECLARE(int, ipforwarding);		/* ip forwarding */
181 #ifdef IPSTEALTH
182 VNET_DECLARE(int, ipstealth);			/* stealth forwarding */
183 #endif
184 VNET_DECLARE(int, rsvp_on);
185 VNET_DECLARE(struct socket *, ip_rsvpd);	/* reservation protocol daemon*/
186 VNET_DECLARE(struct socket *, ip_mrouter);	/* multicast routing daemon */
187 
188 #define	V_ipstat		VNET(ipstat)
189 #define	V_ip_id			VNET(ip_id)
190 #define	V_ip_defttl		VNET(ip_defttl)
191 #define	V_ipforwarding		VNET(ipforwarding)
192 #ifdef IPSTEALTH
193 #define	V_ipstealth		VNET(ipstealth)
194 #endif
195 #define	V_rsvp_on		VNET(rsvp_on)
196 #define	V_ip_rsvpd		VNET(ip_rsvpd)
197 #define	V_ip_mrouter		VNET(ip_mrouter)
198 
199 extern u_char	ip_protox[];
200 extern int	(*legal_vif_num)(int);
201 extern u_long	(*ip_mcast_src)(int);
202 extern struct	pr_usrreqs rip_usrreqs;
203 
204 void	inp_freemoptions(struct ip_moptions *);
205 int	inp_getmoptions(struct inpcb *, struct sockopt *);
206 int	inp_setmoptions(struct inpcb *, struct sockopt *);
207 
208 int	ip_ctloutput(struct socket *, struct sockopt *sopt);
209 void	ip_drain(void);
210 void	ip_fini(void *xtp);
211 int	ip_fragment(struct ip *ip, struct mbuf **m_frag, int mtu,
212 	    u_long if_hwassist_flags, int sw_csum);
213 void	ip_forward(struct mbuf *m, int srcrt);
214 void	ip_init(void);
215 extern int
216 	(*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
217 	    struct ip_moptions *);
218 int	ip_output(struct mbuf *,
219 	    struct mbuf *, struct route *, int, struct ip_moptions *,
220 	    struct inpcb *);
221 int	ipproto_register(u_char);
222 int	ipproto_unregister(u_char);
223 struct mbuf *
224 	ip_reass(struct mbuf *);
225 struct in_ifaddr *
226 	ip_rtaddr(struct in_addr, u_int fibnum);
227 void	ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
228 	    struct mbuf *);
229 void	ip_slowtimo(void);
230 u_int16_t	ip_randomid(void);
231 int	rip_ctloutput(struct socket *, struct sockopt *);
232 void	rip_ctlinput(int, struct sockaddr *, void *);
233 void	rip_init(void);
234 #ifdef VIMAGE
235 void	rip_destroy(void);
236 #endif
237 void	rip_input(struct mbuf *, int);
238 int	rip_output(struct mbuf *, struct socket *, u_long);
239 void	ipip_input(struct mbuf *, int);
240 void	rsvp_input(struct mbuf *, int);
241 int	ip_rsvp_init(struct socket *);
242 int	ip_rsvp_done(void);
243 extern int	(*ip_rsvp_vif)(struct socket *, struct sockopt *);
244 extern void	(*ip_rsvp_force_done)(struct socket *);
245 extern void	(*rsvp_input_p)(struct mbuf *m, int off);
246 
247 extern	struct pfil_head inet_pfil_hook;	/* packet filter hooks */
248 
249 void	in_delayed_cksum(struct mbuf *m);
250 
251 /* ipfw and dummynet hooks. Most are declared in raw_ip.c */
252 struct ip_fw_args;
253 extern int	(*ip_fw_chk_ptr)(struct ip_fw_args *args);
254 extern int	(*ip_fw_ctl_ptr)(struct sockopt *);
255 extern int	(*ip_dn_ctl_ptr)(struct sockopt *);
256 extern int	(*ip_dn_io_ptr)(struct mbuf **m, int dir, struct ip_fw_args *fwa);
257 extern void	(*ip_dn_ruledel_ptr)(void *);		/* in ip_fw2.c */
258 
259 VNET_DECLARE(int, ip_do_randomid);
260 #define	V_ip_do_randomid	VNET(ip_do_randomid)
261 #define	ip_newid()	((V_ip_do_randomid != 0) ? ip_randomid() : \
262 			    htons(V_ip_id++))
263 
264 #endif /* _KERNEL */
265 
266 #endif /* !_NETINET_IP_VAR_H_ */
267