[linux-block.git] / include / linux / udp.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * INET		An implementation of the TCP/IP protocol suite for the LINUX
 *		operating system.  INET is implemented using the  BSD Socket
 *		interface as the means of communication with the user level.
 *
 *		Definitions for the UDP protocol.
 *
 * Version:	@(#)udp.h	1.0.2	04/28/93
 *
 * Author:	Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 */
#ifndef _LINUX_UDP_H
#define _LINUX_UDP_H

#include <net/inet_sock.h>
#include <linux/skbuff.h>
#include <net/netns/hash.h>
#include <uapi/linux/udp.h>

static inline struct udphdr *udp_hdr(const struct sk_buff *skb)
{
	return (struct udphdr *)skb_transport_header(skb);
}

#define UDP_HTABLE_SIZE_MIN_PERNET	128
#define UDP_HTABLE_SIZE_MIN		(CONFIG_BASE_SMALL ? 128 : 256)
#define UDP_HTABLE_SIZE_MAX		65536

static inline u32 udp_hashfn(const struct net *net, u32 num, u32 mask)
{
	return (num + net_hash_mix(net)) & mask;
}

struct udp_sock {
	/* inet_sock has to be the first member */
	struct inet_sock inet;
#define udp_port_hash		inet.sk.__sk_common.skc_u16hashes[0]
#define udp_portaddr_hash	inet.sk.__sk_common.skc_u16hashes[1]
#define udp_portaddr_node	inet.sk.__sk_common.skc_portaddr_node
	int		 pending;	/* Any pending frames ? */
	unsigned int	 corkflag;	/* Cork is required */
	__u8		 encap_type;	/* Is this an Encapsulation socket? */
	unsigned char	 no_check6_tx:1,/* Send zero UDP6 checksums on TX? */
			 no_check6_rx:1,/* Allow zero UDP6 checksums on RX? */
			 encap_enabled:1, /* This socket enabled encap
					   * processing; UDP tunnels and
					   * different encapsulation layer set
					   * this
					   */
			 gro_enabled:1,	/* Request GRO aggregation */
			 accept_udp_l4:1,
			 accept_udp_fraglist:1;
	/*
	 * Following member retains the information to create a UDP header
	 * when the socket is uncorked.
	 */
	__u16		 len;		/* total length of pending frames */
	__u16		 gso_size;
	/*
	 * Fields specific to UDP-Lite.
	 */
	__u16		 pcslen;
	__u16		 pcrlen;
/* indicator bits used by pcflag: */
#define UDPLITE_BIT      0x1  		/* set by udplite proto init function */
#define UDPLITE_SEND_CC  0x2  		/* set via udplite setsockopt         */
#define UDPLITE_RECV_CC  0x4		/* set via udplite setsocktopt        */
	__u8		 pcflag;        /* marks socket as UDP-Lite if > 0    */
	__u8		 unused[3];
	/*
	 * For encapsulation sockets.
	 */
	int (*encap_rcv)(struct sock *sk, struct sk_buff *skb);
	void (*encap_err_rcv)(struct sock *sk, struct sk_buff *skb, int err,
			      __be16 port, u32 info, u8 *payload);
	int (*encap_err_lookup)(struct sock *sk, struct sk_buff *skb);
	void (*encap_destroy)(struct sock *sk);

	/* GRO functions for UDP socket */
	struct sk_buff *	(*gro_receive)(struct sock *sk,
					       struct list_head *head,
					       struct sk_buff *skb);
	int			(*gro_complete)(struct sock *sk,
						struct sk_buff *skb,
						int nhoff);

	/* udp_recvmsg try to use this before splicing sk_receive_queue */
	struct sk_buff_head	reader_queue ____cacheline_aligned_in_smp;

	/* This field is dirtied by udp_recvmsg() */
	int		forward_deficit;

	/* This fields follows rcvbuf value, and is touched by udp_recvmsg */
	int		forward_threshold;
};

#define UDP_MAX_SEGMENTS	(1 << 6UL)

#define udp_sk(ptr) container_of_const(ptr, struct udp_sock, inet.sk)

static inline void udp_set_no_check6_tx(struct sock *sk, bool val)
{
	udp_sk(sk)->no_check6_tx = val;
}

static inline void udp_set_no_check6_rx(struct sock *sk, bool val)
{
	udp_sk(sk)->no_check6_rx = val;
}

static inline bool udp_get_no_check6_tx(struct sock *sk)
{
	return udp_sk(sk)->no_check6_tx;
}

static inline bool udp_get_no_check6_rx(struct sock *sk)
{
	return udp_sk(sk)->no_check6_rx;
}

static inline void udp_cmsg_recv(struct msghdr *msg, struct sock *sk,
				 struct sk_buff *skb)
{
	int gso_size;

	if (skb_shinfo(skb)->gso_type & SKB_GSO_UDP_L4) {
		gso_size = skb_shinfo(skb)->gso_size;
		put_cmsg(msg, SOL_UDP, UDP_GRO, sizeof(gso_size), &gso_size);
	}
}

static inline bool udp_unexpected_gso(struct sock *sk, struct sk_buff *skb)
{
	if (!skb_is_gso(skb))
		return false;

	if (skb_shinfo(skb)->gso_type & SKB_GSO_UDP_L4 && !udp_sk(sk)->accept_udp_l4)
		return true;

	if (skb_shinfo(skb)->gso_type & SKB_GSO_FRAGLIST && !udp_sk(sk)->accept_udp_fraglist)
		return true;

	return false;
}

static inline void udp_allow_gso(struct sock *sk)
{
	udp_sk(sk)->accept_udp_l4 = 1;
	udp_sk(sk)->accept_udp_fraglist = 1;
}

#define udp_portaddr_for_each_entry(__sk, list) \
	hlist_for_each_entry(__sk, list, __sk_common.skc_portaddr_node)

#define udp_portaddr_for_each_entry_rcu(__sk, list) \
	hlist_for_each_entry_rcu(__sk, list, __sk_common.skc_portaddr_node)

#define IS_UDPLITE(__sk) (__sk->sk_protocol == IPPROTO_UDPLITE)

#endif	/* _LINUX_UDP_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/*
	3	* INET An implementation of the TCP/IP protocol suite for the LINUX
	4	* operating system. INET is implemented using the BSD Socket
	5	* interface as the means of communication with the user level.
	6	*
	7	* Definitions for the UDP protocol.
	8	*
	9	* Version: @(#)udp.h 1.0.2 04/28/93
	10	*
	11	* Author: Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
1da177e4 LT	12	*/
	13	#ifndef _LINUX_UDP_H
	14	#define _LINUX_UDP_H
	15
14c85021	16	#include <net/inet_sock.h>
310afe86	17	#include <linux/skbuff.h>
0b441916	18	#include <net/netns/hash.h>
607ca46e	19	#include <uapi/linux/udp.h>
310afe86 JP	20
	21	static inline struct udphdr udp_hdr(const struct sk_buff skb)
	22	{
	23	return (struct udphdr *)skb_transport_header(skb);
	24	}
	25
9804985b	26	#define UDP_HTABLE_SIZE_MIN_PERNET 128
f86dcc5a	27	#define UDP_HTABLE_SIZE_MIN (CONFIG_BASE_SMALL ? 128 : 256)
9804985b	28	#define UDP_HTABLE_SIZE_MAX 65536
1da177e4	29
6eada011	30	static inline u32 udp_hashfn(const struct net *net, u32 num, u32 mask)
d6266281	31	{
f86dcc5a	32	return (num + net_hash_mix(net)) & mask;
d6266281 PE	33	}
d6266281 PE	34
1da177e4 LT	35	struct udp_sock {
	36	/* inet_sock has to be the first member */
	37	struct inet_sock inet;
d4cada4a ED	38	#define udp_port_hash inet.sk.__sk_common.skc_u16hashes[0]
d4cada4a ED	39	#define udp_portaddr_hash inet.sk.__sk_common.skc_u16hashes[1]
512615b6	40	#define udp_portaddr_node inet.sk.__sk_common.skc_portaddr_node
1da177e4 LT	41	int pending; /* Any pending frames ? */
1da177e4 LT	42	unsigned int corkflag; /* Cork is required */
1c19448c TH	43	__u8 encap_type; /* Is this an Encapsulation socket? */
1c19448c TH	44	unsigned char no_check6_tx:1,/* Send zero UDP6 checksums on TX? */
60fb9567	45	no_check6_rx:1,/* Allow zero UDP6 checksums on RX? */
e20cf8d3	46	encap_enabled:1, /* This socket enabled encap
60fb9567 PA	47	* processing; UDP tunnels and
	48	* different encapsulation layer set
	49	* this
	50	*/
78352f73 PA	51	gro_enabled:1, /* Request GRO aggregation */
	52	accept_udp_l4:1,
	53	accept_udp_fraglist:1;
1da177e4	54	/*
47bdd718	55	* Following member retains the information to create a UDP header
1da177e4 LT	56	* when the socket is uncorked.
	57	*/
	58	__u16 len; /* total length of pending frames */
bec1f6f6	59	__u16 gso_size;
ba4e58ec GR	60	/*
	61	* Fields specific to UDP-Lite.
	62	*/
	63	__u16 pcslen;
	64	__u16 pcrlen;
	65	/* indicator bits used by pcflag: */
	66	#define UDPLITE_BIT 0x1 /* set by udplite proto init function */
	67	#define UDPLITE_SEND_CC 0x2 /* set via udplite setsockopt */
	68	#define UDPLITE_RECV_CC 0x4 /* set via udplite setsocktopt */
	69	__u8 pcflag; /* marks socket as UDP-Lite if > 0 */
342f0234 JC	70	__u8 unused[3];
	71	/*
	72	* For encapsulation sockets.
	73	*/
	74	int (encap_rcv)(struct sock sk, struct sk_buff *skb);
42fb06b3 DH	75	void (encap_err_rcv)(struct sock sk, struct sk_buff *skb, int err,
42fb06b3 DH	76	__be16 port, u32 info, u8 *payload);
a36e185e	77	int (encap_err_lookup)(struct sock sk, struct sk_buff *skb);
44046a59	78	void (encap_destroy)(struct sock sk);
a6024562 TH	79
a6024562 TH	80	/* GRO functions for UDP socket */
d4546c25 DM	81	struct sk_buff * (gro_receive)(struct sock sk,
d4546c25 DM	82	struct list_head *head,
a6024562 TH	83	struct sk_buff *skb);
	84	int (gro_complete)(struct sock sk,
	85	struct sk_buff *skb,
	86	int nhoff);
6b229cf7	87
2276f58a PA	88	/* udp_recvmsg try to use this before splicing sk_receive_queue */
	89	struct sk_buff_head reader_queue ____cacheline_aligned_in_smp;
	90
6b229cf7 ED	91	/* This field is dirtied by udp_recvmsg() */
6b229cf7 ED	92	int forward_deficit;
8a3854c7 PA	93
	94	/* This fields follows rcvbuf value, and is touched by udp_recvmsg */
	95	int forward_threshold;
1da177e4 LT	96	};
1da177e4 LT	97
bec1f6f6 WB	98	#define UDP_MAX_SEGMENTS (1 << 6UL)
bec1f6f6 WB	99
94c540fb	100	#define udp_sk(ptr) container_of_const(ptr, struct udp_sock, inet.sk)
e898d4db	101
1c19448c TH	102	static inline void udp_set_no_check6_tx(struct sock *sk, bool val)
	103	{
	104	udp_sk(sk)->no_check6_tx = val;
	105	}
	106
	107	static inline void udp_set_no_check6_rx(struct sock *sk, bool val)
	108	{
	109	udp_sk(sk)->no_check6_rx = val;
	110	}
	111
	112	static inline bool udp_get_no_check6_tx(struct sock *sk)
	113	{
	114	return udp_sk(sk)->no_check6_tx;
	115	}
	116
	117	static inline bool udp_get_no_check6_rx(struct sock *sk)
	118	{
	119	return udp_sk(sk)->no_check6_rx;
	120	}
	121
bcd1665e PA	122	static inline void udp_cmsg_recv(struct msghdr msg, struct sock sk,
	123	struct sk_buff *skb)
	124	{
	125	int gso_size;
	126
	127	if (skb_shinfo(skb)->gso_type & SKB_GSO_UDP_L4) {
	128	gso_size = skb_shinfo(skb)->gso_size;
	129	put_cmsg(msg, SOL_UDP, UDP_GRO, sizeof(gso_size), &gso_size);
	130	}
	131	}
	132
cf329aa4 PA	133	static inline bool udp_unexpected_gso(struct sock sk, struct sk_buff skb)
cf329aa4 PA	134	{
78352f73 PA	135	if (!skb_is_gso(skb))
	136	return false;
	137
	138	if (skb_shinfo(skb)->gso_type & SKB_GSO_UDP_L4 && !udp_sk(sk)->accept_udp_l4)
	139	return true;
	140
	141	if (skb_shinfo(skb)->gso_type & SKB_GSO_FRAGLIST && !udp_sk(sk)->accept_udp_fraglist)
	142	return true;
	143
	144	return false;
cf329aa4 PA	145	}
cf329aa4 PA	146
d18931a9 PA	147	static inline void udp_allow_gso(struct sock *sk)
	148	{
	149	udp_sk(sk)->accept_udp_l4 = 1;
	150	udp_sk(sk)->accept_udp_fraglist = 1;
	151	}
	152
ca065d0c ED	153	#define udp_portaddr_for_each_entry(__sk, list) \
ca065d0c ED	154	hlist_for_each_entry(__sk, list, __sk_common.skc_portaddr_node)
30fff923	155
ca065d0c ED	156	#define udp_portaddr_for_each_entry_rcu(__sk, list) \
ca065d0c ED	157	hlist_for_each_entry_rcu(__sk, list, __sk_common.skc_portaddr_node)
30fff923	158
3d8417d7	159	#define IS_UDPLITE(__sk) (__sk->sk_protocol == IPPROTO_UDPLITE)
1da177e4	160
1da177e4	161	#endif /* _LINUX_UDP_H */