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: stable/11/sys/netinet/ip_var.h 341260 2018-11-29 20:38:23Z markj $
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 */
41struct 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 */
56struct 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	int	ipq_maxoff;		/* total length of packet */
62	struct mbuf *ipq_frags;		/* to ip headers of fragments */
63	struct	in_addr ipq_src,ipq_dst;
64	u_char	ipq_nfrags;		/* # frags in this packet */
65	struct label *ipq_label;	/* MAC label */
66};
67#endif /* _KERNEL */
68
69/*
70 * Structure stored in mbuf in inpcb.ip_options
71 * and passed to ip_output when ip options are in use.
72 * The actual length of the options (including ipopt_dst)
73 * is in m_len.
74 */
75#define MAX_IPOPTLEN	40
76
77struct ipoption {
78	struct	in_addr ipopt_dst;	/* first-hop dst if source routed */
79	char	ipopt_list[MAX_IPOPTLEN];	/* options proper */
80};
81
82/*
83 * Structure attached to inpcb.ip_moptions and
84 * passed to ip_output when IP multicast options are in use.
85 * This structure is lazy-allocated.
86 */
87struct ip_moptions {
88	struct	ifnet *imo_multicast_ifp; /* ifp for outgoing multicasts */
89	struct in_addr imo_multicast_addr; /* ifindex/addr on MULTICAST_IF */
90	u_long	imo_multicast_vif;	/* vif num outgoing multicasts */
91	u_char	imo_multicast_ttl;	/* TTL for outgoing multicasts */
92	u_char	imo_multicast_loop;	/* 1 => hear sends if a member */
93	u_short	imo_num_memberships;	/* no. memberships this socket */
94	u_short	imo_max_memberships;	/* max memberships this socket */
95	struct	in_multi **imo_membership;	/* group memberships */
96	struct	in_mfilter *imo_mfilters;	/* source filters */
97	STAILQ_ENTRY(ip_moptions) imo_link;
98};
99
100struct	ipstat {
101	uint64_t ips_total;		/* total packets received */
102	uint64_t ips_badsum;		/* checksum bad */
103	uint64_t ips_tooshort;		/* packet too short */
104	uint64_t ips_toosmall;		/* not enough data */
105	uint64_t ips_badhlen;		/* ip header length < data size */
106	uint64_t ips_badlen;		/* ip length < ip header length */
107	uint64_t ips_fragments;		/* fragments received */
108	uint64_t ips_fragdropped;	/* frags dropped (dups, out of space) */
109	uint64_t ips_fragtimeout;	/* fragments timed out */
110	uint64_t ips_forward;		/* packets forwarded */
111	uint64_t ips_fastforward;	/* packets fast forwarded */
112	uint64_t ips_cantforward;	/* packets rcvd for unreachable dest */
113	uint64_t ips_redirectsent;	/* packets forwarded on same net */
114	uint64_t ips_noproto;		/* unknown or unsupported protocol */
115	uint64_t ips_delivered;		/* datagrams delivered to upper level*/
116	uint64_t ips_localout;		/* total ip packets generated here */
117	uint64_t ips_odropped;		/* lost packets due to nobufs, etc. */
118	uint64_t ips_reassembled;	/* total packets reassembled ok */
119	uint64_t ips_fragmented;	/* datagrams successfully fragmented */
120	uint64_t ips_ofragments;	/* output fragments created */
121	uint64_t ips_cantfrag;		/* don't fragment flag was set, etc. */
122	uint64_t ips_badoptions;		/* error in option processing */
123	uint64_t ips_noroute;		/* packets discarded due to no route */
124	uint64_t ips_badvers;		/* ip version != 4 */
125	uint64_t ips_rawout;		/* total raw ip packets generated */
126	uint64_t ips_toolong;		/* ip length > max ip packet size */
127	uint64_t ips_notmember;		/* multicasts for unregistered grps */
128	uint64_t ips_nogif;		/* no match gif found */
129	uint64_t ips_badaddr;		/* invalid address on header */
130};
131
132#ifdef _KERNEL
133
134#include <sys/counter.h>
135#include <net/vnet.h>
136
137VNET_PCPUSTAT_DECLARE(struct ipstat, ipstat);
138/*
139 * In-kernel consumers can use these accessor macros directly to update
140 * stats.
141 */
142#define	IPSTAT_ADD(name, val)	\
143    VNET_PCPUSTAT_ADD(struct ipstat, ipstat, name, (val))
144#define	IPSTAT_SUB(name, val)	IPSTAT_ADD(name, -(val))
145#define	IPSTAT_INC(name)	IPSTAT_ADD(name, 1)
146#define	IPSTAT_DEC(name)	IPSTAT_SUB(name, 1)
147
148/*
149 * Kernel module consumers must use this accessor macro.
150 */
151void	kmod_ipstat_inc(int statnum);
152#define	KMOD_IPSTAT_INC(name)	\
153    kmod_ipstat_inc(offsetof(struct ipstat, name) / sizeof(uint64_t))
154void	kmod_ipstat_dec(int statnum);
155#define	KMOD_IPSTAT_DEC(name)	\
156    kmod_ipstat_dec(offsetof(struct ipstat, name) / sizeof(uint64_t))
157
158/* flags passed to ip_output as last parameter */
159#define	IP_FORWARDING		0x1		/* most of ip header exists */
160#define	IP_RAWOUTPUT		0x2		/* raw ip header exists */
161#define	IP_SENDONES		0x4		/* send all-ones broadcast */
162#define	IP_SENDTOIF		0x8		/* send on specific ifnet */
163#define IP_ROUTETOIF		SO_DONTROUTE	/* 0x10 bypass routing tables */
164#define IP_ALLOWBROADCAST	SO_BROADCAST	/* 0x20 can send broadcast packets */
165#define	IP_NODEFAULTFLOWID	0x40		/* Don't set the flowid from inp */
166
167#ifdef __NO_STRICT_ALIGNMENT
168#define IP_HDR_ALIGNED_P(ip)	1
169#else
170#define IP_HDR_ALIGNED_P(ip)	((((intptr_t) (ip)) & 3) == 0)
171#endif
172
173struct ip;
174struct inpcb;
175struct route;
176struct sockopt;
177
178VNET_DECLARE(int, ip_defttl);			/* default IP ttl */
179VNET_DECLARE(int, ipforwarding);		/* ip forwarding */
180#ifdef IPSTEALTH
181VNET_DECLARE(int, ipstealth);			/* stealth forwarding */
182#endif
183extern u_char	ip_protox[];
184VNET_DECLARE(struct socket *, ip_rsvpd);	/* reservation protocol daemon*/
185VNET_DECLARE(struct socket *, ip_mrouter);	/* multicast routing daemon */
186extern int	(*legal_vif_num)(int);
187extern u_long	(*ip_mcast_src)(int);
188VNET_DECLARE(int, rsvp_on);
189VNET_DECLARE(int, drop_redirect);
190extern struct	pr_usrreqs rip_usrreqs;
191
192#define	V_ip_id			VNET(ip_id)
193#define	V_ip_defttl		VNET(ip_defttl)
194#define	V_ipforwarding		VNET(ipforwarding)
195#ifdef IPSTEALTH
196#define	V_ipstealth		VNET(ipstealth)
197#endif
198#define	V_ip_rsvpd		VNET(ip_rsvpd)
199#define	V_ip_mrouter		VNET(ip_mrouter)
200#define	V_rsvp_on		VNET(rsvp_on)
201#define	V_drop_redirect		VNET(drop_redirect)
202
203void	inp_freemoptions(struct ip_moptions *);
204int	inp_getmoptions(struct inpcb *, struct sockopt *);
205int	inp_setmoptions(struct inpcb *, struct sockopt *);
206
207int	ip_ctloutput(struct socket *, struct sockopt *sopt);
208void	ip_drain(void);
209int	ip_fragment(struct ip *ip, struct mbuf **m_frag, int mtu,
210	    u_long if_hwassist_flags);
211void	ip_forward(struct mbuf *m, int srcrt);
212void	ip_init(void);
213extern int
214	(*ip_mforward)(struct ip *, struct ifnet *, struct mbuf *,
215	    struct ip_moptions *);
216int	ip_output(struct mbuf *,
217	    struct mbuf *, struct route *, int, struct ip_moptions *,
218	    struct inpcb *);
219int	ipproto_register(short);
220int	ipproto_unregister(short);
221struct mbuf *
222	ip_reass(struct mbuf *);
223void	ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
224	    struct mbuf *);
225void	ip_slowtimo(void);
226void	ip_fillid(struct ip *);
227int	rip_ctloutput(struct socket *, struct sockopt *);
228void	rip_ctlinput(int, struct sockaddr *, void *);
229void	rip_init(void);
230int	rip_input(struct mbuf **, int *, int);
231int	rip_output(struct mbuf *, struct socket *, ...);
232int	ipip_input(struct mbuf **, int *, int);
233int	rsvp_input(struct mbuf **, int *, int);
234int	ip_rsvp_init(struct socket *);
235int	ip_rsvp_done(void);
236extern int	(*ip_rsvp_vif)(struct socket *, struct sockopt *);
237extern void	(*ip_rsvp_force_done)(struct socket *);
238extern int	(*rsvp_input_p)(struct mbuf **, int *, int);
239
240VNET_DECLARE(struct pfil_head, inet_pfil_hook);	/* packet filter hooks */
241#define	V_inet_pfil_hook	VNET(inet_pfil_hook)
242
243void	in_delayed_cksum(struct mbuf *m);
244
245/* Hooks for ipfw, dummynet, divert etc. Most are declared in raw_ip.c */
246/*
247 * Reference to an ipfw or packet filter rule that can be carried
248 * outside critical sections.
249 * A rule is identified by rulenum:rule_id which is ordered.
250 * In version chain_id the rule can be found in slot 'slot', so
251 * we don't need a lookup if chain_id == chain->id.
252 *
253 * On exit from the firewall this structure refers to the rule after
254 * the matching one (slot points to the new rule; rulenum:rule_id-1
255 * is the matching rule), and additional info (e.g. info often contains
256 * the insn argument or tablearg in the low 16 bits, in host format).
257 * On entry, the structure is valid if slot>0, and refers to the starting
258 * rules. 'info' contains the reason for reinject, e.g. divert port,
259 * divert direction, and so on.
260 */
261struct ipfw_rule_ref {
262	uint32_t	slot;		/* slot for matching rule	*/
263	uint32_t	rulenum;	/* matching rule number		*/
264	uint32_t	rule_id;	/* matching rule id		*/
265	uint32_t	chain_id;	/* ruleset id			*/
266	uint32_t	info;		/* see below			*/
267};
268
269enum {
270	IPFW_INFO_MASK	= 0x0000ffff,
271	IPFW_INFO_OUT	= 0x00000000,	/* outgoing, just for convenience */
272	IPFW_INFO_IN	= 0x80000000,	/* incoming, overloads dir */
273	IPFW_ONEPASS	= 0x40000000,	/* One-pass, do not reinject */
274	IPFW_IS_MASK	= 0x30000000,	/* which source ? */
275	IPFW_IS_DIVERT	= 0x20000000,
276	IPFW_IS_DUMMYNET =0x10000000,
277	IPFW_IS_PIPE	= 0x08000000,	/* pipe=1, queue = 0 */
278};
279#define MTAG_IPFW	1148380143	/* IPFW-tagged cookie */
280#define MTAG_IPFW_RULE	1262273568	/* rule reference */
281#define	MTAG_IPFW_CALL	1308397630	/* call stack */
282
283struct ip_fw_args;
284typedef int	(*ip_fw_chk_ptr_t)(struct ip_fw_args *args);
285typedef int	(*ip_fw_ctl_ptr_t)(struct sockopt *);
286VNET_DECLARE(ip_fw_ctl_ptr_t, ip_fw_ctl_ptr);
287#define	V_ip_fw_ctl_ptr		VNET(ip_fw_ctl_ptr)
288
289/* Divert hooks. */
290extern void	(*ip_divert_ptr)(struct mbuf *m, int incoming);
291/* ng_ipfw hooks -- XXX make it the same as divert and dummynet */
292extern int	(*ng_ipfw_input_p)(struct mbuf **, int,
293			struct ip_fw_args *, int);
294
295extern int	(*ip_dn_ctl_ptr)(struct sockopt *);
296extern int	(*ip_dn_io_ptr)(struct mbuf **, int, struct ip_fw_args *);
297#endif /* _KERNEL */
298
299#endif /* !_NETINET_IP_VAR_H_ */
300