]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * INET An implementation of the TCP/IP protocol suite for the LINUX | |
3 | * operating system. INET is implemented using the BSD Socket | |
4 | * interface as the means of communication with the user level. | |
5 | * | |
6 | * Definitions for the UDP module. | |
7 | * | |
8 | * Version: @(#)udp.h 1.0.2 05/07/93 | |
9 | * | |
02c30a84 | 10 | * Authors: Ross Biro |
1da177e4 LT |
11 | * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG> |
12 | * | |
13 | * Fixes: | |
14 | * Alan Cox : Turned on udp checksums. I don't want to | |
15 | * chase 'memory corruption' bugs that aren't! | |
16 | * | |
17 | * This program is free software; you can redistribute it and/or | |
18 | * modify it under the terms of the GNU General Public License | |
19 | * as published by the Free Software Foundation; either version | |
20 | * 2 of the License, or (at your option) any later version. | |
21 | */ | |
22 | #ifndef _UDP_H | |
23 | #define _UDP_H | |
24 | ||
1da177e4 | 25 | #include <linux/list.h> |
187f1882 | 26 | #include <linux/bug.h> |
14c85021 | 27 | #include <net/inet_sock.h> |
1da177e4 LT |
28 | #include <net/sock.h> |
29 | #include <net/snmp.h> | |
ba4e58ec GR |
30 | #include <net/ip.h> |
31 | #include <linux/ipv6.h> | |
1da177e4 | 32 | #include <linux/seq_file.h> |
bd01f843 | 33 | #include <linux/poll.h> |
1da177e4 | 34 | |
ba4e58ec GR |
35 | /** |
36 | * struct udp_skb_cb - UDP(-Lite) private variables | |
37 | * | |
38 | * @header: private variables used by IPv4/IPv6 | |
39 | * @cscov: checksum coverage length (UDP-Lite only) | |
40 | * @partial_cov: if set indicates partial csum coverage | |
41 | */ | |
42 | struct udp_skb_cb { | |
43 | union { | |
44 | struct inet_skb_parm h4; | |
dfd56b8b | 45 | #if IS_ENABLED(CONFIG_IPV6) |
ba4e58ec GR |
46 | struct inet6_skb_parm h6; |
47 | #endif | |
48 | } header; | |
49 | __u16 cscov; | |
50 | __u8 partial_cov; | |
51 | }; | |
52 | #define UDP_SKB_CB(__skb) ((struct udp_skb_cb *)((__skb)->cb)) | |
1da177e4 | 53 | |
fdcc8aa9 ED |
54 | /** |
55 | * struct udp_hslot - UDP hash slot | |
56 | * | |
57 | * @head: head of list of sockets | |
58 | * @count: number of sockets in 'head' list | |
59 | * @lock: spinlock protecting changes to head/count | |
60 | */ | |
645ca708 | 61 | struct udp_hslot { |
ca065d0c | 62 | struct hlist_head head; |
fdcc8aa9 | 63 | int count; |
645ca708 ED |
64 | spinlock_t lock; |
65 | } __attribute__((aligned(2 * sizeof(long)))); | |
f86dcc5a | 66 | |
512615b6 ED |
67 | /** |
68 | * struct udp_table - UDP table | |
69 | * | |
70 | * @hash: hash table, sockets are hashed on (local port) | |
71 | * @hash2: hash table, sockets are hashed on (local port, local address) | |
72 | * @mask: number of slots in hash tables, minus 1 | |
73 | * @log: log2(number of slots in hash table) | |
74 | */ | |
645ca708 | 75 | struct udp_table { |
f86dcc5a | 76 | struct udp_hslot *hash; |
512615b6 ED |
77 | struct udp_hslot *hash2; |
78 | unsigned int mask; | |
79 | unsigned int log; | |
645ca708 ED |
80 | }; |
81 | extern struct udp_table udp_table; | |
1a50bd06 | 82 | void udp_table_init(struct udp_table *, const char *); |
f86dcc5a | 83 | static inline struct udp_hslot *udp_hashslot(struct udp_table *table, |
95c96174 | 84 | struct net *net, unsigned int num) |
f86dcc5a ED |
85 | { |
86 | return &table->hash[udp_hashfn(net, num, table->mask)]; | |
87 | } | |
512615b6 ED |
88 | /* |
89 | * For secondary hash, net_hash_mix() is performed before calling | |
90 | * udp_hashslot2(), this explains difference with udp_hashslot() | |
91 | */ | |
92 | static inline struct udp_hslot *udp_hashslot2(struct udp_table *table, | |
93 | unsigned int hash) | |
94 | { | |
95 | return &table->hash2[hash & table->mask]; | |
96 | } | |
1da177e4 | 97 | |
1da177e4 LT |
98 | extern struct proto udp_prot; |
99 | ||
8d987e5c | 100 | extern atomic_long_t udp_memory_allocated; |
95766fff HA |
101 | |
102 | /* sysctl variables for udp */ | |
8d987e5c | 103 | extern long sysctl_udp_mem[3]; |
95766fff HA |
104 | extern int sysctl_udp_rmem_min; |
105 | extern int sysctl_udp_wmem_min; | |
106 | ||
14c85021 | 107 | struct sk_buff; |
1da177e4 | 108 | |
ba4e58ec GR |
109 | /* |
110 | * Generic checksumming routines for UDP(-Lite) v4 and v6 | |
111 | */ | |
b51655b9 | 112 | static inline __sum16 __udp_lib_checksum_complete(struct sk_buff *skb) |
ba4e58ec | 113 | { |
bbdff225 TH |
114 | return (UDP_SKB_CB(skb)->cscov == skb->len ? |
115 | __skb_checksum_complete(skb) : | |
116 | __skb_checksum_complete_head(skb, UDP_SKB_CB(skb)->cscov)); | |
ba4e58ec GR |
117 | } |
118 | ||
8e5200f5 | 119 | static inline int udp_lib_checksum_complete(struct sk_buff *skb) |
ba4e58ec | 120 | { |
60476372 | 121 | return !skb_csum_unnecessary(skb) && |
ba4e58ec GR |
122 | __udp_lib_checksum_complete(skb); |
123 | } | |
124 | ||
125 | /** | |
126 | * udp_csum_outgoing - compute UDPv4/v6 checksum over fragments | |
127 | * @sk: socket we are writing to | |
128 | * @skb: sk_buff containing the filled-in UDP header | |
129 | * (checksum field must be zeroed out) | |
130 | */ | |
868c86bc | 131 | static inline __wsum udp_csum_outgoing(struct sock *sk, struct sk_buff *skb) |
ba4e58ec | 132 | { |
9c70220b ACM |
133 | __wsum csum = csum_partial(skb_transport_header(skb), |
134 | sizeof(struct udphdr), 0); | |
ba4e58ec GR |
135 | skb_queue_walk(&sk->sk_write_queue, skb) { |
136 | csum = csum_add(csum, skb->csum); | |
137 | } | |
138 | return csum; | |
139 | } | |
140 | ||
f6b9664f HX |
141 | static inline __wsum udp_csum(struct sk_buff *skb) |
142 | { | |
143 | __wsum csum = csum_partial(skb_transport_header(skb), | |
144 | sizeof(struct udphdr), skb->csum); | |
145 | ||
146 | for (skb = skb_shinfo(skb)->frag_list; skb; skb = skb->next) { | |
147 | csum = csum_add(csum, skb->csum); | |
148 | } | |
149 | return csum; | |
150 | } | |
151 | ||
af5fcba7 TH |
152 | static inline __sum16 udp_v4_check(int len, __be32 saddr, |
153 | __be32 daddr, __wsum base) | |
154 | { | |
155 | return csum_tcpudp_magic(saddr, daddr, len, IPPROTO_UDP, base); | |
156 | } | |
157 | ||
158 | void udp_set_csum(bool nocheck, struct sk_buff *skb, | |
159 | __be32 saddr, __be32 daddr, int len); | |
160 | ||
e6afc8ac | 161 | static inline void udp_csum_pull_header(struct sk_buff *skb) |
162 | { | |
595d0b29 ED |
163 | if (!skb->csum_valid && skb->ip_summed == CHECKSUM_NONE) |
164 | skb->csum = csum_partial(skb->data, sizeof(struct udphdr), | |
e6afc8ac | 165 | skb->csum); |
166 | skb_pull_rcsum(skb, sizeof(struct udphdr)); | |
167 | UDP_SKB_CB(skb)->cscov -= sizeof(struct udphdr); | |
168 | } | |
169 | ||
a6024562 TH |
170 | typedef struct sock *(*udp_lookup_t)(struct sk_buff *skb, __be16 sport, |
171 | __be16 dport); | |
172 | ||
d4546c25 DM |
173 | struct sk_buff *udp_gro_receive(struct list_head *head, struct sk_buff *skb, |
174 | struct udphdr *uh, udp_lookup_t lookup); | |
a6024562 | 175 | int udp_gro_complete(struct sk_buff *skb, int nhoff, udp_lookup_t lookup); |
57c67ff4 | 176 | |
ee80d1eb | 177 | struct sk_buff *__udp_gso_segment(struct sk_buff *gso_skb, |
9a0d41b3 | 178 | netdev_features_t features); |
ee80d1eb | 179 | |
57c67ff4 TH |
180 | static inline struct udphdr *udp_gro_udphdr(struct sk_buff *skb) |
181 | { | |
182 | struct udphdr *uh; | |
183 | unsigned int hlen, off; | |
184 | ||
185 | off = skb_gro_offset(skb); | |
186 | hlen = off + sizeof(*uh); | |
187 | uh = skb_gro_header_fast(skb, off); | |
188 | if (skb_gro_header_hard(skb, hlen)) | |
189 | uh = skb_gro_header_slow(skb, hlen, off); | |
190 | ||
191 | return uh; | |
192 | } | |
193 | ||
ba4e58ec | 194 | /* hash routines shared between UDPv4/6 and UDP-Litev4/6 */ |
086c653f | 195 | static inline int udp_lib_hash(struct sock *sk) |
ba4e58ec GR |
196 | { |
197 | BUG(); | |
086c653f | 198 | return 0; |
ba4e58ec GR |
199 | } |
200 | ||
1a50bd06 JP |
201 | void udp_lib_unhash(struct sock *sk); |
202 | void udp_lib_rehash(struct sock *sk, u16 new_hash); | |
ba4e58ec GR |
203 | |
204 | static inline void udp_lib_close(struct sock *sk, long timeout) | |
205 | { | |
206 | sk_common_release(sk); | |
207 | } | |
208 | ||
1a50bd06 | 209 | int udp_lib_get_port(struct sock *sk, unsigned short snum, |
1a50bd06 | 210 | unsigned int hash2_nulladdr); |
ba4e58ec | 211 | |
723b8e46 TH |
212 | u32 udp_flow_hashrnd(void); |
213 | ||
b8f1a556 TH |
214 | static inline __be16 udp_flow_src_port(struct net *net, struct sk_buff *skb, |
215 | int min, int max, bool use_eth) | |
216 | { | |
217 | u32 hash; | |
218 | ||
219 | if (min >= max) { | |
220 | /* Use default range */ | |
221 | inet_get_local_port_range(net, &min, &max); | |
222 | } | |
223 | ||
224 | hash = skb_get_hash(skb); | |
723b8e46 TH |
225 | if (unlikely(!hash)) { |
226 | if (use_eth) { | |
227 | /* Can't find a normal hash, caller has indicated an | |
228 | * Ethernet packet so use that to compute a hash. | |
229 | */ | |
230 | hash = jhash(skb->data, 2 * ETH_ALEN, | |
231 | (__force u32) skb->protocol); | |
232 | } else { | |
233 | /* Can't derive any sort of hash for the packet, set | |
234 | * to some consistent random value. | |
235 | */ | |
236 | hash = udp_flow_hashrnd(); | |
237 | } | |
b8f1a556 TH |
238 | } |
239 | ||
240 | /* Since this is being sent on the wire obfuscate hash a bit | |
241 | * to minimize possbility that any useful information to an | |
242 | * attacker is leaked. Only upper 16 bits are relevant in the | |
243 | * computation for 16 bit port value. | |
244 | */ | |
245 | hash ^= hash << 16; | |
246 | ||
247 | return htons((((u64) hash * (max - min)) >> 32) + min); | |
248 | } | |
249 | ||
6c206b20 PA |
250 | static inline int udp_rqueue_get(struct sock *sk) |
251 | { | |
252 | return sk_rmem_alloc_get(sk) - READ_ONCE(udp_sk(sk)->forward_deficit); | |
253 | } | |
254 | ||
ba4e58ec | 255 | /* net/ipv4/udp.c */ |
c915fe13 | 256 | void udp_destruct_sock(struct sock *sk); |
f970bd9e PA |
257 | void skb_consume_udp(struct sock *sk, struct sk_buff *skb, int len); |
258 | int __udp_enqueue_schedule_skb(struct sock *sk, struct sk_buff *skb); | |
7c13f97f | 259 | void udp_skb_destructor(struct sock *sk, struct sk_buff *skb); |
2276f58a PA |
260 | struct sk_buff *__skb_recv_udp(struct sock *sk, unsigned int flags, |
261 | int noblock, int *peeked, int *off, int *err); | |
7c13f97f PA |
262 | static inline struct sk_buff *skb_recv_udp(struct sock *sk, unsigned int flags, |
263 | int noblock, int *err) | |
264 | { | |
265 | int peeked, off = 0; | |
266 | ||
267 | return __skb_recv_udp(sk, flags, noblock, &peeked, &off, err); | |
268 | } | |
f970bd9e | 269 | |
7487449c | 270 | int udp_v4_early_demux(struct sk_buff *skb); |
64f0f5d1 | 271 | bool udp_sk_rx_dst_set(struct sock *sk, struct dst_entry *dst); |
1a50bd06 JP |
272 | int udp_get_port(struct sock *sk, unsigned short snum, |
273 | int (*saddr_cmp)(const struct sock *, | |
274 | const struct sock *)); | |
275 | void udp_err(struct sk_buff *, u32); | |
5d77dca8 | 276 | int udp_abort(struct sock *sk, int err); |
1b784140 | 277 | int udp_sendmsg(struct sock *sk, struct msghdr *msg, size_t len); |
1a50bd06 JP |
278 | int udp_push_pending_frames(struct sock *sk); |
279 | void udp_flush_pending_frames(struct sock *sk); | |
2e8de857 | 280 | int udp_cmsg_send(struct sock *sk, struct msghdr *msg, u16 *gso_size); |
1a50bd06 JP |
281 | void udp4_hwcsum(struct sk_buff *skb, __be32 src, __be32 dst); |
282 | int udp_rcv(struct sk_buff *skb); | |
283 | int udp_ioctl(struct sock *sk, int cmd, unsigned long arg); | |
f970bd9e | 284 | int udp_init_sock(struct sock *sk); |
d74bad4e | 285 | int udp_pre_connect(struct sock *sk, struct sockaddr *uaddr, int addr_len); |
286c72de | 286 | int __udp_disconnect(struct sock *sk, int flags); |
1a50bd06 | 287 | int udp_disconnect(struct sock *sk, int flags); |
a11e1d43 | 288 | __poll_t udp_poll(struct file *file, struct socket *sock, poll_table *wait); |
1a50bd06 | 289 | struct sk_buff *skb_udp_tunnel_segment(struct sk_buff *skb, |
8bce6d7d TH |
290 | netdev_features_t features, |
291 | bool is_ipv6); | |
1a50bd06 JP |
292 | int udp_lib_getsockopt(struct sock *sk, int level, int optname, |
293 | char __user *optval, int __user *optlen); | |
294 | int udp_lib_setsockopt(struct sock *sk, int level, int optname, | |
295 | char __user *optval, unsigned int optlen, | |
296 | int (*push_pending_frames)(struct sock *)); | |
297 | struct sock *udp4_lib_lookup(struct net *net, __be32 saddr, __be16 sport, | |
298 | __be32 daddr, __be16 dport, int dif); | |
299 | struct sock *__udp4_lib_lookup(struct net *net, __be32 saddr, __be16 sport, | |
fb74c277 | 300 | __be32 daddr, __be16 dport, int dif, int sdif, |
538950a1 | 301 | struct udp_table *tbl, struct sk_buff *skb); |
63058308 TH |
302 | struct sock *udp4_lib_lookup_skb(struct sk_buff *skb, |
303 | __be16 sport, __be16 dport); | |
1a50bd06 JP |
304 | struct sock *udp6_lib_lookup(struct net *net, |
305 | const struct in6_addr *saddr, __be16 sport, | |
306 | const struct in6_addr *daddr, __be16 dport, | |
307 | int dif); | |
308 | struct sock *__udp6_lib_lookup(struct net *net, | |
309 | const struct in6_addr *saddr, __be16 sport, | |
310 | const struct in6_addr *daddr, __be16 dport, | |
1801b570 | 311 | int dif, int sdif, struct udp_table *tbl, |
538950a1 | 312 | struct sk_buff *skb); |
63058308 TH |
313 | struct sock *udp6_lib_lookup_skb(struct sk_buff *skb, |
314 | __be16 sport, __be16 dport); | |
bcd41303 | 315 | |
b26bbdae PA |
316 | /* UDP uses skb->dev_scratch to cache as much information as possible and avoid |
317 | * possibly multiple cache miss on dequeue() | |
318 | */ | |
b26bbdae | 319 | struct udp_dev_scratch { |
dce4551c PA |
320 | /* skb->truesize and the stateless bit are embedded in a single field; |
321 | * do not use a bitfield since the compiler emits better/smaller code | |
322 | * this way | |
323 | */ | |
324 | u32 _tsize_state; | |
325 | ||
326 | #if BITS_PER_LONG == 64 | |
327 | /* len and the bit needed to compute skb_csum_unnecessary | |
328 | * will be on cold cache lines at recvmsg time. | |
329 | * skb->len can be stored on 16 bits since the udp header has been | |
330 | * already validated and pulled. | |
331 | */ | |
b26bbdae PA |
332 | u16 len; |
333 | bool is_linear; | |
334 | bool csum_unnecessary; | |
dce4551c | 335 | #endif |
b26bbdae PA |
336 | }; |
337 | ||
dce4551c PA |
338 | static inline struct udp_dev_scratch *udp_skb_scratch(struct sk_buff *skb) |
339 | { | |
340 | return (struct udp_dev_scratch *)&skb->dev_scratch; | |
341 | } | |
342 | ||
343 | #if BITS_PER_LONG == 64 | |
b26bbdae PA |
344 | static inline unsigned int udp_skb_len(struct sk_buff *skb) |
345 | { | |
dce4551c | 346 | return udp_skb_scratch(skb)->len; |
b26bbdae PA |
347 | } |
348 | ||
349 | static inline bool udp_skb_csum_unnecessary(struct sk_buff *skb) | |
350 | { | |
dce4551c | 351 | return udp_skb_scratch(skb)->csum_unnecessary; |
b26bbdae PA |
352 | } |
353 | ||
354 | static inline bool udp_skb_is_linear(struct sk_buff *skb) | |
355 | { | |
dce4551c | 356 | return udp_skb_scratch(skb)->is_linear; |
b26bbdae PA |
357 | } |
358 | ||
359 | #else | |
360 | static inline unsigned int udp_skb_len(struct sk_buff *skb) | |
361 | { | |
362 | return skb->len; | |
363 | } | |
364 | ||
365 | static inline bool udp_skb_csum_unnecessary(struct sk_buff *skb) | |
366 | { | |
367 | return skb_csum_unnecessary(skb); | |
368 | } | |
369 | ||
370 | static inline bool udp_skb_is_linear(struct sk_buff *skb) | |
371 | { | |
372 | return !skb_is_nonlinear(skb); | |
373 | } | |
374 | #endif | |
375 | ||
376 | static inline int copy_linear_skb(struct sk_buff *skb, int len, int off, | |
377 | struct iov_iter *to) | |
378 | { | |
42b73059 | 379 | int n; |
b26bbdae | 380 | |
42b73059 AV |
381 | n = copy_to_iter(skb->data + off, len, to); |
382 | if (n == len) | |
b26bbdae PA |
383 | return 0; |
384 | ||
42b73059 | 385 | iov_iter_revert(to, n); |
b26bbdae PA |
386 | return -EFAULT; |
387 | } | |
388 | ||
ba4e58ec GR |
389 | /* |
390 | * SNMP statistics for UDP and UDP-Lite | |
391 | */ | |
6aef70a8 ED |
392 | #define UDP_INC_STATS(net, field, is_udplite) do { \ |
393 | if (is_udplite) SNMP_INC_STATS((net)->mib.udplite_statistics, field); \ | |
394 | else SNMP_INC_STATS((net)->mib.udp_statistics, field); } while(0) | |
02c22347 | 395 | #define __UDP_INC_STATS(net, field, is_udplite) do { \ |
13415e46 ED |
396 | if (is_udplite) __SNMP_INC_STATS((net)->mib.udplite_statistics, field); \ |
397 | else __SNMP_INC_STATS((net)->mib.udp_statistics, field); } while(0) | |
1da177e4 | 398 | |
02c22347 | 399 | #define __UDP6_INC_STATS(net, field, is_udplite) do { \ |
13415e46 ED |
400 | if (is_udplite) __SNMP_INC_STATS((net)->mib.udplite_stats_in6, field);\ |
401 | else __SNMP_INC_STATS((net)->mib.udp_stats_in6, field); \ | |
0c7ed677 | 402 | } while(0) |
6aef70a8 ED |
403 | #define UDP6_INC_STATS(net, field, __lite) do { \ |
404 | if (__lite) SNMP_INC_STATS((net)->mib.udplite_stats_in6, field); \ | |
405 | else SNMP_INC_STATS((net)->mib.udp_stats_in6, field); \ | |
0c7ed677 | 406 | } while(0) |
1781f7f5 | 407 | |
dfd56b8b | 408 | #if IS_ENABLED(CONFIG_IPV6) |
02c22347 | 409 | #define __UDPX_INC_STATS(sk, field) \ |
f9bddcdf JP |
410 | do { \ |
411 | if ((sk)->sk_family == AF_INET) \ | |
02c22347 | 412 | __UDP_INC_STATS(sock_net(sk), field, 0); \ |
f9bddcdf | 413 | else \ |
02c22347 | 414 | __UDP6_INC_STATS(sock_net(sk), field, 0); \ |
f9bddcdf | 415 | } while (0) |
1781f7f5 | 416 | #else |
02c22347 | 417 | #define __UDPX_INC_STATS(sk, field) __UDP_INC_STATS(sock_net(sk), field, 0) |
1781f7f5 HX |
418 | #endif |
419 | ||
a3d2599b | 420 | #ifdef CONFIG_PROC_FS |
1da177e4 | 421 | struct udp_seq_afinfo { |
73cb88ec AV |
422 | sa_family_t family; |
423 | struct udp_table *udp_table; | |
1da177e4 LT |
424 | }; |
425 | ||
426 | struct udp_iter_state { | |
6f191efe | 427 | struct seq_net_private p; |
1da177e4 | 428 | int bucket; |
1da177e4 LT |
429 | }; |
430 | ||
a3d2599b CH |
431 | void *udp_seq_start(struct seq_file *seq, loff_t *pos); |
432 | void *udp_seq_next(struct seq_file *seq, void *v, loff_t *pos); | |
433 | void udp_seq_stop(struct seq_file *seq, void *v); | |
434 | ||
c3506372 CH |
435 | extern const struct seq_operations udp_seq_ops; |
436 | extern const struct seq_operations udp6_seq_ops; | |
20380731 | 437 | |
1a50bd06 JP |
438 | int udp4_proc_init(void); |
439 | void udp4_proc_exit(void); | |
a3d2599b | 440 | #endif /* CONFIG_PROC_FS */ |
95766fff | 441 | |
1a50bd06 | 442 | int udpv4_offload_init(void); |
da5bab07 | 443 | |
1a50bd06 | 444 | void udp_init(void); |
d7ca4cc0 | 445 | |
1a50bd06 | 446 | void udp_encap_enable(void); |
d7f3f621 | 447 | #if IS_ENABLED(CONFIG_IPV6) |
1a50bd06 | 448 | void udpv6_encap_enable(void); |
d7f3f621 | 449 | #endif |
dddb64bc | 450 | |
1da177e4 | 451 | #endif /* _UDP_H */ |