xref: /freebsd/sys/netinet/ip_var.h (revision 63a938566d524836885917d95bd491aa4400b181)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
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. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)ip_var.h	8.2 (Berkeley) 1/9/95
32  * $FreeBSD$
33  */
34 
35 #ifndef _NETINET_IP_VAR_H_
36 #define	_NETINET_IP_VAR_H_
37 
38 #include <sys/queue.h>
39 
40 /*
41  * Overlay for ip header used by other protocols (tcp, udp).
42  */
43 struct ipovly {
44 	u_char	ih_x1[9];		/* (unused) */
45 	u_char	ih_pr;			/* protocol */
46 	u_short	ih_len;			/* protocol length */
47 	struct	in_addr ih_src;		/* source internet address */
48 	struct	in_addr ih_dst;		/* destination internet address */
49 };
50 
51 #ifdef _KERNEL
52 /*
53  * Ip reassembly queue structure.  Each fragment
54  * being reassembled is attached to one of these structures.
55  * They are timed out after ipq_ttl drops to 0, and may also
56  * be reclaimed if memory becomes tight.
57  */
58 struct ipq {
59 	TAILQ_ENTRY(ipq) ipq_list;	/* to other reass headers */
60 	u_char	ipq_ttl;		/* time for reass q to live */
61 	u_char	ipq_p;			/* protocol of this fragment */
62 	u_short	ipq_id;			/* sequence id for reassembly */
63 	struct mbuf *ipq_frags;		/* to ip headers of fragments */
64 	struct	in_addr ipq_src,ipq_dst;
65 	u_char	ipq_nfrags;		/* # frags in this packet */
66 	struct label *ipq_label;	/* MAC label */
67 };
68 #endif /* _KERNEL */
69 
70 /*
71  * Structure stored in mbuf in inpcb.ip_options
72  * and passed to ip_output when ip options are in use.
73  * The actual length of the options (including ipopt_dst)
74  * is in m_len.
75  */
76 #define MAX_IPOPTLEN	40
77 
78 struct ipoption {
79 	struct	in_addr ipopt_dst;	/* first-hop dst if source routed */
80 	char	ipopt_list[MAX_IPOPTLEN];	/* options proper */
81 };
82 
83 /*
84  * Structure attached to inpcb.ip_moptions and
85  * passed to ip_output when IP multicast options are in use.
86  * This structure is lazy-allocated.
87  */
88 struct ip_moptions {
89 	struct	ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
90 	struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
91 	u_long	imo_multicast_vif;	/* vif num outgoing multicasts */
92 	u_char	imo_multicast_ttl;	/* TTL for outgoing multicasts */
93 	u_char	imo_multicast_loop;	/* 1 => hear sends if a member */
94 	u_short	imo_num_memberships;	/* no. memberships this socket */
95 	u_short	imo_max_memberships;	/* max memberships this socket */
96 	struct	in_multi **imo_membership;	/* group memberships */
97 	struct	in_mfilter *imo_mfilters;	/* source filters */
98 	STAILQ_ENTRY(ip_moptions) imo_link;
99 };
100 
101 struct	ipstat {
102 	uint64_t ips_total;		/* total packets received */
103 	uint64_t ips_badsum;		/* checksum bad */
104 	uint64_t ips_tooshort;		/* packet too short */
105 	uint64_t ips_toosmall;		/* not enough data */
106 	uint64_t ips_badhlen;		/* ip header length < data size */
107 	uint64_t ips_badlen;		/* ip length < ip header length */
108 	uint64_t ips_fragments;		/* fragments received */
109 	uint64_t ips_fragdropped;	/* frags dropped (dups, out of space) */
110 	uint64_t ips_fragtimeout;	/* fragments timed out */
111 	uint64_t ips_forward;		/* packets forwarded */
112 	uint64_t ips_fastforward;	/* packets fast forwarded */
113 	uint64_t ips_cantforward;	/* packets rcvd for unreachable dest */
114 	uint64_t ips_redirectsent;	/* packets forwarded on same net */
115 	uint64_t ips_noproto;		/* unknown or unsupported protocol */
116 	uint64_t ips_delivered;		/* datagrams delivered to upper level*/
117 	uint64_t ips_localout;		/* total ip packets generated here */
118 	uint64_t ips_odropped;		/* lost packets due to nobufs, etc. */
119 	uint64_t ips_reassembled;	/* total packets reassembled ok */
120 	uint64_t ips_fragmented;	/* datagrams successfully fragmented */
121 	uint64_t ips_ofragments;	/* output fragments created */
122 	uint64_t ips_cantfrag;		/* don't fragment flag was set, etc. */
123 	uint64_t ips_badoptions;		/* error in option processing */
124 	uint64_t ips_noroute;		/* packets discarded due to no route */
125 	uint64_t ips_badvers;		/* ip version != 4 */
126 	uint64_t ips_rawout;		/* total raw ip packets generated */
127 	uint64_t ips_toolong;		/* ip length > max ip packet size */
128 	uint64_t ips_notmember;		/* multicasts for unregistered grps */
129 	uint64_t ips_nogif;		/* no match gif found */
130 	uint64_t ips_badaddr;		/* invalid address on header */
131 };
132 
133 #ifdef _KERNEL
134 
135 #include <sys/counter.h>
136 #include <net/vnet.h>
137 
138 VNET_PCPUSTAT_DECLARE(struct ipstat, ipstat);
139 /*
140  * In-kernel consumers can use these accessor macros directly to update
141  * stats.
142  */
143 #define	IPSTAT_ADD(name, val)	\
144     VNET_PCPUSTAT_ADD(struct ipstat, ipstat, name, (val))
145 #define	IPSTAT_SUB(name, val)	IPSTAT_ADD(name, -(val))
146 #define	IPSTAT_INC(name)	IPSTAT_ADD(name, 1)
147 #define	IPSTAT_DEC(name)	IPSTAT_SUB(name, 1)
148 
149 /*
150  * Kernel module consumers must use this accessor macro.
151  */
152 void	kmod_ipstat_inc(int statnum);
153 #define	KMOD_IPSTAT_INC(name)	\
154     kmod_ipstat_inc(offsetof(struct ipstat, name) / sizeof(uint64_t))
155 void	kmod_ipstat_dec(int statnum);
156 #define	KMOD_IPSTAT_DEC(name)	\
157     kmod_ipstat_dec(offsetof(struct ipstat, name) / sizeof(uint64_t))
158 
159 /* flags passed to ip_output as last parameter */
160 #define	IP_FORWARDING		0x1		/* most of ip header exists */
161 #define	IP_RAWOUTPUT		0x2		/* raw ip header exists */
162 #define	IP_SENDONES		0x4		/* send all-ones broadcast */
163 #define	IP_SENDTOIF		0x8		/* send on specific ifnet */
164 #define IP_ROUTETOIF		SO_DONTROUTE	/* 0x10 bypass routing tables */
165 #define IP_ALLOWBROADCAST	SO_BROADCAST	/* 0x20 can send broadcast packets */
166 #define	IP_NODEFAULTFLOWID	0x40		/* Don't set the flowid from inp */
167 
168 #ifdef __NO_STRICT_ALIGNMENT
169 #define IP_HDR_ALIGNED_P(ip)	1
170 #else
171 #define IP_HDR_ALIGNED_P(ip)	((((intptr_t) (ip)) & 3) == 0)
172 #endif
173 
174 struct ip;
175 struct inpcb;
176 struct route;
177 struct sockopt;
178 
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 extern u_char	ip_protox[];
185 VNET_DECLARE(struct socket *, ip_rsvpd);	/* reservation protocol daemon*/
186 VNET_DECLARE(struct socket *, ip_mrouter);	/* multicast routing daemon */
187 extern int	(*legal_vif_num)(int);
188 extern u_long	(*ip_mcast_src)(int);
189 VNET_DECLARE(int, rsvp_on);
190 VNET_DECLARE(int, drop_redirect);
191 extern struct	pr_usrreqs rip_usrreqs;
192 
193 #define	V_ip_id			VNET(ip_id)
194 #define	V_ip_defttl		VNET(ip_defttl)
195 #define	V_ipforwarding		VNET(ipforwarding)
196 #ifdef IPSTEALTH
197 #define	V_ipstealth		VNET(ipstealth)
198 #endif
199 #define	V_ip_rsvpd		VNET(ip_rsvpd)
200 #define	V_ip_mrouter		VNET(ip_mrouter)
201 #define	V_rsvp_on		VNET(rsvp_on)
202 #define	V_drop_redirect		VNET(drop_redirect)
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 int	ip_fragment(struct ip *ip, struct mbuf **m_frag, int mtu,
211 	    u_long if_hwassist_flags);
212 void	ip_forward(struct mbuf *m, int srcrt);
213 void	ip_init(void);
214 extern int
215 	(*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
216 	    struct ip_moptions *);
217 int	ip_output(struct mbuf *,
218 	    struct mbuf *, struct route *, int, struct ip_moptions *,
219 	    struct inpcb *);
220 int	ipproto_register(short);
221 int	ipproto_unregister(short);
222 struct mbuf *
223 	ip_reass(struct mbuf *);
224 void	ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
225 	    struct mbuf *);
226 void	ip_slowtimo(void);
227 void	ip_fillid(struct ip *);
228 int	rip_ctloutput(struct socket *, struct sockopt *);
229 void	rip_ctlinput(int, struct sockaddr *, void *);
230 void	rip_init(void);
231 int	rip_input(struct mbuf **, int *, int);
232 int	rip_output(struct mbuf *, struct socket *, ...);
233 int	ipip_input(struct mbuf **, int *, int);
234 int	rsvp_input(struct mbuf **, int *, int);
235 int	ip_rsvp_init(struct socket *);
236 int	ip_rsvp_done(void);
237 extern int	(*ip_rsvp_vif)(struct socket *, struct sockopt *);
238 extern void	(*ip_rsvp_force_done)(struct socket *);
239 extern int	(*rsvp_input_p)(struct mbuf **, int *, int);
240 
241 VNET_DECLARE(struct pfil_head, inet_pfil_hook);	/* packet filter hooks */
242 #define	V_inet_pfil_hook	VNET(inet_pfil_hook)
243 
244 void	in_delayed_cksum(struct mbuf *m);
245 
246 /* Hooks for ipfw, dummynet, divert etc. Most are declared in raw_ip.c */
247 /*
248  * Reference to an ipfw or packet filter rule that can be carried
249  * outside critical sections.
250  * A rule is identified by rulenum:rule_id which is ordered.
251  * In version chain_id the rule can be found in slot 'slot', so
252  * we don't need a lookup if chain_id == chain->id.
253  *
254  * On exit from the firewall this structure refers to the rule after
255  * the matching one (slot points to the new rule; rulenum:rule_id-1
256  * is the matching rule), and additional info (e.g. info often contains
257  * the insn argument or tablearg in the low 16 bits, in host format).
258  * On entry, the structure is valid if slot>0, and refers to the starting
259  * rules. 'info' contains the reason for reinject, e.g. divert port,
260  * divert direction, and so on.
261  */
262 struct ipfw_rule_ref {
263 	uint32_t	slot;		/* slot for matching rule	*/
264 	uint32_t	rulenum;	/* matching rule number		*/
265 	uint32_t	rule_id;	/* matching rule id		*/
266 	uint32_t	chain_id;	/* ruleset id			*/
267 	uint32_t	info;		/* see below			*/
268 };
269 
270 enum {
271 	IPFW_INFO_MASK	= 0x0000ffff,
272 	IPFW_INFO_OUT	= 0x00000000,	/* outgoing, just for convenience */
273 	IPFW_INFO_IN	= 0x80000000,	/* incoming, overloads dir */
274 	IPFW_ONEPASS	= 0x40000000,	/* One-pass, do not reinject */
275 	IPFW_IS_MASK	= 0x30000000,	/* which source ? */
276 	IPFW_IS_DIVERT	= 0x20000000,
277 	IPFW_IS_DUMMYNET =0x10000000,
278 	IPFW_IS_PIPE	= 0x08000000,	/* pipe=1, queue = 0 */
279 };
280 #define MTAG_IPFW	1148380143	/* IPFW-tagged cookie */
281 #define MTAG_IPFW_RULE	1262273568	/* rule reference */
282 #define	MTAG_IPFW_CALL	1308397630	/* call stack */
283 
284 struct ip_fw_args;
285 typedef int	(*ip_fw_chk_ptr_t)(struct ip_fw_args *args);
286 typedef int	(*ip_fw_ctl_ptr_t)(struct sockopt *);
287 VNET_DECLARE(ip_fw_ctl_ptr_t, ip_fw_ctl_ptr);
288 #define	V_ip_fw_ctl_ptr		VNET(ip_fw_ctl_ptr)
289 
290 /* Divert hooks. */
291 extern void	(*ip_divert_ptr)(struct mbuf *m, int incoming);
292 /* ng_ipfw hooks -- XXX make it the same as divert and dummynet */
293 extern int	(*ng_ipfw_input_p)(struct mbuf **, int,
294 			struct ip_fw_args *, int);
295 
296 extern int	(*ip_dn_ctl_ptr)(struct sockopt *);
297 extern int	(*ip_dn_io_ptr)(struct mbuf **, int, struct ip_fw_args *);
298 #endif /* _KERNEL */
299 
300 #endif /* !_NETINET_IP_VAR_H_ */
301