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