[mirror_ubuntu-jammy-kernel.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);
}

static inline struct udphdr *inner_udp_hdr(const struct sk_buff *skb)
{
	return (struct udphdr *)skb_inner_transport_header(skb);
}

#define UDP_HTABLE_SIZE_MIN		(CONFIG_BASE_SMALL ? 128 : 256)

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);
	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;
};

#define UDP_MAX_SEGMENTS	(1 << 6UL)

static inline struct udp_sock *udp_sk(const struct sock *sk)
{
	return (struct udp_sock *)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
6a674e9c JG	26	static inline struct udphdr inner_udp_hdr(const struct sk_buff skb)
	27	{
	28	return (struct udphdr *)skb_inner_transport_header(skb);
	29	}
	30
f86dcc5a	31	#define UDP_HTABLE_SIZE_MIN (CONFIG_BASE_SMALL ? 128 : 256)
1da177e4	32
6eada011	33	static inline u32 udp_hashfn(const struct net *net, u32 num, u32 mask)
d6266281	34	{
f86dcc5a	35	return (num + net_hash_mix(net)) & mask;
d6266281 PE	36	}
d6266281 PE	37
1da177e4 LT	38	struct udp_sock {
	39	/* inet_sock has to be the first member */
	40	struct inet_sock inet;
d4cada4a ED	41	#define udp_port_hash inet.sk.__sk_common.skc_u16hashes[0]
d4cada4a ED	42	#define udp_portaddr_hash inet.sk.__sk_common.skc_u16hashes[1]
512615b6	43	#define udp_portaddr_node inet.sk.__sk_common.skc_portaddr_node
1da177e4 LT	44	int pending; /* Any pending frames ? */
1da177e4 LT	45	unsigned int corkflag; /* Cork is required */
1c19448c TH	46	__u8 encap_type; /* Is this an Encapsulation socket? */
1c19448c TH	47	unsigned char no_check6_tx:1,/* Send zero UDP6 checksums on TX? */
60fb9567	48	no_check6_rx:1,/* Allow zero UDP6 checksums on RX? */
e20cf8d3	49	encap_enabled:1, /* This socket enabled encap
60fb9567 PA	50	* processing; UDP tunnels and
	51	* different encapsulation layer set
	52	* this
	53	*/
78352f73 PA	54	gro_enabled:1, /* Request GRO aggregation */
	55	accept_udp_l4:1,
	56	accept_udp_fraglist:1;
1da177e4	57	/*
47bdd718	58	* Following member retains the information to create a UDP header
1da177e4 LT	59	* when the socket is uncorked.
	60	*/
	61	__u16 len; /* total length of pending frames */
bec1f6f6	62	__u16 gso_size;
ba4e58ec GR	63	/*
	64	* Fields specific to UDP-Lite.
	65	*/
	66	__u16 pcslen;
	67	__u16 pcrlen;
	68	/* indicator bits used by pcflag: */
	69	#define UDPLITE_BIT 0x1 /* set by udplite proto init function */
	70	#define UDPLITE_SEND_CC 0x2 /* set via udplite setsockopt */
	71	#define UDPLITE_RECV_CC 0x4 /* set via udplite setsocktopt */
	72	__u8 pcflag; /* marks socket as UDP-Lite if > 0 */
342f0234 JC	73	__u8 unused[3];
	74	/*
	75	* For encapsulation sockets.
	76	*/
	77	int (encap_rcv)(struct sock sk, struct sk_buff *skb);
a36e185e	78	int (encap_err_lookup)(struct sock sk, struct sk_buff *skb);
44046a59	79	void (encap_destroy)(struct sock sk);
a6024562 TH	80
a6024562 TH	81	/* GRO functions for UDP socket */
d4546c25 DM	82	struct sk_buff * (gro_receive)(struct sock sk,
d4546c25 DM	83	struct list_head *head,
a6024562 TH	84	struct sk_buff *skb);
	85	int (gro_complete)(struct sock sk,
	86	struct sk_buff *skb,
	87	int nhoff);
6b229cf7	88
2276f58a PA	89	/* udp_recvmsg try to use this before splicing sk_receive_queue */
	90	struct sk_buff_head reader_queue ____cacheline_aligned_in_smp;
	91
6b229cf7 ED	92	/* This field is dirtied by udp_recvmsg() */
6b229cf7 ED	93	int forward_deficit;
1da177e4 LT	94	};
1da177e4 LT	95
bec1f6f6 WB	96	#define UDP_MAX_SEGMENTS (1 << 6UL)
bec1f6f6 WB	97
1da177e4 LT	98	static inline struct udp_sock udp_sk(const struct sock sk)
	99	{
	100	return (struct udp_sock *)sk;
	101	}
e898d4db	102
1c19448c TH	103	static inline void udp_set_no_check6_tx(struct sock *sk, bool val)
	104	{
	105	udp_sk(sk)->no_check6_tx = val;
	106	}
	107
	108	static inline void udp_set_no_check6_rx(struct sock *sk, bool val)
	109	{
	110	udp_sk(sk)->no_check6_rx = val;
	111	}
	112
	113	static inline bool udp_get_no_check6_tx(struct sock *sk)
	114	{
	115	return udp_sk(sk)->no_check6_tx;
	116	}
	117
	118	static inline bool udp_get_no_check6_rx(struct sock *sk)
	119	{
	120	return udp_sk(sk)->no_check6_rx;
	121	}
	122
bcd1665e PA	123	static inline void udp_cmsg_recv(struct msghdr msg, struct sock sk,
	124	struct sk_buff *skb)
	125	{
	126	int gso_size;
	127
	128	if (skb_shinfo(skb)->gso_type & SKB_GSO_UDP_L4) {
	129	gso_size = skb_shinfo(skb)->gso_size;
	130	put_cmsg(msg, SOL_UDP, UDP_GRO, sizeof(gso_size), &gso_size);
	131	}
	132	}
	133
cf329aa4 PA	134	static inline bool udp_unexpected_gso(struct sock sk, struct sk_buff skb)
cf329aa4 PA	135	{
78352f73 PA	136	if (!skb_is_gso(skb))
	137	return false;
	138
	139	if (skb_shinfo(skb)->gso_type & SKB_GSO_UDP_L4 && !udp_sk(sk)->accept_udp_l4)
	140	return true;
	141
	142	if (skb_shinfo(skb)->gso_type & SKB_GSO_FRAGLIST && !udp_sk(sk)->accept_udp_fraglist)
	143	return true;
	144
	145	return false;
cf329aa4 PA	146	}
cf329aa4 PA	147
d18931a9 PA	148	static inline void udp_allow_gso(struct sock *sk)
	149	{
	150	udp_sk(sk)->accept_udp_l4 = 1;
	151	udp_sk(sk)->accept_udp_fraglist = 1;
	152	}
	153
ca065d0c ED	154	#define udp_portaddr_for_each_entry(__sk, list) \
ca065d0c ED	155	hlist_for_each_entry(__sk, list, __sk_common.skc_portaddr_node)
30fff923	156
ca065d0c ED	157	#define udp_portaddr_for_each_entry_rcu(__sk, list) \
ca065d0c ED	158	hlist_for_each_entry_rcu(__sk, list, __sk_common.skc_portaddr_node)
30fff923	159
3d8417d7	160	#define IS_UDPLITE(__sk) (__sk->sk_protocol == IPPROTO_UDPLITE)
1da177e4	161
1da177e4	162	#endif /* _LINUX_UDP_H */