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