xref: /xnu-12377.41.6/bsd/netinet/udp_var.h (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1 /*
2  * Copyright (c) 2008-2024 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * Copyright (c) 1982, 1986, 1989, 1993
30  *	The Regents of the University of California.  All rights reserved.
31  *
32  * Redistribution and use in source and binary forms, with or without
33  * modification, are permitted provided that the following conditions
34  * are met:
35  * 1. Redistributions of source code must retain the above copyright
36  *    notice, this list of conditions and the following disclaimer.
37  * 2. Redistributions in binary form must reproduce the above copyright
38  *    notice, this list of conditions and the following disclaimer in the
39  *    documentation and/or other materials provided with the distribution.
40  * 3. All advertising materials mentioning features or use of this software
41  *    must display the following acknowledgement:
42  *	This product includes software developed by the University of
43  *	California, Berkeley and its contributors.
44  * 4. Neither the name of the University nor the names of its contributors
45  *    may be used to endorse or promote products derived from this software
46  *    without specific prior written permission.
47  *
48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58  * SUCH DAMAGE.
59  *
60  *	@(#)udp_var.h	8.1 (Berkeley) 6/10/93
61  */
62 
63 #ifndef _NETINET_UDP_VAR_H_
64 #define _NETINET_UDP_VAR_H_
65 
66 #include <netinet/ip_var.h>
67 #include <netinet/udp.h>
68 #include <sys/appleapiopts.h>
69 #include <sys/sysctl.h>
70 
71 /*
72  * UDP kernel structures and variables.
73  */
74 struct  udpiphdr {
75 	struct  ipovly ui_i;            /* overlaid ip structure */
76 	struct  udphdr ui_u;            /* udp header */
77 };
78 #define ui_x1           ui_i.ih_x1
79 #define ui_pr           ui_i.ih_pr
80 #define ui_len          ui_i.ih_len
81 #define ui_src          ui_i.ih_src
82 #define ui_dst          ui_i.ih_dst
83 #define ui_sport        ui_u.uh_sport
84 #define ui_dport        ui_u.uh_dport
85 #define ui_ulen         ui_u.uh_ulen
86 #define ui_sum          ui_u.uh_sum
87 #define ui_next         ui_i.ih_next
88 #define ui_prev         ui_i.ih_prev
89 
90 struct  udpstat {
91 	/* input statistics: */
92 	u_int32_t udps_ipackets;        /* total input packets */
93 	u_int32_t udps_hdrops;          /* packet shorter than header */
94 	u_int32_t udps_badsum;          /* checksum error */
95 	u_int32_t udps_badlen;          /* data length larger than packet */
96 	u_int32_t udps_noport;          /* no socket on port */
97 	u_int32_t udps_noportbcast;     /* of above, arrived as broadcast */
98 	u_int32_t udps_fullsock;        /* not delivered, input socket full */
99 	u_int32_t udpps_pcbcachemiss;   /* input packets missing pcb cache */
100 	u_int32_t udpps_pcbhashmiss;    /* input packets not for hashed pcb */
101 	/* output statistics: */
102 	u_int32_t udps_opackets;        /* total output packets */
103 	u_int32_t udps_fastout;         /* output packets on fast path */
104 	u_int32_t udps_nosum;           /* no checksum */
105 	u_int32_t udps_noportmcast;     /* of no socket on port, multicast */
106 	u_int32_t udps_filtermcast;     /* blocked by multicast filter */
107 	/* checksum statistics: */
108 	u_int32_t udps_rcv_swcsum;        /* udp swcksum (inbound), packets */
109 	u_int32_t udps_rcv_swcsum_bytes;  /* udp swcksum (inbound), bytes */
110 	u_int32_t udps_rcv6_swcsum;       /* udp6 swcksum (inbound), packets */
111 	u_int32_t udps_rcv6_swcsum_bytes; /* udp6 swcksum (inbound), bytes */
112 	u_int32_t udps_snd_swcsum;        /* udp swcksum (outbound), packets */
113 	u_int32_t udps_snd_swcsum_bytes;  /* udp swcksum (outbound), bytes */
114 	u_int32_t udps_snd6_swcsum;       /* udp6 swcksum (outbound), packets */
115 	u_int32_t udps_snd6_swcsum_bytes; /* udp6 swcksum (outbound), bytes */
116 	/* Port unreachable duplicate suppression */
117 	u_int64_t udps_port_unreach_dup_suppressed;
118 	u_int64_t udps_port_unreach_not_suppressed;
119 };
120 
121 /*
122  * Names for UDP sysctl objects
123  */
124 #define UDPCTL_CHECKSUM         1       /* checksum UDP packets */
125 #define UDPCTL_STATS            2       /* statistics (read-only) */
126 #define UDPCTL_MAXDGRAM         3       /* max datagram size */
127 #define UDPCTL_RECVSPACE        4       /* default receive buffer space */
128 #define UDPCTL_PCBLIST          5       /* list of PCBs for UDP sockets */
129 #define UDPCTL_MAXID            6
130 
131 #ifdef BSD_KERNEL_PRIVATE
132 #include <kern/locks.h>
133 #include <kern/mem_acct.h>
134 #include <sys/bitstring.h>
135 
136 #define UDPCTL_NAMES {                                                  \
137 	{ 0, 0 },                                                       \
138 	{ "checksum", CTLTYPE_INT },                                    \
139 	{ "stats", CTLTYPE_STRUCT },                                    \
140 	{ "maxdgram", CTLTYPE_INT },                                    \
141 	{ "recvspace", CTLTYPE_INT },                                   \
142 	{ "pcblist", CTLTYPE_STRUCT },                                  \
143 }
144 
145 #define udp6stat        udpstat
146 #define udp6s_opackets  udps_opackets
147 
148 SYSCTL_DECL(_net_inet_udp);
149 
150 struct udpstat_local {
151 	u_int64_t       port_unreach;
152 	u_int64_t       faithprefix;    /* deprecated */
153 	u_int64_t       port0;
154 	u_int64_t       badlength;
155 	u_int64_t       badchksum;
156 	u_int64_t       badmcast;
157 	u_int64_t       cleanup;
158 	u_int64_t       badipsec;
159 	u_int64_t       linkheur_stealthdrop;
160 };
161 
162 extern struct pr_usrreqs udp_usrreqs;
163 extern struct inpcbhead udb;
164 extern struct inpcbinfo udbinfo;
165 extern u_int32_t udp_sendspace;
166 extern u_int32_t udp_recvspace;
167 extern struct udpstat udpstat;
168 extern int udp_log_in_vain;
169 extern struct mem_acct *udp_memacct;
170 
171 static inline void
udp_memacct_add(int size)172 udp_memacct_add(int size)
173 {
174 	mem_acct_add(udp_memacct, size);
175 }
176 
177 static inline void
udp_memacct_sub(int size)178 udp_memacct_sub(int size)
179 {
180 	mem_acct_sub(udp_memacct, size);
181 }
182 
183 
184 __BEGIN_DECLS
185 extern void udp_ctlinput(int, struct sockaddr *, void *, struct ifnet *);
186 extern int udp_ctloutput(struct socket *, struct sockopt *);
187 extern void udp_init(struct protosw *, struct domain *);
188 extern void udp_input(struct mbuf *, int);
189 extern int udp_connectx_common(struct socket *, int, struct sockaddr *,
190     struct sockaddr *, struct proc *, uint32_t, sae_associd_t,
191     sae_connid_t *, uint32_t, void *, uint32_t, struct uio*, user_ssize_t *);
192 extern void udp_notify(struct inpcb *inp, int errno);
193 extern int udp_shutdown(struct socket *so);
194 extern int udp_lock(struct socket *, int, void *);
195 extern int udp_unlock(struct socket *, int, void *);
196 extern lck_mtx_t *udp_getlock(struct socket *, int);
197 extern void udp_get_ports_used(ifnet_t ifp, int, u_int32_t, bitstr_t *__counted_by(bitstr_size(IP_PORTRANGE_SIZE)));
198 extern uint32_t udp_count_opportunistic(unsigned int, u_int32_t);
199 extern uint32_t udp_find_anypcb_byaddr(struct ifaddr *);
200 
201 extern void udp_fill_keepalive_offload_frames(struct ifnet *,
202     struct ifnet_keepalive_offload_frame *__counted_by(frames_count) frames_array,
203     uint32_t frames_count, size_t, u_int32_t *);
204 
205 __END_DECLS
206 #endif /* BSD_KERNEL_PRIVATE */
207 #endif /* _NETINET_UDP_VAR_H_ */
208