[mirror_ubuntu-zesty-kernel.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 <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 defined(CONFIG_IPV6) || defined (CONFIG_IPV6_MODULE)
		struct inet6_skb_parm	h6;
#endif
	} header;
	__u16		cscov;
	__u8		partial_cov;
};
#define UDP_SKB_CB(__skb)	((struct udp_skb_cb *)((__skb)->cb))

extern struct hlist_head udp_hash[UDP_HTABLE_SIZE];
extern rwlock_t udp_hash_lock;


/* 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;

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->ip_summed != CHECKSUM_UNNECESSARY &&
		__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;
}

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

static inline void udp_lib_unhash(struct sock *sk)
{
	write_lock_bh(&udp_hash_lock);
	if (sk_del_node_init(sk)) {
		inet_sk(sk)->num = 0;
		sock_prot_dec_use(sk->sk_prot);
	}
	write_unlock_bh(&udp_hash_lock);
}

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


/* net/ipv4/udp.c */
extern int	udp_get_port(struct sock *sk, unsigned short snum,
			     int (*saddr_cmp)(const struct sock *, const struct sock *));
extern void	udp_err(struct sk_buff *, u32);

extern int	udp_sendmsg(struct kiocb *iocb, struct sock *sk,
			    struct msghdr *msg, size_t len);

extern int	udp_rcv(struct sk_buff *skb);
extern int	udp_ioctl(struct sock *sk, int cmd, unsigned long arg);
extern int	udp_disconnect(struct sock *sk, int flags);
extern unsigned int udp_poll(struct file *file, struct socket *sock,
			     poll_table *wait);
extern int 	udp_lib_getsockopt(struct sock *sk, int level, int optname,
			           char __user *optval, int __user *optlen);
extern int 	udp_lib_setsockopt(struct sock *sk, int level, int optname,
				   char __user *optval, int optlen,
				   int (*push_pending_frames)(struct sock *));

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

/* /proc */
struct udp_seq_afinfo {
	struct module		*owner;
	char			*name;
	sa_family_t		family;
	struct hlist_head	*hashtable;
	int 			(*seq_show) (struct seq_file *m, void *v);
	struct file_operations	*seq_fops;
};

struct udp_iter_state {
	sa_family_t		family;
	struct hlist_head	*hashtable;
	int			bucket;
	struct seq_operations	seq_ops;
};

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

