xref: /openbmc/linux/include/net/udp.h (revision 455f9726)
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  *
10  * Authors:	Ross Biro
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 
25 #include <linux/list.h>
26 #include <linux/bug.h>
27 #include <net/inet_sock.h>
28 #include <net/sock.h>
29 #include <net/snmp.h>
30 #include <net/ip.h>
31 #include <linux/ipv6.h>
32 #include <linux/seq_file.h>
33 #include <linux/poll.h>
34 
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;
45 #if IS_ENABLED(CONFIG_IPV6)
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))
53 
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  */
61 struct udp_hslot {
62 	struct hlist_nulls_head	head;
63 	int			count;
64 	spinlock_t		lock;
65 } __attribute__((aligned(2 * sizeof(long))));
66 
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  */
75 struct udp_table {
76 	struct udp_hslot	*hash;
77 	struct udp_hslot	*hash2;
78 	unsigned int		mask;
79 	unsigned int		log;
80 };
81 extern struct udp_table udp_table;
82 void udp_table_init(struct udp_table *, const char *);
83 static inline struct udp_hslot *udp_hashslot(struct udp_table *table,
84 					     struct net *net, unsigned int num)
85 {
86 	return &table->hash[udp_hashfn(net, num, table->mask)];
87 }
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 }
97 
98 extern struct proto udp_prot;
99 
100 extern atomic_long_t udp_memory_allocated;
101 
102 /* sysctl variables for udp */
103 extern long sysctl_udp_mem[3];
104 extern int sysctl_udp_rmem_min;
105 extern int sysctl_udp_wmem_min;
106 
107 struct sk_buff;
108 
109 /*
110  *	Generic checksumming routines for UDP(-Lite) v4 and v6
111  */
112 static inline __sum16 __udp_lib_checksum_complete(struct sk_buff *skb)
113 {
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));
117 }
118 
119 static inline int udp_lib_checksum_complete(struct sk_buff *skb)
120 {
121 	return !skb_csum_unnecessary(skb) &&
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  */
131 static inline __wsum udp_csum_outgoing(struct sock *sk, struct sk_buff *skb)
132 {
133 	__wsum csum = csum_partial(skb_transport_header(skb),
134 				   sizeof(struct udphdr), 0);
135 	skb_queue_walk(&sk->sk_write_queue, skb) {
136 		csum = csum_add(csum, skb->csum);
137 	}
138 	return csum;
139 }
140 
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 
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 
161 /* hash routines shared between UDPv4/6 and UDP-Litev4/6 */
162 static inline void udp_lib_hash(struct sock *sk)
163 {
164 	BUG();
165 }
166 
167 void udp_lib_unhash(struct sock *sk);
168 void udp_lib_rehash(struct sock *sk, u16 new_hash);
169 
170 static inline void udp_lib_close(struct sock *sk, long timeout)
171 {
172 	sk_common_release(sk);
173 }
174 
175 int udp_lib_get_port(struct sock *sk, unsigned short snum,
176 		     int (*)(const struct sock *, const struct sock *),
177 		     unsigned int hash2_nulladdr);
178 
179 static inline __be16 udp_flow_src_port(struct net *net, struct sk_buff *skb,
180 				       int min, int max, bool use_eth)
181 {
182 	u32 hash;
183 
184 	if (min >= max) {
185 		/* Use default range */
186 		inet_get_local_port_range(net, &min, &max);
187 	}
188 
189 	hash = skb_get_hash(skb);
190 	if (unlikely(!hash) && use_eth) {
191 		/* Can't find a normal hash, caller has indicated an Ethernet
192 		 * packet so use that to compute a hash.
193 		 */
194 		hash = jhash(skb->data, 2 * ETH_ALEN,
195 			     (__force u32) skb->protocol);
196 	}
197 
198 	/* Since this is being sent on the wire obfuscate hash a bit
199 	 * to minimize possbility that any useful information to an
200 	 * attacker is leaked. Only upper 16 bits are relevant in the
201 	 * computation for 16 bit port value.
202 	 */
203 	hash ^= hash << 16;
204 
205 	return htons((((u64) hash * (max - min)) >> 32) + min);
206 }
207 
208 /* net/ipv4/udp.c */
209 void udp_v4_early_demux(struct sk_buff *skb);
210 int udp_get_port(struct sock *sk, unsigned short snum,
211 		 int (*saddr_cmp)(const struct sock *,
212 				  const struct sock *));
213 void udp_err(struct sk_buff *, u32);
214 int udp_sendmsg(struct kiocb *iocb, struct sock *sk, struct msghdr *msg,
215 		size_t len);
216 int udp_push_pending_frames(struct sock *sk);
217 void udp_flush_pending_frames(struct sock *sk);
218 void udp4_hwcsum(struct sk_buff *skb, __be32 src, __be32 dst);
219 int udp_rcv(struct sk_buff *skb);
220 int udp_ioctl(struct sock *sk, int cmd, unsigned long arg);
221 int udp_disconnect(struct sock *sk, int flags);
222 unsigned int udp_poll(struct file *file, struct socket *sock, poll_table *wait);
223 struct sk_buff *skb_udp_tunnel_segment(struct sk_buff *skb,
224 				       netdev_features_t features);
225 int udp_lib_getsockopt(struct sock *sk, int level, int optname,
226 		       char __user *optval, int __user *optlen);
227 int udp_lib_setsockopt(struct sock *sk, int level, int optname,
228 		       char __user *optval, unsigned int optlen,
229 		       int (*push_pending_frames)(struct sock *));
230 struct sock *udp4_lib_lookup(struct net *net, __be32 saddr, __be16 sport,
231 			     __be32 daddr, __be16 dport, int dif);
232 struct sock *__udp4_lib_lookup(struct net *net, __be32 saddr, __be16 sport,
233 			       __be32 daddr, __be16 dport, int dif,
234 			       struct udp_table *tbl);
235 struct sock *udp6_lib_lookup(struct net *net,
236 			     const struct in6_addr *saddr, __be16 sport,
237 			     const struct in6_addr *daddr, __be16 dport,
238 			     int dif);
239 struct sock *__udp6_lib_lookup(struct net *net,
240 			       const struct in6_addr *saddr, __be16 sport,
241 			       const struct in6_addr *daddr, __be16 dport,
242 			       int dif, struct udp_table *tbl);
243 
244 /*
245  * 	SNMP statistics for UDP and UDP-Lite
246  */
247 #define UDP_INC_STATS_USER(net, field, is_udplite)	      do { \
248 	if (is_udplite) SNMP_INC_STATS_USER((net)->mib.udplite_statistics, field);       \
249 	else		SNMP_INC_STATS_USER((net)->mib.udp_statistics, field);  }  while(0)
250 #define UDP_INC_STATS_BH(net, field, is_udplite) 	      do { \
251 	if (is_udplite) SNMP_INC_STATS_BH((net)->mib.udplite_statistics, field);         \
252 	else		SNMP_INC_STATS_BH((net)->mib.udp_statistics, field);    }  while(0)
253 
254 #define UDP6_INC_STATS_BH(net, field, is_udplite) 	    do { \
255 	if (is_udplite) SNMP_INC_STATS_BH((net)->mib.udplite_stats_in6, field);\
256 	else		SNMP_INC_STATS_BH((net)->mib.udp_stats_in6, field);  \
257 } while(0)
258 #define UDP6_INC_STATS_USER(net, field, __lite)		    do { \
259 	if (__lite) SNMP_INC_STATS_USER((net)->mib.udplite_stats_in6, field);  \
260 	else	    SNMP_INC_STATS_USER((net)->mib.udp_stats_in6, field);      \
261 } while(0)
262 
263 #if IS_ENABLED(CONFIG_IPV6)
264 #define UDPX_INC_STATS_BH(sk, field)					\
265 do {									\
266 	if ((sk)->sk_family == AF_INET)					\
267 		UDP_INC_STATS_BH(sock_net(sk), field, 0);		\
268 	else								\
269 		UDP6_INC_STATS_BH(sock_net(sk), field, 0);		\
270 } while (0)
271 #else
272 #define UDPX_INC_STATS_BH(sk, field) UDP_INC_STATS_BH(sock_net(sk), field, 0)
273 #endif
274 
275 /* /proc */
276 int udp_seq_open(struct inode *inode, struct file *file);
277 
278 struct udp_seq_afinfo {
279 	char				*name;
280 	sa_family_t			family;
281 	struct udp_table		*udp_table;
282 	const struct file_operations	*seq_fops;
283 	struct seq_operations		seq_ops;
284 };
285 
286 struct udp_iter_state {
287 	struct seq_net_private  p;
288 	sa_family_t		family;
289 	int			bucket;
290 	struct udp_table	*udp_table;
291 };
292 
293 #ifdef CONFIG_PROC_FS
294 int udp_proc_register(struct net *net, struct udp_seq_afinfo *afinfo);
295 void udp_proc_unregister(struct net *net, struct udp_seq_afinfo *afinfo);
296 
297 int udp4_proc_init(void);
298 void udp4_proc_exit(void);
299 #endif
300 
301 int udpv4_offload_init(void);
302 
303 void udp_init(void);
304 
305 void udp_encap_enable(void);
306 #if IS_ENABLED(CONFIG_IPV6)
307 void udpv6_encap_enable(void);
308 #endif
309 #endif	/* _UDP_H */
310