[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, <[email protected]>
 *
 * 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;

extern atomic_t udp_memory_allocated;

/* sysctl variables for udp */
extern int 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;
}

/* 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_inuse_add(sock_net(sk), sk->sk_prot, -1);
	}
	write_unlock_bh(&udp_hash_lock);
}

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

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

/* 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 void	udp_flush_pending_frames(struct sock *sk);

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);
DECLARE_SNMP_STAT(struct udp_mib, udp_stats_in6);

/* UDP-Lite does not have a standardized MIB yet, so we inherit from UDP */
DECLARE_SNMP_STAT(struct udp_mib, udplite_statistics);
DECLARE_SNMP_STAT(struct udp_mib, udplite_stats_in6);

/*
 * 	SNMP statistics for UDP and UDP-Lite
 */
#define UDP_INC_STATS_USER(net, field, is_udplite)	      do { (void)net; \
	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(net, field, is_udplite) 	      do { (void)net; \
	if (is_udplite) SNMP_INC_STATS_BH(udplite_statistics, field);         \
	else		SNMP_INC_STATS_BH(udp_statistics, field);    }  while(0)

#define UDP6_INC_STATS_BH(field, is_udplite) 			      do  {  \
	if (is_udplite) SNMP_INC_STATS_BH(udplite_stats_in6, field);         \
	else		SNMP_INC_STATS_BH(udp_stats_in6, field);    } while(0)
#define UDP6_INC_STATS_USER(net, field, is_udplite)	    do { (void)net;    \
	if (is_udplite) SNMP_INC_STATS_USER(udplite_stats_in6, field);         \
	else		SNMP_INC_STATS_USER(udp_stats_in6, field);    } while(0)

#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
#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(field, 0); \
	} while (0);
#else
#define UDPX_INC_STATS_BH(sk, field) UDP_INC_STATS_BH(sock_net(sk), field, 0)
#endif

/* /proc */
struct udp_seq_afinfo {
	char			*name;
	sa_family_t		family;
	struct hlist_head	*hashtable;
	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 hlist_head	*hashtable;
};

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

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

extern void udp_init(void);
#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, <[email protected]>
	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
95766fff HA	68	extern atomic_t udp_memory_allocated;
	69
	70	/* sysctl variables for udp */
	71	extern int sysctl_udp_mem[3];
	72	extern int sysctl_udp_rmem_min;
	73	extern int sysctl_udp_wmem_min;
	74
14c85021	75	struct sk_buff;
1da177e4	76
ba4e58ec GR	77	/*
	78	* Generic checksumming routines for UDP(-Lite) v4 and v6
	79	*/
b51655b9	80	static inline __sum16 __udp_lib_checksum_complete(struct sk_buff *skb)
ba4e58ec	81	{
759e5d00	82	return __skb_checksum_complete_head(skb, UDP_SKB_CB(skb)->cscov);
ba4e58ec GR	83	}
ba4e58ec GR	84
8e5200f5	85	static inline int udp_lib_checksum_complete(struct sk_buff *skb)
ba4e58ec	86	{
60476372	87	return !skb_csum_unnecessary(skb) &&
ba4e58ec GR	88	__udp_lib_checksum_complete(skb);
	89	}
	90
	91	/**
	92	* udp_csum_outgoing - compute UDPv4/v6 checksum over fragments
	93	* @sk: socket we are writing to
	94	* @skb: sk_buff containing the filled-in UDP header
	95	* (checksum field must be zeroed out)
	96	*/
868c86bc	97	static inline __wsum udp_csum_outgoing(struct sock sk, struct sk_buff skb)
ba4e58ec	98	{
9c70220b ACM	99	__wsum csum = csum_partial(skb_transport_header(skb),
9c70220b ACM	100	sizeof(struct udphdr), 0);
ba4e58ec GR	101	skb_queue_walk(&sk->sk_write_queue, skb) {
	102	csum = csum_add(csum, skb->csum);
	103	}
	104	return csum;
	105	}
	106
	107	/* hash routines shared between UDPv4/6 and UDP-Litev4/6 */
	108	static inline void udp_lib_hash(struct sock *sk)
	109	{
	110	BUG();
	111	}
	112
	113	static inline void udp_lib_unhash(struct sock *sk)
	114	{
	115	write_lock_bh(&udp_hash_lock);
	116	if (sk_del_node_init(sk)) {
	117	inet_sk(sk)->num = 0;
c29a0bc4	118	sock_prot_inuse_add(sock_net(sk), sk->sk_prot, -1);
ba4e58ec GR	119	}
	120	write_unlock_bh(&udp_hash_lock);
	121	}
	122
	123	static inline void udp_lib_close(struct sock *sk, long timeout)
	124	{
	125	sk_common_release(sk);
	126	}
	127
