[deliverable/linux.git] / include / net / 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 module.
 *
 * Version:	@(#)udp.h	1.0.2	05/07/93
 *
 * Authors:	Ross Biro
 *		Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
 *
 * Fixes:
 *		Alan Cox	: Turned on udp checksums. I don't want to
 *				  chase 'memory corruption' bugs that aren't!
 *
 *		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 _UDP_H
#define _UDP_H

#include <linux/list.h>
#include <linux/bug.h>
#include <net/inet_sock.h>
#include <net/sock.h>
#include <net/snmp.h>
#include <net/ip.h>
#include <linux/ipv6.h>
#include <linux/seq_file.h>
#include <linux/poll.h>

/**
 *	struct udp_skb_cb  -  UDP(-Lite) private variables
 *
 *	@header:      private variables used by IPv4/IPv6
 *	@cscov:       checksum coverage length (UDP-Lite only)
 *	@partial_cov: if set indicates partial csum coverage
 */
struct udp_skb_cb {
	union {
		struct inet_skb_parm	h4;
#if IS_ENABLED(CONFIG_IPV6)
		struct inet6_skb_parm	h6;
#endif
	} header;
	__u16		cscov;
	__u8		partial_cov;
};
#define UDP_SKB_CB(__skb)	((struct udp_skb_cb *)((__skb)->cb))

/**
 *	struct udp_hslot - UDP hash slot
 *
 *	@head:	head of list of sockets
 *	@count:	number of sockets in 'head' list
 *	@lock:	spinlock protecting changes to head/count
 */
struct udp_hslot {
	struct hlist_nulls_head	head;
	int			count;
	spinlock_t		lock;
} __attribute__((aligned(2 * sizeof(long))));

/**
 *	struct udp_table - UDP table
 *
 *	@hash:	hash table, sockets are hashed on (local port)
 *	@hash2:	hash table, sockets are hashed on (local port, local address)
 *	@mask:	number of slots in hash tables, minus 1
 *	@log:	log2(number of slots in hash table)
 */
struct udp_table {
	struct udp_hslot	*hash;
	struct udp_hslot	*hash2;
	unsigned int		mask;
	unsigned int		log;
};
extern struct udp_table udp_table;
void udp_table_init(struct udp_table *, const char *);
static inline struct udp_hslot *udp_hashslot(struct udp_table *table,
					     struct net *net, unsigned int num)
{
	return &table->hash[udp_hashfn(net, num, table->mask)];
}
/*
 * For secondary hash, net_hash_mix() is performed before calling
 * udp_hashslot2(), this explains difference with udp_hashslot()
 */
static inline struct udp_hslot *udp_hashslot2(struct udp_table *table,
					      unsigned int hash)
{
	return &table->hash2[hash & table->mask];
}

/* Note: this must match 'valbool' in sock_setsockopt */
#define UDP_CSUM_NOXMIT		1

/* Used by SunRPC/xprt layer. */
#define UDP_CSUM_NORCV		2

/* Default, as per the RFC, is to always do csums. */
#define UDP_CSUM_DEFAULT	0

extern struct proto udp_prot;

extern atomic_long_t udp_memory_allocated;

/* sysctl variables for udp */
extern long sysctl_udp_mem[3];
extern int sysctl_udp_rmem_min;
extern int sysctl_udp_wmem_min;

struct sk_buff;

/*
 *	Generic checksumming routines for UDP(-Lite) v4 and v6
 */
static inline __sum16 __udp_lib_checksum_complete(struct sk_buff *skb)
{
	return __skb_checksum_complete_head(skb, UDP_SKB_CB(skb)->cscov);
}

static inline int udp_lib_checksum_complete(struct sk_buff *skb)
{
	return !skb_csum_unnecessary(skb) &&
		__udp_lib_checksum_complete(skb);
}

/**
 * 	udp_csum_outgoing  -  compute UDPv4/v6 checksum over fragments
 * 	@sk: 	socket we are writing to
 * 	@skb: 	sk_buff containing the filled-in UDP header
 * 	        (checksum field must be zeroed out)
 */
static inline __wsum udp_csum_outgoing(struct sock *sk, struct sk_buff *skb)
{
	__wsum csum = csum_partial(skb_transport_header(skb),
				   sizeof(struct udphdr), 0);
	skb_queue_walk(&sk->sk_write_queue, skb) {
		csum = csum_add(csum, skb->csum);
	}
	return csum;
}

static inline __wsum udp_csum(struct sk_buff *skb)
{
	__wsum csum = csum_partial(skb_transport_header(skb),
				   sizeof(struct udphdr), skb->csum);

	for (skb = skb_shinfo(skb)->frag_list; skb; skb = skb->next) {
		csum = csum_add(csum, skb->csum);
	}
	return csum;
}

/* hash routines shared between UDPv4/6 and UDP-Litev4/6 */
static inline void udp_lib_hash(struct sock *sk)
{
	BUG();
}

void udp_lib_unhash(struct sock *sk);
void udp_lib_rehash(struct sock *sk, u16 new_hash);

static inline void udp_lib_close(struct sock *sk, long timeout)
{
	sk_common_release(sk);
}

int udp_lib_get_port(struct sock *sk, unsigned short snum,
		     int (*)(const struct sock *, const struct sock *),
		     unsigned int hash2_nulladdr);

/* net/ipv4/udp.c */
int udp_get_port(struct sock *sk, unsigned short snum,
		 int (*saddr_cmp)(const struct sock *,
				  const struct sock *));
void udp_err(struct sk_buff *, u32);
int udp_sendmsg(struct kiocb *iocb, struct sock *sk, struct msghdr *msg,
		size_t len);
int udp_push_pending_frames(struct sock *sk);
void udp_flush_pending_frames(struct sock *sk);
void udp4_hwcsum(struct sk_buff *skb, __be32 src, __be32 dst);
int udp_rcv(struct sk_buff *skb);
int udp_ioctl(struct sock *sk, int cmd, unsigned long arg);
int udp_disconnect(struct sock *sk, int flags);
unsigned int udp_poll(struct file *file, struct socket *sock, poll_table *wait);
struct sk_buff *skb_udp_tunnel_segment(struct sk_buff *skb,
				       netdev_features_t features);
int udp_lib_getsockopt(struct sock *sk, int level, int optname,
		       char __user *optval, int __user *optlen);
int udp_lib_setsockopt(struct sock *sk, int level, int optname,
		       char __user *optval, unsigned int optlen,
		       int (*push_pending_frames)(struct sock *));
struct sock *udp4_lib_lookup(struct net *net, __be32 saddr, __be16 sport,
			     __be32 daddr, __be16 dport, int dif);
struct sock *__udp4_lib_lookup(struct net *net, __be32 saddr, __be16 sport,
			       __be32 daddr, __be16 dport, int dif,
			       struct udp_table *tbl);
struct sock *udp6_lib_lookup(struct net *net,
			     const struct in6_addr *saddr, __be16 sport,
			     const struct in6_addr *daddr, __be16 dport,
			     int dif);
struct sock *__udp6_lib_lookup(struct net *net,
			       const struct in6_addr *saddr, __be16 sport,
			       const struct in6_addr *daddr, __be16 dport,
			       int dif, struct udp_table *tbl);

/*
 * 	SNMP statistics for UDP and UDP-Lite
 */
#define UDP_INC_STATS_USER(net, field, is_udplite)	      do { \
	if (is_udplite) SNMP_INC_STATS_USER((net)->mib.udplite_statistics, field);       \
	else		SNMP_INC_STATS_USER((net)->mib.udp_statistics, field);  }  while(0)
