xref: /freebsd/sys/netinet/udp_var.h (revision 6e563a1b608438504d963c2d7c70e50d2e75af46)
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 void(*udp_tun_icmp_t)(int, struct sockaddr *, void *, void *);
68 
69 /*
70  * UDP control block; one per udp.
71  */
72 struct udpcb {
73 	udp_tun_func_t	u_tun_func;	/* UDP kernel tunneling callback. */
74 	udp_tun_icmp_t  u_icmp_func;	/* UDP kernel tunneling icmp callback */
75 	u_int		u_flags;	/* Generic UDP flags. */
76 	uint16_t	u_rxcslen;	/* Coverage for incoming datagrams. */
77 	uint16_t	u_txcslen;	/* Coverage for outgoing datagrams. */
78 	void 		*u_tun_ctx;	/* Tunneling callback context. */
79 };
80 
81 #define	intoudpcb(ip)	((struct udpcb *)(ip)->inp_ppcb)
82 #define	sotoudpcb(so)	(intoudpcb(sotoinpcb(so)))
83 #endif
84 
85 				/* IPsec: ESP in UDP tunneling: */
86 #define	UF_ESPINUDP_NON_IKE	0x00000001	/* w/ non-IKE marker .. */
87 	/* .. per draft-ietf-ipsec-nat-t-ike-0[01],
88 	 * and draft-ietf-ipsec-udp-encaps-(00/)01.txt */
89 #define	UF_ESPINUDP		0x00000002	/* w/ non-ESP marker. */
90 
91 struct udpstat {
92 				/* input statistics: */
93 	uint64_t udps_ipackets;		/* total input packets */
94 	uint64_t udps_hdrops;		/* packet shorter than header */
95 	uint64_t udps_badsum;		/* checksum error */
96 	uint64_t udps_nosum;		/* no checksum */
97 	uint64_t udps_badlen;		/* data length larger than packet */
98 	uint64_t udps_noport;		/* no socket on port */
99 	uint64_t udps_noportbcast;	/* of above, arrived as broadcast */
100 	uint64_t udps_fullsock;		/* not delivered, input socket full */
101 	uint64_t udpps_pcbcachemiss;	/* input packets missing pcb cache */
102 	uint64_t udpps_pcbhashmiss;	/* input packets not for hashed pcb */
103 				/* output statistics: */
104 	uint64_t udps_opackets;		/* total output packets */
105 	uint64_t udps_fastout;		/* output packets on fast path */
106 	/* of no socket on port, arrived as multicast */
107 	uint64_t udps_noportmcast;
108 	uint64_t udps_filtermcast;	/* blocked by multicast filter */
109 };
110 
111 #ifdef _KERNEL
112 #include <sys/counter.h>
113 
114 VNET_PCPUSTAT_DECLARE(struct udpstat, udpstat);
115 /*
116  * In-kernel consumers can use these accessor macros directly to update
117  * stats.
118  */
119 #define	UDPSTAT_ADD(name, val)  \
120     VNET_PCPUSTAT_ADD(struct udpstat, udpstat, name, (val))
121 #define	UDPSTAT_INC(name)	UDPSTAT_ADD(name, 1)
122 
123 /*
124  * Kernel module consumers must use this accessor macro.
125  */
126 void	kmod_udpstat_inc(int statnum);
127 #define	KMOD_UDPSTAT_INC(name)	\
128     kmod_udpstat_inc(offsetof(struct udpstat, name) / sizeof(uint64_t))
129 #endif
130 
131 /*
132  * Identifiers for UDP sysctl nodes.
133  */
134 #define	UDPCTL_CHECKSUM		1	/* checksum UDP packets */
135 #define	UDPCTL_STATS		2	/* statistics (read-only) */
136 #define	UDPCTL_MAXDGRAM		3	/* max datagram size */
137 #define	UDPCTL_RECVSPACE	4	/* default receive buffer space */
138 #define	UDPCTL_PCBLIST		5	/* list of PCBs for UDP sockets */
139 
140 #ifdef _KERNEL
141 #include <netinet/in_pcb.h>
142 SYSCTL_DECL(_net_inet_udp);
143 
144 extern struct pr_usrreqs	udp_usrreqs;
145 VNET_DECLARE(struct inpcbinfo, udbinfo);
146 VNET_DECLARE(struct inpcbinfo, ulitecbinfo);
147 #define	V_udbinfo		VNET(udbinfo)
148 #define	V_ulitecbinfo		VNET(ulitecbinfo)
149 
150 extern u_long			udp_sendspace;
151 extern u_long			udp_recvspace;
152 VNET_DECLARE(int, udp_cksum);
153 VNET_DECLARE(int, udp_blackhole);
154 VNET_DECLARE(bool, udp_blackhole_local);
155 VNET_DECLARE(int, udp_log_in_vain);
156 #define	V_udp_cksum		VNET(udp_cksum)
157 #define	V_udp_blackhole		VNET(udp_blackhole)
158 #define	V_udp_blackhole_local	VNET(udp_blackhole_local)
159 #define	V_udp_log_in_vain	VNET(udp_log_in_vain)
160 
161 VNET_DECLARE(int, zero_checksum_port);
162 #define	V_zero_checksum_port	VNET(zero_checksum_port)
163 
164 static __inline struct inpcbinfo *
165 udp_get_inpcbinfo(int protocol)
166 {
167 	return (protocol == IPPROTO_UDP) ? &V_udbinfo : &V_ulitecbinfo;
168 }
169 
170 int		udp_newudpcb(struct inpcb *);
171 void		udp_discardcb(struct udpcb *);
172 
173 void		udp_ctlinput(int, struct sockaddr *, void *);
174 void		udplite_ctlinput(int, struct sockaddr *, void *);
175 int		udp_ctloutput(struct socket *, struct sockopt *);
176 int		udp_input(struct mbuf **, int *, int);
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