extern int  udp4_proc_init(void);
extern void udp4_proc_exit(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>
14c85021	26	#include <net/inet_sock.h>
1da177e4 LT	27	#include <net/sock.h>
1da177e4 LT	28	#include <net/snmp.h>
ba4e58ec GR	29	#include <net/ip.h>
ba4e58ec GR	30	#include <linux/ipv6.h>
1da177e4	31	#include <linux/seq_file.h>
bd01f843	32	#include <linux/poll.h>
1da177e4	33
ba4e58ec GR	34	/**
	35	* struct udp_skb_cb - UDP(-Lite) private variables
	36	*
	37	* @header: private variables used by IPv4/IPv6
	38	* @cscov: checksum coverage length (UDP-Lite only)
	39	* @partial_cov: if set indicates partial csum coverage
	40	*/
	41	struct udp_skb_cb {
	42	union {
	43	struct inet_skb_parm h4;
	44	#if defined(CONFIG_IPV6) \|\| defined (CONFIG_IPV6_MODULE)
	45	struct inet6_skb_parm h6;
	46	#endif
	47	} header;
	48	__u16 cscov;
	49	__u8 partial_cov;
	50	};
	51	#define UDP_SKB_CB(__skb) ((struct udp_skb_cb *)((__skb)->cb))
1da177e4	52
1da177e4 LT	53	extern struct hlist_head udp_hash[UDP_HTABLE_SIZE];
	54	extern rwlock_t udp_hash_lock;
	55
1da177e4 LT	56
	57	/* Note: this must match 'valbool' in sock_setsockopt */
	58	#define UDP_CSUM_NOXMIT 1
	59
	60	/* Used by SunRPC/xprt layer. */
	61	#define UDP_CSUM_NORCV 2
	62
	63	/* Default, as per the RFC, is to always do csums. */
	64	#define UDP_CSUM_DEFAULT 0
	65
	66	extern struct proto udp_prot;
	67
14c85021	68	struct sk_buff;
1da177e4	69
ba4e58ec GR	70	/*
	71	* Generic checksumming routines for UDP(-Lite) v4 and v6
	72	*/
b51655b9	73	static inline __sum16 __udp_lib_checksum_complete(struct sk_buff *skb)
ba4e58ec	74	{
759e5d00	75	return __skb_checksum_complete_head(skb, UDP_SKB_CB(skb)->cscov);
ba4e58ec GR	76	}
ba4e58ec GR	77
8e5200f5	78	static inline int udp_lib_checksum_complete(struct sk_buff *skb)
ba4e58ec GR	79	{
	80	return skb->ip_summed != CHECKSUM_UNNECESSARY &&
	81	__udp_lib_checksum_complete(skb);
	82	}
	83
	84	/**
	85	* udp_csum_outgoing - compute UDPv4/v6 checksum over fragments
	86	* @sk: socket we are writing to
	87	* @skb: sk_buff containing the filled-in UDP header
	88	* (checksum field must be zeroed out)
	89	*/
868c86bc	90	static inline __wsum udp_csum_outgoing(struct sock sk, struct sk_buff skb)
ba4e58ec	91	{
9c70220b ACM	92	__wsum csum = csum_partial(skb_transport_header(skb),
9c70220b ACM	93	sizeof(struct udphdr), 0);
ba4e58ec GR	94	skb_queue_walk(&sk->sk_write_queue, skb) {
	95	csum = csum_add(csum, skb->csum);
	96	}
	97	return csum;
	98	}
	99
	100	/* hash routines shared between UDPv4/6 and UDP-Litev4/6 */
	101	static inline void udp_lib_hash(struct sock *sk)
	102	{
	103	BUG();
	104	}
	105
	106	static inline void udp_lib_unhash(struct sock *sk)
	107	{
	108	write_lock_bh(&udp_hash_lock);
	109	if (sk_del_node_init(sk)) {
	110	inet_sk(sk)->num = 0;
	111	sock_prot_dec_use(sk->sk_prot);
	112	}
	113	write_unlock_bh(&udp_hash_lock);
	114	}
	115
	116	static inline void udp_lib_close(struct sock *sk, long timeout)
	117	{
	118	sk_common_release(sk);
	119	}
	120
	121
	122	/* net/ipv4/udp.c */
25030a7f	123	extern int udp_get_port(struct sock *sk, unsigned short snum,
e3b4eadb	124	int (saddr_cmp)(const struct sock , const struct sock *));
1da177e4 LT	125	extern void udp_err(struct sk_buff *, u32);
	126
	127	extern int udp_sendmsg(struct kiocb iocb, struct sock sk,
	128	struct msghdr *msg, size_t len);
	129
	130	extern int udp_rcv(struct sk_buff *skb);
	131	extern int udp_ioctl(struct sock *sk, int cmd, unsigned long arg);
	132	extern int udp_disconnect(struct sock *sk, int flags);
	133	extern unsigned int udp_poll(struct file file, struct socket sock,
	134	poll_table *wait);
4c0a6cb0 GR	135	extern int udp_lib_getsockopt(struct sock *sk, int level, int optname,
	136	char __user optval, int __user optlen);
	137	extern int udp_lib_setsockopt(struct sock *sk, int level, int optname,
	138	char __user *optval, int optlen,
	139	int (push_pending_frames)(struct sock ));
1da177e4 LT	140
1da177e4 LT	141	DECLARE_SNMP_STAT(struct udp_mib, udp_statistics);
ba4e58ec GR	142	/*
	143	* SNMP statistics for UDP and UDP-Lite
	144	*/
	145	#define UDP_INC_STATS_USER(field, is_udplite) do { \
	146	if (is_udplite) SNMP_INC_STATS_USER(udplite_statistics, field); \
	147	else SNMP_INC_STATS_USER(udp_statistics, field); } while(0)
	148	#define UDP_INC_STATS_BH(field, is_udplite) do { \
	149	if (is_udplite) SNMP_INC_STATS_BH(udplite_statistics, field); \
	150	else SNMP_INC_STATS_BH(udp_statistics, field); } while(0)
1da177e4 LT	151
	152	/* /proc */
	153	struct udp_seq_afinfo {
	154	struct module *owner;
	155	char *name;
	156	sa_family_t family;
ba4e58ec	157	struct hlist_head *hashtable;
1da177e4 LT	158	int (seq_show) (struct seq_file m, void *v);
	159	struct file_operations *seq_fops;
	160	};
	161
	162	struct udp_iter_state {
	163	sa_family_t family;
ba4e58ec	164	struct hlist_head *hashtable;
1da177e4 LT	165	int bucket;
	166	struct seq_operations seq_ops;
	167	};
	168
20380731	169	#ifdef CONFIG_PROC_FS
1da177e4 LT	170	extern int udp_proc_register(struct udp_seq_afinfo *afinfo);
1da177e4 LT	171	extern void udp_proc_unregister(struct udp_seq_afinfo *afinfo);
20380731 ACM	172
	173	extern int udp4_proc_init(void);
	174	extern void udp4_proc_exit(void);
	175	#endif
1da177e4	176	#endif /* _UDP_H */