#define UDP_INC_STATS_BH(net, field, is_udplite) 	      do { \
	if (is_udplite) SNMP_INC_STATS_BH((net)->mib.udplite_statistics, field);         \
	else		SNMP_INC_STATS_BH((net)->mib.udp_statistics, field);    }  while(0)

#define UDP6_INC_STATS_BH(net, field, is_udplite) 	    do { \
	if (is_udplite) SNMP_INC_STATS_BH((net)->mib.udplite_stats_in6, field);\
	else		SNMP_INC_STATS_BH((net)->mib.udp_stats_in6, field);  \
} while(0)
#define UDP6_INC_STATS_USER(net, field, __lite)		    do { \
	if (__lite) SNMP_INC_STATS_USER((net)->mib.udplite_stats_in6, field);  \
	else	    SNMP_INC_STATS_USER((net)->mib.udp_stats_in6, field);      \
} while(0)

#if IS_ENABLED(CONFIG_IPV6)
#define UDPX_INC_STATS_BH(sk, field) \
	do { \
		if ((sk)->sk_family == AF_INET) \
			UDP_INC_STATS_BH(sock_net(sk), field, 0); \
		else \
			UDP6_INC_STATS_BH(sock_net(sk), field, 0); \
	} while (0);
#else
#define UDPX_INC_STATS_BH(sk, field) UDP_INC_STATS_BH(sock_net(sk), field, 0)
#endif

