[mirror_ubuntu-bionic-kernel.git] / include / linux / udp.h

/*
 * 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>
 *
 *		This program is free software; you can redistribute it and/or
 *		modify it under the terms of the GNU General Public License
 *		as published by the Free Software Foundation; either version
 *		2 of the License, or (at your option) any later version.
 */
#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? */
	/*
	 * Following member retains the information to create a UDP header
	 * when the socket is uncorked.
	 */
	__u16		 len;		/* total length of pending frames */
	/*
	 * 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_destroy)(struct sock *sk);

	/* GRO functions for UDP socket */
	struct sk_buff **	(*gro_receive)(struct sock *sk,
					       struct sk_buff **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;
};

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

#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
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 protocol.
	7	*
	8	* Version: @(#)udp.h 1.0.2 04/28/93
	9	*
	10	* Author: Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
	11	*
	12	* This program is free software; you can redistribute it and/or
	13	* modify it under the terms of the GNU General Public License
	14	* as published by the Free Software Foundation; either version
	15	* 2 of the License, or (at your option) any later version.
	16	*/
	17	#ifndef _LINUX_UDP_H
	18	#define _LINUX_UDP_H
	19
14c85021	20	#include <net/inet_sock.h>
310afe86	21	#include <linux/skbuff.h>
0b441916	22	#include <net/netns/hash.h>
607ca46e	23	#include <uapi/linux/udp.h>
310afe86 JP	24
	25	static inline struct udphdr udp_hdr(const struct sk_buff skb)
	26	{
	27	return (struct udphdr *)skb_transport_header(skb);
	28	}
	29
6a674e9c JG	30	static inline struct udphdr inner_udp_hdr(const struct sk_buff skb)
	31	{
	32	return (struct udphdr *)skb_inner_transport_header(skb);
	33	}
	34
f86dcc5a	35	#define UDP_HTABLE_SIZE_MIN (CONFIG_BASE_SMALL ? 128 : 256)
1da177e4	36
6eada011	37	static inline u32 udp_hashfn(const struct net *net, u32 num, u32 mask)
d6266281	38	{
f86dcc5a	39	return (num + net_hash_mix(net)) & mask;
d6266281 PE	40	}
d6266281 PE	41
1da177e4 LT	42	struct udp_sock {
	43	/* inet_sock has to be the first member */
	44	struct inet_sock inet;
d4cada4a ED	45	#define udp_port_hash inet.sk.__sk_common.skc_u16hashes[0]
d4cada4a ED	46	#define udp_portaddr_hash inet.sk.__sk_common.skc_u16hashes[1]
512615b6	47	#define udp_portaddr_node inet.sk.__sk_common.skc_portaddr_node
1da177e4 LT	48	int pending; /* Any pending frames ? */
1da177e4 LT	49	unsigned int corkflag; /* Cork is required */
1c19448c TH	50	__u8 encap_type; /* Is this an Encapsulation socket? */
1c19448c TH	51	unsigned char no_check6_tx:1,/* Send zero UDP6 checksums on TX? */
224d019c	52	no_check6_rx:1;/* Allow zero UDP6 checksums on RX? */
1da177e4	53	/*
47bdd718	54	* Following member retains the information to create a UDP header
1da177e4 LT	55	* when the socket is uncorked.
	56	*/
	57	__u16 len; /* total length of pending frames */
ba4e58ec GR	58	/*
	59	* Fields specific to UDP-Lite.
	60	*/
	61	__u16 pcslen;
	62	__u16 pcrlen;
	63	/* indicator bits used by pcflag: */
	64	#define UDPLITE_BIT 0x1 /* set by udplite proto init function */
	65	#define UDPLITE_SEND_CC 0x2 /* set via udplite setsockopt */
	66	#define UDPLITE_RECV_CC 0x4 /* set via udplite setsocktopt */
	67	__u8 pcflag; /* marks socket as UDP-Lite if > 0 */
342f0234 JC	68	__u8 unused[3];
	69	/*
	70	* For encapsulation sockets.
	71	*/
	72	int (encap_rcv)(struct sock sk, struct sk_buff *skb);
44046a59	73	void (encap_destroy)(struct sock sk);
a6024562 TH	74
	75	/* GRO functions for UDP socket */
	76	struct sk_buff ** (gro_receive)(struct sock sk,
	77	struct sk_buff **head,
	78	struct sk_buff *skb);
	79	int (gro_complete)(struct sock sk,
	80	struct sk_buff *skb,
	81	int nhoff);
6b229cf7	82
2276f58a PA	83	/* udp_recvmsg try to use this before splicing sk_receive_queue */
	84	struct sk_buff_head reader_queue ____cacheline_aligned_in_smp;
	85
6b229cf7 ED	86	/* This field is dirtied by udp_recvmsg() */
6b229cf7 ED	87	int forward_deficit;
1da177e4 LT	88	};
	89
	90	static inline struct udp_sock udp_sk(const struct sock sk)
	91	{
	92	return (struct udp_sock *)sk;
	93	}
e898d4db	94
1c19448c TH	95	static inline void udp_set_no_check6_tx(struct sock *sk, bool val)
	96	{
	97	udp_sk(sk)->no_check6_tx = val;
	98	}
	99
	100	static inline void udp_set_no_check6_rx(struct sock *sk, bool val)
	101	{
	102	udp_sk(sk)->no_check6_rx = val;
	103	}
	104
	105	static inline bool udp_get_no_check6_tx(struct sock *sk)
	106	{
	107	return udp_sk(sk)->no_check6_tx;
	108	}
	109
	110	static inline bool udp_get_no_check6_rx(struct sock *sk)
	111	{
	112	return udp_sk(sk)->no_check6_rx;
	113	}
	114
ca065d0c ED	115	#define udp_portaddr_for_each_entry(__sk, list) \
ca065d0c ED	116	hlist_for_each_entry(__sk, list, __sk_common.skc_portaddr_node)
30fff923	117
ca065d0c ED	118	#define udp_portaddr_for_each_entry_rcu(__sk, list) \
ca065d0c ED	119	hlist_for_each_entry_rcu(__sk, list, __sk_common.skc_portaddr_node)
30fff923	120
3d8417d7	121	#define IS_UDPLITE(__sk) (__sk->sk_protocol == IPPROTO_UDPLITE)
1da177e4	122
1da177e4	123	#endif /* _LINUX_UDP_H */