xref: /freebsd/sys/netinet/udp_var.h (revision 9a14aa017b21c292740c00ee098195cd46642730)
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_pr		ui_i.ih_pr
46 #define	ui_len		ui_i.ih_len
47 #define	ui_src		ui_i.ih_src
48 #define	ui_dst		ui_i.ih_dst
49 #define	ui_sport	ui_u.uh_sport
50 #define	ui_dport	ui_u.uh_dport
51 #define	ui_ulen		ui_u.uh_ulen
52 #define	ui_sum		ui_u.uh_sum
53 
54 struct inpcb;
55 struct mbuf;
56 
57 typedef void(*udp_tun_func_t)(struct mbuf *, int off, struct inpcb *);
58 
59 /*
60  * UDP control block; one per udp.
61  */
62 struct udpcb {
63 	udp_tun_func_t	u_tun_func;	/* UDP kernel tunneling callback. */
64 	u_int		u_flags;	/* Generic UDP flags. */
65 };
66 
67 #define	intoudpcb(ip)	((struct udpcb *)(ip)->inp_ppcb)
68 #define	sotoudpcb(so)	(intoudpcb(sotoinpcb(so)))
69 
70 				/* IPsec: ESP in UDP tunneling: */
71 #define	UF_ESPINUDP_NON_IKE	0x00000001	/* w/ non-IKE marker .. */
72 	/* .. per draft-ietf-ipsec-nat-t-ike-0[01],
73 	 * and draft-ietf-ipsec-udp-encaps-(00/)01.txt */
74 #define	UF_ESPINUDP		0x00000002	/* w/ non-ESP marker. */
75 
76 struct udpstat {
77 				/* input statistics: */
78 	u_long	udps_ipackets;		/* total input packets */
79 	u_long	udps_hdrops;		/* packet shorter than header */
80 	u_long	udps_badsum;		/* checksum error */
81 	u_long	udps_nosum;		/* no checksum */
82 	u_long	udps_badlen;		/* data length larger than packet */
83 	u_long	udps_noport;		/* no socket on port */
84 	u_long	udps_noportbcast;	/* of above, arrived as broadcast */
85 	u_long	udps_fullsock;		/* not delivered, input socket full */
86 	u_long	udpps_pcbcachemiss;	/* input packets missing pcb cache */
87 	u_long	udpps_pcbhashmiss;	/* input packets not for hashed pcb */
88 				/* output statistics: */
89 	u_long	udps_opackets;		/* total output packets */
90 	u_long	udps_fastout;		/* output packets on fast path */
91 	/* of no socket on port, arrived as multicast */
92 	u_long	udps_noportmcast;
93 	u_long	udps_filtermcast;	/* blocked by multicast filter */
94 };
95 
96 #ifdef _KERNEL
97 /*
98  * In-kernel consumers can use these accessor macros directly to update
99  * stats.
100  */
101 #define	UDPSTAT_ADD(name, val)	V_udpstat.name += (val)
102 #define	UDPSTAT_INC(name)	UDPSTAT_ADD(name, 1)
103 
104 /*
105  * Kernel module consumers must use this accessor macro.
106  */
107 void	kmod_udpstat_inc(int statnum);
108 #define	KMOD_UDPSTAT_INC(name)						\
109 	kmod_udpstat_inc(offsetof(struct udpstat, name) / sizeof(u_long))
110 #endif
111 
112 /*
113  * Names for UDP sysctl objects.
114  */
115 #define	UDPCTL_CHECKSUM		1	/* checksum UDP packets */
116 #define	UDPCTL_STATS		2	/* statistics (read-only) */
117 #define	UDPCTL_MAXDGRAM		3	/* max datagram size */
118 #define	UDPCTL_RECVSPACE	4	/* default receive buffer space */
119 #define	UDPCTL_PCBLIST		5	/* list of PCBs for UDP sockets */
120 #define	UDPCTL_MAXID		6
121 
122 #define	UDPCTL_NAMES	{						\
123 	{ 0, 0 },							\
124 	{ "checksum", CTLTYPE_INT },					\
125 	{ "stats", CTLTYPE_STRUCT },					\
126 	{ "maxdgram", CTLTYPE_INT },					\
127 	{ "recvspace", CTLTYPE_INT },					\
128 	{ "pcblist", CTLTYPE_STRUCT },					\
129 }
130 
131 #ifdef _KERNEL
132 SYSCTL_DECL(_net_inet_udp);
133 
134 extern struct pr_usrreqs	udp_usrreqs;
135 VNET_DECLARE(struct inpcbhead, udb);
136 VNET_DECLARE(struct inpcbinfo, udbinfo);
137 #define	V_udb			VNET(udb)
138 #define	V_udbinfo		VNET(udbinfo)
139 
140 extern u_long			udp_sendspace;
141 extern u_long			udp_recvspace;
142 VNET_DECLARE(struct udpstat, udpstat);
143 VNET_DECLARE(int, udp_blackhole);
144 #define	V_udpstat		VNET(udpstat)
145 #define	V_udp_blackhole		VNET(udp_blackhole)
146 extern int			udp_log_in_vain;
147 
148 int		 udp_newudpcb(struct inpcb *);
149 void		 udp_discardcb(struct udpcb *);
150 
151 void		 udp_ctlinput(int, struct sockaddr *, void *);
152 int		 udp_ctloutput(struct socket *, struct sockopt *);
153 void		 udp_init(void);
154 #ifdef VIMAGE
155 void		 udp_destroy(void);
156 #endif
157 void		 udp_input(struct mbuf *, int);
158 struct inpcb	*udp_notify(struct inpcb *inp, int errno);
159 int		 udp_shutdown(struct socket *so);
160 
161 int udp_set_kernel_tunneling(struct socket *so, udp_tun_func_t f);
162 #endif
163 
164 #endif
165