/* /proc */
int udp_seq_open(struct inode *inode, struct file *file);

struct udp_seq_afinfo {
	char				*name;
	sa_family_t			family;
	struct udp_table		*udp_table;
	const struct file_operations	*seq_fops;
	struct seq_operations		seq_ops;
};

struct udp_iter_state {
	struct seq_net_private  p;
	sa_family_t		family;
	int			bucket;
	struct udp_table	*udp_table;
};

#ifdef CONFIG_PROC_FS
int udp_proc_register(struct net *net, struct udp_seq_afinfo *afinfo);
void udp_proc_unregister(struct net *net, struct udp_seq_afinfo *afinfo);

int udp4_proc_init(void);
void udp4_proc_exit(void);
#endif

int udpv4_offload_init(void);

void udp_init(void);

void udp_encap_enable(void);
#if IS_ENABLED(CONFIG_IPV6)
void udpv6_encap_enable(void);
#endif
#endif	/* _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 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>
1da177e4 LT	29	#include <net/snmp.h>
ba4e58ec GR	30	#include <net/ip.h>
ba4e58ec GR	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 {
88ab1932	62	struct hlist_nulls_head head;
fdcc8aa9	63	int count;
645ca708 ED	64	spinlock_t lock;
645ca708 ED	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	};
645ca708 ED	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 LT	97
	98	/* Note: this must match 'valbool' in sock_setsockopt */
	99	#define UDP_CSUM_NOXMIT 1
	100
	101	/* Used by SunRPC/xprt layer. */
	102	#define UDP_CSUM_NORCV 2
	103
	104	/* Default, as per the RFC, is to always do csums. */
	105	#define UDP_CSUM_DEFAULT 0
	106
	107	extern struct proto udp_prot;
	108
8d987e5c	109	extern atomic_long_t udp_memory_allocated;
95766fff HA	110
95766fff HA	111	/* sysctl variables for udp */
8d987e5c	112	extern long sysctl_udp_mem[3];
95766fff HA	113	extern int sysctl_udp_rmem_min;
	114	extern int sysctl_udp_wmem_min;
	115
14c85021	116	struct sk_buff;
1da177e4	117
ba4e58ec GR	118	/*
	119	* Generic checksumming routines for UDP(-Lite) v4 and v6
	120	*/
b51655b9	121	static inline __sum16 __udp_lib_checksum_complete(struct sk_buff *skb)
ba4e58ec	122	{
759e5d00	123	return __skb_checksum_complete_head(skb, UDP_SKB_CB(skb)->cscov);
ba4e58ec GR	124	}
ba4e58ec GR	125
8e5200f5	126	static inline int udp_lib_checksum_complete(struct sk_buff *skb)
ba4e58ec	127	{
60476372	128	return !skb_csum_unnecessary(skb) &&
ba4e58ec GR	129	__udp_lib_checksum_complete(skb);
	130	}
	131
	132	/**
	133	* udp_csum_outgoing - compute UDPv4/v6 checksum over fragments
	134	* @sk: socket we are writing to
	135	* @skb: sk_buff containing the filled-in UDP header
	136	* (checksum field must be zeroed out)
	137	*/
