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