xref: /freebsd/sys/netinet/udp_var.h (revision 40a8ac8f62b535d30349faf28cf47106b7041b83)
1 /*-
2  * Copyright (c) 1982, 1986, 1989, 1993
3  *	The Regents of the University of California.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 4. Neither the name of the University nor the names of its contributors
15  *    may be used to endorse or promote products derived from this software
16  *    without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  *	@(#)udp_var.h	8.1 (Berkeley) 6/10/93
31  * $FreeBSD$
32  */
33 
34 #ifndef _NETINET_UDP_VAR_H_
35 #define	_NETINET_UDP_VAR_H_
36 
37 /*
38  * UDP kernel structures and variables.
39  */
40 struct udpiphdr {
41 	struct ipovly	ui_i;		/* overlaid ip structure */
42 	struct udphdr	ui_u;		/* udp header */
43 };
44 #define	ui_x1		ui_i.ih_x1
45 #define	ui_v		ui_i.ih_x1[0]
46 #define	ui_pr		ui_i.ih_pr
47 #define	ui_len		ui_i.ih_len
48 #define	ui_src		ui_i.ih_src
49 #define	ui_dst		ui_i.ih_dst
50 #define	ui_sport	ui_u.uh_sport
51 #define	ui_dport	ui_u.uh_dport
52 #define	ui_ulen		ui_u.uh_ulen
53 #define	ui_sum		ui_u.uh_sum
54 
55 struct inpcb;
56 struct mbuf;
57 
58 typedef void(*udp_tun_func_t)(struct mbuf *, int off, struct inpcb *);
59 
60 /*
61  * UDP control block; one per udp.
62  */
63 struct udpcb {
64 	udp_tun_func_t	u_tun_func;	/* UDP kernel tunneling callback. */
65 	u_int		u_flags;	/* Generic UDP flags. */
66 	uint16_t	u_rxcslen;	/* Coverage for incoming datagrams. */
67 	uint16_t	u_txcslen;	/* Coverage for outgoing datagrams. */
68 };
69 
70 #define	intoudpcb(ip)	((struct udpcb *)(ip)->inp_ppcb)
71 #define	sotoudpcb(so)	(intoudpcb(sotoinpcb(so)))
72 
73 				/* IPsec: ESP in UDP tunneling: */
74 #define	UF_ESPINUDP_NON_IKE	0x00000001	/* w/ non-IKE marker .. */
75 	/* .. per draft-ietf-ipsec-nat-t-ike-0[01],
76 	 * and draft-ietf-ipsec-udp-encaps-(00/)01.txt */
77 #define	UF_ESPINUDP		0x00000002	/* w/ non-ESP marker. */
78 
79 struct udpstat {
80 				/* input statistics: */
81 	uint64_t udps_ipackets;		/* total input packets */
82 	uint64_t udps_hdrops;		/* packet shorter than header */
83 	uint64_t udps_badsum;		/* checksum error */
84 	uint64_t udps_nosum;		/* no checksum */
85 	uint64_t udps_badlen;		/* data length larger than packet */
86 	uint64_t udps_noport;		/* no socket on port */
87 	uint64_t udps_noportbcast;	/* of above, arrived as broadcast */
88 	uint64_t udps_fullsock;		/* not delivered, input socket full */
89 	uint64_t udpps_pcbcachemiss;	/* input packets missing pcb cache */
90 	uint64_t udpps_pcbhashmiss;	/* input packets not for hashed pcb */
91 				/* output statistics: */
92 	uint64_t udps_opackets;		/* total output packets */
93 	uint64_t udps_fastout;		/* output packets on fast path */
94 	/* of no socket on port, arrived as multicast */
95 	uint64_t udps_noportmcast;
96 	uint64_t udps_filtermcast;	/* blocked by multicast filter */
97 };
98 
99 #ifdef _KERNEL
100 #include <sys/counter.h>
101 
102 VNET_PCPUSTAT_DECLARE(struct udpstat, udpstat);
103 /*
104  * In-kernel consumers can use these accessor macros directly to update
105  * stats.
106  */
107 #define	UDPSTAT_ADD(name, val)  \
108     VNET_PCPUSTAT_ADD(struct udpstat, udpstat, name, (val))
109 #define	UDPSTAT_INC(name)	UDPSTAT_ADD(name, 1)
110 
111 /*
112  * Kernel module consumers must use this accessor macro.
113  */
114 void	kmod_udpstat_inc(int statnum);
115 #define	KMOD_UDPSTAT_INC(name)	\
116     kmod_udpstat_inc(offsetof(struct udpstat, name) / sizeof(uint64_t))
117 #endif
118 
119 /*
120  * Identifiers for UDP sysctl nodes.
121  */
122 #define	UDPCTL_CHECKSUM		1	/* checksum UDP packets */
123 #define	UDPCTL_STATS		2	/* statistics (read-only) */
124 #define	UDPCTL_MAXDGRAM		3	/* max datagram size */
125 #define	UDPCTL_RECVSPACE	4	/* default receive buffer space */
126 #define	UDPCTL_PCBLIST		5	/* list of PCBs for UDP sockets */
127 
128 #ifdef _KERNEL
129 #include <netinet/in_pcb.h>
130 SYSCTL_DECL(_net_inet_udp);
131 
132 extern struct pr_usrreqs	udp_usrreqs;
133 VNET_DECLARE(struct inpcbhead, udb);
134 VNET_DECLARE(struct inpcbinfo, udbinfo);
135 VNET_DECLARE(struct inpcbhead, ulitecb);
136 VNET_DECLARE(struct inpcbinfo, ulitecbinfo);
137 #define	V_udb			VNET(udb)
138 #define	V_udbinfo		VNET(udbinfo)
139 #define	V_ulitecb		VNET(ulitecb)
140 #define	V_ulitecbinfo		VNET(ulitecbinfo)
141 
142 extern u_long			udp_sendspace;
143 extern u_long			udp_recvspace;
144 VNET_DECLARE(int, udp_cksum);
145 VNET_DECLARE(int, udp_blackhole);
146 #define	V_udp_cksum		VNET(udp_cksum)
147 #define	V_udp_blackhole		VNET(udp_blackhole)
148 extern int			udp_log_in_vain;
149 
150 static __inline struct inpcbinfo *
151 get_inpcbinfo(int protocol)
152 {
153 	return (protocol == IPPROTO_UDP) ? &V_udbinfo : &V_ulitecbinfo;
154 }
155 
156 static __inline struct inpcbhead *
157 get_pcblist(int protocol)
158 {
159 	return (protocol == IPPROTO_UDP) ? &V_udb : &V_ulitecb;
160 }
161 
162 int		udp_newudpcb(struct inpcb *);
163 void		udp_discardcb(struct udpcb *);
164 
165 void		udp_ctlinput(int, struct sockaddr *, void *);
166 void		udplite_ctlinput(int, struct sockaddr *, void *);
167 int		udp_ctloutput(struct socket *, struct sockopt *);
168 void		udp_init(void);
169 void		udplite_init(void);
170 #ifdef VIMAGE
171 void		udp_destroy(void);
172 void		udplite_destroy(void);
173 #endif
174 int		udp_input(struct mbuf **, int *, int);
175 void		udplite_input(struct mbuf *, int);
176 struct inpcb	*udp_notify(struct inpcb *inp, int errno);
177 int		udp_shutdown(struct socket *so);
178 
179 int		udp_set_kernel_tunneling(struct socket *so, udp_tun_func_t f);
180 
181 #endif /* _KERNEL */
182 
183 #endif /* _NETINET_UDP_VAR_H_ */
184