868c86bc	138	static inline __wsum udp_csum_outgoing(struct sock sk, struct sk_buff skb)
ba4e58ec	139	{
9c70220b ACM	140	__wsum csum = csum_partial(skb_transport_header(skb),
9c70220b ACM	141	sizeof(struct udphdr), 0);
ba4e58ec GR	142	skb_queue_walk(&sk->sk_write_queue, skb) {
	143	csum = csum_add(csum, skb->csum);
	144	}
	145	return csum;
	146	}
	147
f6b9664f HX	148	static inline __wsum udp_csum(struct sk_buff *skb)
	149	{
	150	__wsum csum = csum_partial(skb_transport_header(skb),
	151	sizeof(struct udphdr), skb->csum);
	152
	153	for (skb = skb_shinfo(skb)->frag_list; skb; skb = skb->next) {
	154	csum = csum_add(csum, skb->csum);
	155	}
	156	return csum;
	157	}
	158
ba4e58ec GR	159	/* hash routines shared between UDPv4/6 and UDP-Litev4/6 */
	160	static inline void udp_lib_hash(struct sock *sk)
	161	{
	162	BUG();
	163	}
	164
1a50bd06 JP	165	void udp_lib_unhash(struct sock *sk);
1a50bd06 JP	166	void udp_lib_rehash(struct sock *sk, u16 new_hash);
ba4e58ec GR	167
	168	static inline void udp_lib_close(struct sock *sk, long timeout)
	169	{
	170	sk_common_release(sk);
	171	}
	172
1a50bd06 JP	173	int udp_lib_get_port(struct sock *sk, unsigned short snum,
	174	int ()(const struct sock , const struct sock *),
	175	unsigned int hash2_nulladdr);
ba4e58ec GR	176
ba4e58ec GR	177	/* net/ipv4/udp.c */
1a50bd06 JP	178	int udp_get_port(struct sock *sk, unsigned short snum,
	179	int (saddr_cmp)(const struct sock ,
	180	const struct sock *));
	181	void udp_err(struct sk_buff *, u32);
	182	int udp_sendmsg(struct kiocb iocb, struct sock sk, struct msghdr *msg,
	183	size_t len);
	184	int udp_push_pending_frames(struct sock *sk);
	185	void udp_flush_pending_frames(struct sock *sk);
	186	void udp4_hwcsum(struct sk_buff *skb, __be32 src, __be32 dst);
	187	int udp_rcv(struct sk_buff *skb);
	188	int udp_ioctl(struct sock *sk, int cmd, unsigned long arg);
	189	int udp_disconnect(struct sock *sk, int flags);
	190	unsigned int udp_poll(struct file file, struct socket sock, poll_table *wait);
	191	struct sk_buff skb_udp_tunnel_segment(struct sk_buff skb,
	192	netdev_features_t features);
	193	int udp_lib_getsockopt(struct sock *sk, int level, int optname,
	194	char __user optval, int __user optlen);
	195	int udp_lib_setsockopt(struct sock *sk, int level, int optname,
	196	char __user *optval, unsigned int optlen,
	197	int (push_pending_frames)(struct sock ));
	198	struct sock udp4_lib_lookup(struct net net, __be32 saddr, __be16 sport,
	199	__be32 daddr, __be16 dport, int dif);
	200	struct sock __udp4_lib_lookup(struct net net, __be32 saddr, __be16 sport,
	201	__be32 daddr, __be16 dport, int dif,
	202	struct udp_table *tbl);
	203	struct sock udp6_lib_lookup(struct net net,
	204	const struct in6_addr *saddr, __be16 sport,
	205	const struct in6_addr *daddr, __be16 dport,
	206	int dif);
	207	struct sock __udp6_lib_lookup(struct net net,
	208	const struct in6_addr *saddr, __be16 sport,
	209	const struct in6_addr *daddr, __be16 dport,
	210	int dif, struct udp_table *tbl);
