xref: /openbsd/sys/netinet/ip_var.h (revision 4c2e8f66)
1 /*	$OpenBSD: ip_var.h,v 1.120 2024/07/12 19:50:35 bluhm 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  */
49 struct 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 
57 struct	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_rtcachehit;		/* valid route found in cache */
91 	u_long	ips_rtcachemiss;	/* route cache with new destination */
92 	u_long	ips_wrongif;		/* packet received on wrong interface */
93 	u_long	ips_idropped;		/* lost input due to nobufs, etc. */
94 };
95 
96 struct ipoption {
97 	struct	in_addr ipopt_dst;	/* first-hop dst if source routed */
98 	int8_t	ipopt_list[MAX_IPOPTLEN];	/* options proper */
99 };
100 
101 #ifdef _KERNEL
102 
103 #include <sys/percpu.h>
104 
105 enum ipstat_counters {
106 	ips_total,		/* total packets received */
107 	ips_badsum,		/* checksum bad */
108 	ips_tooshort,		/* packet too short */
109 	ips_toosmall,		/* not enough data */
110 	ips_badhlen,		/* ip header length < data size */
111 	ips_badlen,		/* ip length < ip header length */
112 	ips_fragments,		/* fragments received */
113 	ips_fragdropped,	/* frags dropped (dups, out of space) */
114 	ips_fragtimeout,	/* fragments timed out */
115 	ips_forward,		/* packets forwarded */
116 	ips_cantforward,	/* packets rcvd for unreachable dest */
117 	ips_redirectsent,	/* packets forwarded on same net */
118 	ips_noproto,		/* unknown or unsupported protocol */
119 	ips_delivered,		/* datagrams delivered to upper level*/
120 	ips_localout,		/* total ip packets generated here */
121 	ips_odropped,		/* lost output packets due to nobufs, etc. */
122 	ips_reassembled,	/* total packets reassembled ok */
123 	ips_fragmented,		/* datagrams successfully fragmented */
124 	ips_ofragments,		/* output fragments created */
125 	ips_cantfrag,		/* don't fragment flag was set, etc. */
126 	ips_badoptions,		/* error in option processing */
127 	ips_noroute,		/* packets discarded due to no route */
128 	ips_badvers,		/* ip version != 4 */
129 	ips_rawout,		/* total raw ip packets generated */
130 	ips_badfrags,		/* malformed fragments (bad length) */
131 	ips_rcvmemdrop,		/* frags dropped for lack of memory */
132 	ips_toolong,		/* ip length > max ip packet size */
133 	ips_nogif,		/* no match gif found */
134 	ips_badaddr,		/* invalid address on header */
135 	ips_inswcsum,		/* software checksummed on input */
136 	ips_outswcsum,		/* software checksummed on output */
137 	ips_notmember,		/* multicasts for unregistered groups */
138 	ips_rtcachehit,		/* valid route to destination found in cache */
139 	ips_rtcachemiss,	/* route cache filled with new destination */
140 	ips_wrongif,		/* packet received on wrong interface */
141 	ips_idropped,		/* lost input packets due to nobufs, etc. */
142 
143 	ips_ncounters
144 };
145 
146 extern struct cpumem *ipcounters;
147 
148 static inline void
ipstat_inc(enum ipstat_counters c)149 ipstat_inc(enum ipstat_counters c)
150 {
151 	counters_inc(ipcounters, c);
152 }
153 
154 static inline void
ipstat_add(enum ipstat_counters c,uint64_t v)155 ipstat_add(enum ipstat_counters c, uint64_t v)
156 {
157 	counters_add(ipcounters, c, v);
158 }
159 
160 /*
161  * Structure attached to inpcb.ip_moptions and
162  * passed to ip_output when IP multicast options are in use.
163  */
164 struct ip_moptions {
165 	struct in_multi **imo_membership; /* group memberships */
166 	unsigned short imo_ifidx;	/* ifp index for outgoing multicasts */
167 	u_int8_t  imo_ttl;	/* TTL for outgoing multicasts */
168 	u_int8_t  imo_loop;	/* 1 => hear sends if a member */
169 	u_int16_t imo_num_memberships;	/* no. memberships this socket */
170 	u_int16_t imo_max_memberships;	/* max memberships this socket */
171 };
172 
173 #include <sys/queue.h>
174 
175 /*
176  * Ip reassembly queue structures.
177  */
178 LIST_HEAD(ipqehead, ipqent);
179 struct ipqent {
180 	LIST_ENTRY(ipqent) ipqe_q;
181 	struct ip	*ipqe_ip;
182 	struct mbuf	*ipqe_m;	/* mbuf contains packet */
183 	uint16_t	 ipqe_mff;	/* for IP fragmentation */
184 };
185 
186 /*
187  * Ip reassembly queue structure.  Each fragment
188  * being reassembled is attached to one of these structures.
189  * They are timed out after ipq_ttl drops to 0, and may also
190  * be reclaimed if memory becomes tight.
191  */
192 struct ipq {
193 	LIST_ENTRY(ipq) ipq_q;		/* to other reass headers */
194 	u_int8_t  ipq_ttl;		/* time for reass q to live */
195 	u_int8_t  ipq_p;		/* protocol of this fragment */
196 	u_int16_t ipq_id;		/* sequence id for reassembly */
197 	struct	  ipqehead ipq_fragq;	/* to ip fragment queue */
198 	struct	  in_addr ipq_src, ipq_dst;
199 };
200 
201 struct ipoffnxt {
202 	int	ion_off;
203 	int	ion_nxt;
204 };
205 
206 /* flags passed to ip_output */
207 #define IP_FORWARDING		0x0001	/* most of ip header exists */
208 #define IP_RAWOUTPUT		0x0002	/* raw ip header exists */
209 #define IP_REDIRECT		0x0004	/* redirected by pf or source route */
210 #define IP_FORWARDING_IPSEC	0x0008	/* only packets processed by IPsec */
211 #define IP_ALLOWBROADCAST	SO_BROADCAST	/* can send broadcast packets */
212 #define IP_MTUDISC		0x0800	/* pmtu discovery, set DF */
213 
214 extern struct ipstat ipstat;
215 extern int ip_defttl;			/* default IP ttl */
216 
217 #define IPMTUDISCTIMEOUT (10 * 60)	/* as per RFC 1191 */
218 
219 extern int ip_mtudisc;			/* mtu discovery */
220 extern int ip_mtudisc_timeout;		/* seconds to timeout mtu discovery */
221 
222 extern int ipport_firstauto;		/* min port for port allocation */
223 extern int ipport_lastauto;		/* max port for port allocation */
224 extern int ipport_hifirstauto;		/* min dynamic/private port number */
225 extern int ipport_hilastauto;		/* max dynamic/private port number */
226 extern int ip_forwarding;		/* enable IP forwarding */
227 #ifdef MROUTING
228 extern int ipmforwarding;		/* enable multicast forwarding */
229 #endif
230 extern int ipmultipath;			/* enable multipath routing */
231 extern int ip_directedbcast;		/* accept all broadcast packets */
232 extern unsigned int la_hold_total;
233 
234 extern const struct pr_usrreqs rip_usrreqs;
235 
236 extern struct rttimer_queue ip_mtudisc_timeout_q;
237 extern struct pool ipqent_pool;
238 struct rtentry;
239 struct route;
240 struct inpcb;
241 struct ipsec_level;
242 
243 int	 ip_ctloutput(int, struct socket *, int, int, struct mbuf *);
244 int	 ip_fragment(struct mbuf *, struct mbuf_list *, struct ifnet *, u_long);
245 void	 ip_freemoptions(struct ip_moptions *);
246 int	 ip_getmoptions(int, struct ip_moptions *, struct mbuf *);
247 void	 ip_init(void);
248 struct mbuf*
249 	 ip_insertoptions(struct mbuf *, struct mbuf *, int *);
250 int	 ip_mforward(struct mbuf *, struct ifnet *, int);
251 int	 ip_optcopy(struct ip *, struct ip *);
252 int	 ip_output(struct mbuf *, struct mbuf *, struct route *, int,
253 	    struct ip_moptions *, const struct ipsec_level *, u_int32_t);
254 u_int16_t
255 	 ip_randomid(void);
256 void	 ip_send(struct mbuf *);
257 void	 ip_send_raw(struct mbuf *);
258 void	 ip_slowtimo(void);
259 struct mbuf *
260 	 ip_srcroute(struct mbuf *);
261 void	 ip_stripoptions(struct mbuf *);
262 int	 ip_sysctl(int *, u_int, void *, size_t *, void *, size_t);
263 void	 ip_savecontrol(struct inpcb *, struct mbuf **, struct ip *,
264 	    struct mbuf *);
265 int	 ip_input_if(struct mbuf **, int *, int, int, struct ifnet *);
266 int	 ip_deliver(struct mbuf **, int *, int, int, int);
267 void	 ip_forward(struct mbuf *, struct ifnet *, struct route *, int);
268 int	 rip_ctloutput(int, struct socket *, int, int, struct mbuf *);
269 void	 rip_init(void);
270 int	 rip_input(struct mbuf **, int *, int, int);
271 int	 rip_output(struct mbuf *, struct socket *, struct sockaddr *,
272 	    struct mbuf *);
273 struct mbuf *
274 	 rip_chkhdr(struct mbuf *, struct mbuf *);
275 int	 rip_attach(struct socket *, int, int);
276 int	 rip_detach(struct socket *);
277 int	 rip_bind(struct socket *, struct mbuf *, struct proc *);
278 int	 rip_connect(struct socket *, struct mbuf *);
279 int	 rip_disconnect(struct socket *);
280 int	 rip_shutdown(struct socket *);
281 int	 rip_send(struct socket *, struct mbuf *, struct mbuf *,
282 	     struct mbuf *);
283 #ifdef MROUTING
284 extern struct socket *ip_mrouter[];	/* multicast routing daemon */
285 #endif
286 
287 #endif /* _KERNEL */
288 #endif /* _NETINET_IP_VAR_H_ */
289