xref: /freebsd/sys/netinet/udp_var.h (revision 657729a89dd578d8cfc70d6616f5c65a48a8b33a)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1982, 1986, 1989, 1993
5  *	The Regents of the University of California.
6  * 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  *	@(#)udp_var.h	8.1 (Berkeley) 6/10/93
33  * $FreeBSD$
34  */
35 
36 #ifndef _NETINET_UDP_VAR_H_
37 #define	_NETINET_UDP_VAR_H_
38 
39 #include <sys/types.h>
40 #include <netinet/ip_var.h>
41 #include <netinet/udp.h>
42 
43 /*
44  * UDP kernel structures and variables.
45  */
46 struct udpiphdr {
47 	struct ipovly	ui_i;		/* overlaid ip structure */
48 	struct udphdr	ui_u;		/* udp header */
49 };
50 #define	ui_x1		ui_i.ih_x1
51 #define	ui_v		ui_i.ih_x1[0]
52 #define	ui_pr		ui_i.ih_pr
53 #define	ui_len		ui_i.ih_len
54 #define	ui_src		ui_i.ih_src
55 #define	ui_dst		ui_i.ih_dst
56 #define	ui_sport	ui_u.uh_sport
57 #define	ui_dport	ui_u.uh_dport
58 #define	ui_ulen		ui_u.uh_ulen
59 #define	ui_sum		ui_u.uh_sum
60 
61 struct inpcb;
62 struct mbuf;
63 
64 #ifdef _KERNEL
65 typedef bool	udp_tun_func_t(struct mbuf *, int, struct inpcb *,
66 		    const struct sockaddr *, void *);
67 typedef union {
68 	struct icmp *icmp;
69 	struct ip6ctlparam *ip6cp;
70 } udp_tun_icmp_param_t __attribute__((__transparent_union__));
71 typedef void	udp_tun_icmp_t(udp_tun_icmp_param_t);
72 
73 /*
74  * UDP control block; one per udp.
75  */
76 struct udpcb {
77 	udp_tun_func_t	*u_tun_func;	/* UDP kernel tunneling callback. */
78 	udp_tun_icmp_t  *u_icmp_func;	/* UDP kernel tunneling icmp callback */
79 	u_int		u_flags;	/* Generic UDP flags. */
80 	uint16_t	u_rxcslen;	/* Coverage for incoming datagrams. */
81 	uint16_t	u_txcslen;	/* Coverage for outgoing datagrams. */
82 	void 		*u_tun_ctx;	/* Tunneling callback context. */
83 };
84 
85 #define	intoudpcb(ip)	((struct udpcb *)(ip)->inp_ppcb)
86 #define	sotoudpcb(so)	(intoudpcb(sotoinpcb(so)))
87 #endif
88 
89 				/* IPsec: ESP in UDP tunneling: */
90 #define	UF_ESPINUDP_NON_IKE	0x00000001	/* w/ non-IKE marker .. */
91 	/* .. per draft-ietf-ipsec-nat-t-ike-0[01],
92 	 * and draft-ietf-ipsec-udp-encaps-(00/)01.txt */
93 #define	UF_ESPINUDP		0x00000002	/* w/ non-ESP marker. */
94 
95 struct udpstat {
96 				/* input statistics: */
97 	uint64_t udps_ipackets;		/* total input packets */
98 	uint64_t udps_hdrops;		/* packet shorter than header */
99 	uint64_t udps_badsum;		/* checksum error */
100 	uint64_t udps_nosum;		/* no checksum */
101 	uint64_t udps_badlen;		/* data length larger than packet */
102 	uint64_t udps_noport;		/* no socket on port */
103 	uint64_t udps_noportbcast;	/* of above, arrived as broadcast */
104 	uint64_t udps_fullsock;		/* not delivered, input socket full */
105 	uint64_t udpps_pcbcachemiss;	/* input packets missing pcb cache */
106 	uint64_t udpps_pcbhashmiss;	/* input packets not for hashed pcb */
107 				/* output statistics: */
108 	uint64_t udps_opackets;		/* total output packets */
109 	uint64_t udps_fastout;		/* output packets on fast path */
110 	/* of no socket on port, arrived as multicast */
111 	uint64_t udps_noportmcast;
112 	uint64_t udps_filtermcast;	/* blocked by multicast filter */
113 };
114 
115 #ifdef _KERNEL
116 #include <sys/counter.h>
117 
118 VNET_PCPUSTAT_DECLARE(struct udpstat, udpstat);
119 /*
120  * In-kernel consumers can use these accessor macros directly to update
121  * stats.
122  */
123 #define	UDPSTAT_ADD(name, val)  \
124     VNET_PCPUSTAT_ADD(struct udpstat, udpstat, name, (val))
125 #define	UDPSTAT_INC(name)	UDPSTAT_ADD(name, 1)
126 
127 /*
128  * Kernel module consumers must use this accessor macro.
129  */
130 void	kmod_udpstat_inc(int statnum);
131 #define	KMOD_UDPSTAT_INC(name)	\
132     kmod_udpstat_inc(offsetof(struct udpstat, name) / sizeof(uint64_t))
133 #endif
134 
135 /*
136  * Identifiers for UDP sysctl nodes.
137  */
138 #define	UDPCTL_CHECKSUM		1	/* checksum UDP packets */
139 #define	UDPCTL_STATS		2	/* statistics (read-only) */
140 #define	UDPCTL_MAXDGRAM		3	/* max datagram size */
141 #define	UDPCTL_RECVSPACE	4	/* default receive buffer space */
142 #define	UDPCTL_PCBLIST		5	/* list of PCBs for UDP sockets */
143 
144 #ifdef _KERNEL
145 #include <netinet/in_pcb.h>
146 SYSCTL_DECL(_net_inet_udp);
147 
148 VNET_DECLARE(struct inpcbinfo, udbinfo);
149 VNET_DECLARE(struct inpcbinfo, ulitecbinfo);
150 #define	V_udbinfo		VNET(udbinfo)
151 #define	V_ulitecbinfo		VNET(ulitecbinfo)
152 
153 extern u_long			udp_sendspace;
154 extern u_long			udp_recvspace;
155 VNET_DECLARE(int, udp_cksum);
156 VNET_DECLARE(int, udp_blackhole);
157 VNET_DECLARE(bool, udp_blackhole_local);
158 VNET_DECLARE(int, udp_log_in_vain);
159 #define	V_udp_cksum		VNET(udp_cksum)
160 #define	V_udp_blackhole		VNET(udp_blackhole)
161 #define	V_udp_blackhole_local	VNET(udp_blackhole_local)
162 #define	V_udp_log_in_vain	VNET(udp_log_in_vain)
163 
164 VNET_DECLARE(int, zero_checksum_port);
165 #define	V_zero_checksum_port	VNET(zero_checksum_port)
166 
167 static __inline struct inpcbinfo *
168 udp_get_inpcbinfo(int protocol)
169 {
170 	return (protocol == IPPROTO_UDP) ? &V_udbinfo : &V_ulitecbinfo;
171 }
172 
173 int		udp_newudpcb(struct inpcb *);
174 void		udp_discardcb(struct udpcb *);
175 
176 int		udp_ctloutput(struct socket *, struct sockopt *);
177 void		udplite_input(struct mbuf *, int);
178 struct inpcb	*udp_notify(struct inpcb *inp, int errno);
179 int		udp_shutdown(struct socket *so);
180 
181 int		udp_set_kernel_tunneling(struct socket *so, udp_tun_func_t f,
182 		    udp_tun_icmp_t i, void *ctx);
183 
184 #endif /* _KERNEL */
185 
186 #endif /* _NETINET_UDP_VAR_H_ */
187