ip_var.h revision 1.108
1/*	$OpenBSD: ip_var.h,v 1.108 2022/11/17 18:05:43 mvs Exp $	*/
2/*	$NetBSD: ip_var.h,v 1.16 1996/02/13 23:43:20 christos Exp $	*/
3
4/*
5 * Copyright (c) 1982, 1986, 1993
6 *	The Regents of the University of California.  All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 *	@(#)ip_var.h	8.1 (Berkeley) 6/10/93
33 */
34
35#ifndef _NETINET_IP_VAR_H_
36#define _NETINET_IP_VAR_H_
37
38/*
39 * Structure stored in mbuf in inpcb.ip_options
40 * and passed to ip_output when ip options are in use.
41 * The actual length of the options (including ipopt_dst)
42 * is in m_len.
43 */
44#define	MAX_IPOPTLEN	40
45
46/*
47 * Overlay for ip header used by other protocols (tcp, udp).
48 */
49struct ipovly {
50	u_int8_t  ih_x1[9];		/* (unused) */
51	u_int8_t  ih_pr;		/* protocol */
52	u_int16_t ih_len;		/* protocol length */
53	struct	  in_addr ih_src;	/* source internet address */
54	struct	  in_addr ih_dst;	/* destination internet address */
55};
56
57struct	ipstat {
58	u_long	ips_total;		/* total packets received */
59	u_long	ips_badsum;		/* checksum bad */
60	u_long	ips_tooshort;		/* packet too short */
61	u_long	ips_toosmall;		/* not enough data */
62	u_long	ips_badhlen;		/* ip header length < data size */
63	u_long	ips_badlen;		/* ip length < ip header length */
64	u_long	ips_fragments;		/* fragments received */
65	u_long	ips_fragdropped;	/* frags dropped (dups, out of space) */
66	u_long	ips_fragtimeout;	/* fragments timed out */
67	u_long	ips_forward;		/* packets forwarded */
68	u_long	ips_cantforward;	/* packets rcvd for unreachable dest */
69	u_long	ips_redirectsent;	/* packets forwarded on same net */
70	u_long	ips_noproto;		/* unknown or unsupported protocol */
71	u_long	ips_delivered;		/* datagrams delivered to upper level*/
72	u_long	ips_localout;		/* total ip packets generated here */
73	u_long	ips_odropped;		/* lost output due to nobufs, etc. */
74	u_long	ips_reassembled;	/* total packets reassembled ok */
75	u_long	ips_fragmented;		/* datagrams successfully fragmented */
76	u_long	ips_ofragments;		/* output fragments created */
77	u_long	ips_cantfrag;		/* don't fragment flag was set, etc. */
78	u_long	ips_badoptions;		/* error in option processing */
79	u_long	ips_noroute;		/* packets discarded due to no route */
80	u_long	ips_badvers;		/* ip version != 4 */
81	u_long	ips_rawout;		/* total raw ip packets generated */
82	u_long	ips_badfrags;		/* malformed fragments (bad length) */
83	u_long	ips_rcvmemdrop;		/* frags dropped for lack of memory */
84	u_long	ips_toolong;		/* ip length > max ip packet size */
85	u_long	ips_nogif;		/* no match gif found */
86	u_long	ips_badaddr;		/* invalid address on header */
87	u_long	ips_inswcsum;		/* software checksummed on input */
88	u_long	ips_outswcsum;		/* software checksummed on output */
89	u_long	ips_notmember;		/* multicasts for unregistered groups */
90	u_long	ips_wrongif;		/* packet received on wrong interface */
91	u_long	ips_idropped;		/* lost input due to nobufs, etc. */
92};
93
94struct ipoption {
95	struct	in_addr ipopt_dst;	/* first-hop dst if source routed */
96	int8_t	ipopt_list[MAX_IPOPTLEN];	/* options proper */
97};
98
99#ifdef _KERNEL
100
101#include <sys/percpu.h>
102
103enum ipstat_counters {
104	ips_total,		/* total packets received */
105	ips_badsum,		/* checksum bad */
106	ips_tooshort,		/* packet too short */
107	ips_toosmall,		/* not enough data */
108	ips_badhlen,		/* ip header length < data size */
109	ips_badlen,		/* ip length < ip header length */
110	ips_fragments,		/* fragments received */
111	ips_fragdropped,	/* frags dropped (dups, out of space) */
112	ips_fragtimeout,	/* fragments timed out */
113	ips_forward,		/* packets forwarded */
114	ips_cantforward,	/* packets rcvd for unreachable dest */
115	ips_redirectsent,	/* packets forwarded on same net */
116	ips_noproto,		/* unknown or unsupported protocol */
117	ips_delivered,		/* datagrams delivered to upper level*/
118	ips_localout,		/* total ip packets generated here */
119	ips_odropped,		/* lost output packets due to nobufs, etc. */
120	ips_reassembled,	/* total packets reassembled ok */
121	ips_fragmented,		/* datagrams successfully fragmented */
122	ips_ofragments,		/* output fragments created */
123	ips_cantfrag,		/* don't fragment flag was set, etc. */
124	ips_badoptions,		/* error in option processing */
125	ips_noroute,		/* packets discarded due to no route */
126	ips_badvers,		/* ip version != 4 */
127	ips_rawout,		/* total raw ip packets generated */
128	ips_badfrags,		/* malformed fragments (bad length) */
129	ips_rcvmemdrop,		/* frags dropped for lack of memory */
130	ips_toolong,		/* ip length > max ip packet size */
131	ips_nogif,		/* no match gif found */
132	ips_badaddr,		/* invalid address on header */
133	ips_inswcsum,		/* software checksummed on input */
134	ips_outswcsum,		/* software checksummed on output */
135	ips_notmember,		/* multicasts for unregistered groups */
136	ips_wrongif,		/* packet received on wrong interface */
137	ips_idropped,		/* lost input packets due to nobufs, etc. */
138
139	ips_ncounters
140};
141
142extern struct cpumem *ipcounters;
143
144static inline void
145ipstat_inc(enum ipstat_counters c)
146{
147	counters_inc(ipcounters, c);
148}
149
150static inline void
151ipstat_add(enum ipstat_counters c, uint64_t v)
152{
153	counters_add(ipcounters, c, v);
154}
155
156/*
157 * Structure attached to inpcb.ip_moptions and
158 * passed to ip_output when IP multicast options are in use.
159 */
160struct ip_moptions {
161	struct in_multi **imo_membership; /* group memberships */
162	unsigned short imo_ifidx;	/* ifp index for outgoing multicasts */
163	u_int8_t  imo_ttl;	/* TTL for outgoing multicasts */
164	u_int8_t  imo_loop;	/* 1 => hear sends if a member */
165	u_int16_t imo_num_memberships;	/* no. memberships this socket */
166	u_int16_t imo_max_memberships;	/* max memberships this socket */
167};
168
169#include <sys/queue.h>
170
171/*
172 * Ip reassembly queue structures.
173 */
174LIST_HEAD(ipqehead, ipqent);
175struct ipqent {
176	LIST_ENTRY(ipqent) ipqe_q;
177	struct ip	*ipqe_ip;
178	struct mbuf	*ipqe_m;	/* mbuf contains packet */
179	uint16_t	 ipqe_mff;	/* for IP fragmentation */
180};
181
182/*
183 * Ip reassembly queue structure.  Each fragment
184 * being reassembled is attached to one of these structures.
185 * They are timed out after ipq_ttl drops to 0, and may also
186 * be reclaimed if memory becomes tight.
187 */
188struct ipq {
189	LIST_ENTRY(ipq) ipq_q;		/* to other reass headers */
190	u_int8_t  ipq_ttl;		/* time for reass q to live */
191	u_int8_t  ipq_p;		/* protocol of this fragment */
192	u_int16_t ipq_id;		/* sequence id for reassembly */
193	struct	  ipqehead ipq_fragq;	/* to ip fragment queue */
194	struct	  in_addr ipq_src, ipq_dst;
195};
196
197/* flags passed to ip_output */
198#define	IP_FORWARDING		0x1		/* most of ip header exists */
199#define	IP_RAWOUTPUT		0x2		/* raw ip header exists */
200#define	IP_ALLOWBROADCAST	SO_BROADCAST	/* can send broadcast packets */
201#define	IP_MTUDISC		0x0800		/* pmtu discovery, set DF */
202
203extern struct ipstat ipstat;
204extern int ip_defttl;			/* default IP ttl */
205
206#define IPMTUDISCTIMEOUT (10 * 60)	/* as per RFC 1191 */
207
208extern int ip_mtudisc;			/* mtu discovery */
209extern int ip_mtudisc_timeout;		/* seconds to timeout mtu discovery */
210
211extern int ipport_firstauto;		/* min port for port allocation */
212extern int ipport_lastauto;		/* max port for port allocation */
213extern int ipport_hifirstauto;		/* min dynamic/private port number */
214extern int ipport_hilastauto;		/* max dynamic/private port number */
215extern int ipforwarding;		/* enable IP forwarding */
216#ifdef MROUTING
217extern int ipmforwarding;		/* enable multicast forwarding */
218#endif
219extern int ipmultipath;			/* enable multipath routing */
220extern int la_hold_total;
221
222extern const struct pr_usrreqs rip_usrreqs;
223
224extern struct rttimer_queue ip_mtudisc_timeout_q;
225extern struct pool ipqent_pool;
226struct route;
227struct inpcb;
228
229int	 ip_ctloutput(int, struct socket *, int, int, struct mbuf *);
230int	 ip_fragment(struct mbuf *, struct mbuf_list *, struct ifnet *, u_long);
231void	 ip_freemoptions(struct ip_moptions *);
232int	 ip_getmoptions(int, struct ip_moptions *, struct mbuf *);
233void	 ip_init(void);
234struct mbuf*
235	 ip_insertoptions(struct mbuf *, struct mbuf *, int *);
236int	 ip_mforward(struct mbuf *, struct ifnet *);
237int	 ip_optcopy(struct ip *, struct ip *);
238int	 ip_output(struct mbuf *, struct mbuf *, struct route *, int,
239	    struct ip_moptions *, struct inpcb *, u_int32_t);
240u_int16_t
241	 ip_randomid(void);
242void	 ip_send(struct mbuf *);
243void	 ip_send_raw(struct mbuf *);
244void	 ip_slowtimo(void);
245struct mbuf *
246	 ip_srcroute(struct mbuf *);
247void	 ip_stripoptions(struct mbuf *);
248int	 ip_sysctl(int *, u_int, void *, size_t *, void *, size_t);
249void	 ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
250	    struct mbuf *);
251int	 ip_input_if(struct mbuf **, int *, int, int, struct ifnet *);
252int	 ip_deliver(struct mbuf **, int *, int, int);
253void	 ip_forward(struct mbuf *, struct ifnet *, struct rtentry *, int);
254int	 rip_ctloutput(int, struct socket *, int, int, struct mbuf *);
255void	 rip_init(void);
256int	 rip_input(struct mbuf **, int *, int, int);
257int	 rip_output(struct mbuf *, struct socket *, struct sockaddr *,
258	    struct mbuf *);
259int	 rip_attach(struct socket *, int, int);
260int	 rip_detach(struct socket *);
261void	 rip_lock(struct socket *);
262void	 rip_unlock(struct socket *);
263int	 rip_bind(struct socket *, struct mbuf *, struct proc *);
264int	 rip_connect(struct socket *, struct mbuf *);
265int	 rip_disconnect(struct socket *);
266int	 rip_shutdown(struct socket *);
267int	 rip_send(struct socket *, struct mbuf *, struct mbuf *,
268	     struct mbuf *);
269#ifdef MROUTING
270extern struct socket *ip_mrouter[];	/* multicast routing daemon */
271#endif
272
273#endif /* _KERNEL */
274#endif /* _NETINET_IP_VAR_H_ */
275