bcd41303	211
ba4e58ec GR	212	/*
	213	* SNMP statistics for UDP and UDP-Lite
	214	*/
2f275f91	215	#define UDP_INC_STATS_USER(net, field, is_udplite) do { \
386019d3	216	if (is_udplite) SNMP_INC_STATS_USER((net)->mib.udplite_statistics, field); \
2f275f91 PE	217	else SNMP_INC_STATS_USER((net)->mib.udp_statistics, field); } while(0)
2f275f91 PE	218	#define UDP_INC_STATS_BH(net, field, is_udplite) do { \
386019d3	219	if (is_udplite) SNMP_INC_STATS_BH((net)->mib.udplite_statistics, field); \
2f275f91	220	else SNMP_INC_STATS_BH((net)->mib.udp_statistics, field); } while(0)
1da177e4	221
0c7ed677	222	#define UDP6_INC_STATS_BH(net, field, is_udplite) do { \
be713a44	223	if (is_udplite) SNMP_INC_STATS_BH((net)->mib.udplite_stats_in6, field);\
0c7ed677 DL	224	else SNMP_INC_STATS_BH((net)->mib.udp_stats_in6, field); \
0c7ed677 DL	225	} while(0)
be713a44 DL	226	#define UDP6_INC_STATS_USER(net, field, __lite) do { \
	227	if (__lite) SNMP_INC_STATS_USER((net)->mib.udplite_stats_in6, field); \
	228	else SNMP_INC_STATS_USER((net)->mib.udp_stats_in6, field); \
0c7ed677	229	} while(0)
1781f7f5	230
dfd56b8b	231	#if IS_ENABLED(CONFIG_IPV6)
1781f7f5 HX	232	#define UDPX_INC_STATS_BH(sk, field) \
	233	do { \
	234	if ((sk)->sk_family == AF_INET) \
0283328e	235	UDP_INC_STATS_BH(sock_net(sk), field, 0); \
1781f7f5	236	else \
ef28d1a2	237	UDP6_INC_STATS_BH(sock_net(sk), field, 0); \
1781f7f5 HX	238	} while (0);
1781f7f5 HX	239	#else
0283328e	240	#define UDPX_INC_STATS_BH(sk, field) UDP_INC_STATS_BH(sock_net(sk), field, 0)
1781f7f5 HX	241	#endif
1781f7f5 HX	242
1da177e4	243	/* /proc */
73cb88ec AV	244	int udp_seq_open(struct inode inode, struct file file);
73cb88ec AV	245
1da177e4	246	struct udp_seq_afinfo {
73cb88ec AV	247	char *name;
	248	sa_family_t family;
	249	struct udp_table *udp_table;
	250	const struct file_operations *seq_fops;
	251	struct seq_operations seq_ops;
1da177e4 LT	252	};
	253
	254	struct udp_iter_state {
6f191efe	255	struct seq_net_private p;
1da177e4 LT	256	sa_family_t family;
1da177e4 LT	257	int bucket;
645ca708	258	struct udp_table *udp_table;
1da177e4 LT	259	};
1da177e4 LT	260
20380731	261	#ifdef CONFIG_PROC_FS
1a50bd06 JP	262	int udp_proc_register(struct net net, struct udp_seq_afinfo afinfo);
1a50bd06 JP	263	void udp_proc_unregister(struct net net, struct udp_seq_afinfo afinfo);
20380731	264
1a50bd06 JP	265	int udp4_proc_init(void);
1a50bd06 JP	266	void udp4_proc_exit(void);
20380731	267	#endif
95766fff	268
1a50bd06	269	int udpv4_offload_init(void);
da5bab07	270
1a50bd06	271	void udp_init(void);
d7ca4cc0	272
1a50bd06	273	void udp_encap_enable(void);
d7f3f621	274	#if IS_ENABLED(CONFIG_IPV6)
1a50bd06	275	void udpv6_encap_enable(void);
d7f3f621	276	#endif
1da177e4	277	#endif /* _UDP_H */