6ba5a3c5 PE	128	extern int udp_lib_get_port(struct sock *sk, unsigned short snum,
6ba5a3c5 PE	129	int ()(const struct sock,const struct sock*));
ba4e58ec GR	130
ba4e58ec GR	131	/* net/ipv4/udp.c */
25030a7f	132	extern int udp_get_port(struct sock *sk, unsigned short snum,
df2bc459	133	int (saddr_cmp)(const struct sock , const struct sock *));
1da177e4 LT	134	extern void udp_err(struct sk_buff *, u32);
	135
	136	extern int udp_sendmsg(struct kiocb iocb, struct sock sk,
	137	struct msghdr *msg, size_t len);
36d926b9	138	extern void udp_flush_pending_frames(struct sock *sk);
1da177e4 LT	139
	140	extern int udp_rcv(struct sk_buff *skb);
	141	extern int udp_ioctl(struct sock *sk, int cmd, unsigned long arg);
	142	extern int udp_disconnect(struct sock *sk, int flags);
	143	extern unsigned int udp_poll(struct file file, struct socket sock,
	144	poll_table *wait);
4c0a6cb0 GR	145	extern int udp_lib_getsockopt(struct sock *sk, int level, int optname,
	146	char __user optval, int __user optlen);
	147	extern int udp_lib_setsockopt(struct sock *sk, int level, int optname,
	148	char __user *optval, int optlen,
	149	int (push_pending_frames)(struct sock ));
1da177e4 LT	150
1da177e4 LT	151	DECLARE_SNMP_STAT(struct udp_mib, udp_statistics);
1781f7f5 HX	152	DECLARE_SNMP_STAT(struct udp_mib, udp_stats_in6);
	153
	154	/* UDP-Lite does not have a standardized MIB yet, so we inherit from UDP */
	155	DECLARE_SNMP_STAT(struct udp_mib, udplite_statistics);
	156	DECLARE_SNMP_STAT(struct udp_mib, udplite_stats_in6);
	157
ba4e58ec GR	158	/*
	159	* SNMP statistics for UDP and UDP-Lite
	160	*/
629ca23c	161	#define UDP_INC_STATS_USER(net, field, is_udplite) do { (void)net; \
ba4e58ec GR	162	if (is_udplite) SNMP_INC_STATS_USER(udplite_statistics, field); \
ba4e58ec GR	163	else SNMP_INC_STATS_USER(udp_statistics, field); } while(0)
0283328e	164	#define UDP_INC_STATS_BH(net, field, is_udplite) do { (void)net; \
ba4e58ec GR	165	if (is_udplite) SNMP_INC_STATS_BH(udplite_statistics, field); \
ba4e58ec GR	166	else SNMP_INC_STATS_BH(udp_statistics, field); } while(0)
1da177e4	167
1781f7f5 HX	168	#define UDP6_INC_STATS_BH(field, is_udplite) do { \
	169	if (is_udplite) SNMP_INC_STATS_BH(udplite_stats_in6, field); \
	170	else SNMP_INC_STATS_BH(udp_stats_in6, field); } while(0)
235b9f7a	171	#define UDP6_INC_STATS_USER(net, field, is_udplite) do { (void)net; \
1781f7f5 HX	172	if (is_udplite) SNMP_INC_STATS_USER(udplite_stats_in6, field); \
	173	else SNMP_INC_STATS_USER(udp_stats_in6, field); } while(0)
	174
	175	#if defined(CONFIG_IPV6) \|\| defined(CONFIG_IPV6_MODULE)
	176	#define UDPX_INC_STATS_BH(sk, field) \
	177	do { \
	178	if ((sk)->sk_family == AF_INET) \
0283328e	179	UDP_INC_STATS_BH(sock_net(sk), field, 0); \
1781f7f5 HX	180	else \
	181	UDP6_INC_STATS_BH(field, 0); \
	182	} while (0);
	183	#else
0283328e	184	#define UDPX_INC_STATS_BH(sk, field) UDP_INC_STATS_BH(sock_net(sk), field, 0)
1781f7f5 HX	185	#endif
1781f7f5 HX	186
1da177e4 LT	187	/* /proc */
1da177e4 LT	188	struct udp_seq_afinfo {
1da177e4 LT	189	char *name;
1da177e4 LT	190	sa_family_t family;
ba4e58ec	191	struct hlist_head *hashtable;
3ba9441b	192	struct file_operations seq_fops;
dda61925	193	struct seq_operations seq_ops;
1da177e4 LT	194	};
	195
	196	struct udp_iter_state {
6f191efe	197	struct seq_net_private p;
1da177e4 LT	198	sa_family_t family;
1da177e4 LT	199	int bucket;
875ec433	200	struct hlist_head *hashtable;
1da177e4 LT	201	};
1da177e4 LT	202
20380731	203	#ifdef CONFIG_PROC_FS
0c96d8c5 DL	204	extern int udp_proc_register(struct net net, struct udp_seq_afinfo afinfo);
0c96d8c5 DL	205	extern void udp_proc_unregister(struct net net, struct udp_seq_afinfo afinfo);
20380731 ACM	206
	207	extern int udp4_proc_init(void);
	208	extern void udp4_proc_exit(void);
	209	#endif
95766fff HA	210
95766fff HA	211	extern void udp_init(void);
1da177e4	212	#endif /* _UDP_H */