[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 <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))

struct udp_hslot {
	struct hlist_nulls_head	head;
	spinlock_t		lock;
} __attribute__((aligned(2 * sizeof(long))));

struct udp_table {
	struct udp_hslot	*hash;
	unsigned int mask;
	unsigned int log;
};
extern struct udp_table udp_table;
extern void udp_table_init(struct udp_table *, const char *);
static inline struct udp_hslot *udp_hashslot(struct udp_table *table,
					     struct net *net, unsigned num)
{
	return &table->hash[udp_hashfn(net, num, 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_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();
}

extern void udp_lib_unhash(struct sock *sk);

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, unsigned int optlen,
				   int (*push_pending_frames)(struct sock *));

extern struct sock *udp4_lib_lookup(struct net *net, __be32 saddr, __be16 sport,
				    __be32 daddr, __be16 dport,
				    int dif);

/*
 * 	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 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(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 */
struct udp_seq_afinfo {
	char			*name;
	sa_family_t		family;
	struct udp_table	*udp_table;
	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
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);

extern int udp4_ufo_send_check(struct sk_buff *skb);
extern struct sk_buff *udp4_ufo_fragment(struct sk_buff *skb, int features);
#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
645ca708	53	struct udp_hslot {
88ab1932	54	struct hlist_nulls_head head;
645ca708 ED	55	spinlock_t lock;
645ca708 ED	56	} __attribute__((aligned(2 * sizeof(long))));
f86dcc5a	57
645ca708	58	struct udp_table {
f86dcc5a ED	59	struct udp_hslot *hash;
	60	unsigned int mask;
	61	unsigned int log;
645ca708 ED	62	};
645ca708 ED	63	extern struct udp_table udp_table;
f86dcc5a ED	64	extern void udp_table_init(struct udp_table , const char );
	65	static inline struct udp_hslot udp_hashslot(struct udp_table table,
	66	struct net *net, unsigned num)
	67	{
	68	return &table->hash[udp_hashfn(net, num, table->mask)];
	69	}
1da177e4 LT	70
	71	/* Note: this must match 'valbool' in sock_setsockopt */
	72	#define UDP_CSUM_NOXMIT 1
	73
	74	/* Used by SunRPC/xprt layer. */
	75	#define UDP_CSUM_NORCV 2
	76
	77	/* Default, as per the RFC, is to always do csums. */
	78	#define UDP_CSUM_DEFAULT 0
	79
	80	extern struct proto udp_prot;
	81
95766fff HA	82	extern atomic_t udp_memory_allocated;
	83
	84	/* sysctl variables for udp */
	85	extern int sysctl_udp_mem[3];
	86	extern int sysctl_udp_rmem_min;
	87	extern int sysctl_udp_wmem_min;
	88
14c85021	89	struct sk_buff;
1da177e4	90
ba4e58ec GR	91	/*
	92	* Generic checksumming routines for UDP(-Lite) v4 and v6
	93	*/
b51655b9	94	static inline __sum16 __udp_lib_checksum_complete(struct sk_buff *skb)
ba4e58ec	95	{
759e5d00	96	return __skb_checksum_complete_head(skb, UDP_SKB_CB(skb)->cscov);
ba4e58ec GR	97	}
ba4e58ec GR	98
8e5200f5	99	static inline int udp_lib_checksum_complete(struct sk_buff *skb)
ba4e58ec	100	{
60476372	101	return !skb_csum_unnecessary(skb) &&
ba4e58ec GR	102	__udp_lib_checksum_complete(skb);
	103	}
	104
	105	/**
	106	* udp_csum_outgoing - compute UDPv4/v6 checksum over fragments
	107	* @sk: socket we are writing to
	108	* @skb: sk_buff containing the filled-in UDP header
	109	* (checksum field must be zeroed out)
	110	*/
868c86bc	111	static inline __wsum udp_csum_outgoing(struct sock sk, struct sk_buff skb)
ba4e58ec	112	{
9c70220b ACM	113	__wsum csum = csum_partial(skb_transport_header(skb),
9c70220b ACM	114	sizeof(struct udphdr), 0);
ba4e58ec GR	115	skb_queue_walk(&sk->sk_write_queue, skb) {
	116	csum = csum_add(csum, skb->csum);
	117	}
	118	return csum;
	119	}
	120
	121	/* hash routines shared between UDPv4/6 and UDP-Litev4/6 */
	122	static inline void udp_lib_hash(struct sock *sk)
	123	{
	124	BUG();
	125	}
	126
645ca708	127	extern void udp_lib_unhash(struct sock *sk);
ba4e58ec GR	128
	129	static inline void udp_lib_close(struct sock *sk, long timeout)
	130	{
	131	sk_common_release(sk);
	132	}
	133
6ba5a3c5 PE	134	extern int udp_lib_get_port(struct sock *sk, unsigned short snum,
6ba5a3c5 PE	135	int ()(const struct sock,const struct sock*));
ba4e58ec GR	136
ba4e58ec GR	137	/* net/ipv4/udp.c */
25030a7f	138	extern int udp_get_port(struct sock *sk, unsigned short snum,
df2bc459	139	int (saddr_cmp)(const struct sock , const struct sock *));
1da177e4 LT	140	extern void udp_err(struct sk_buff *, u32);
	141
	142	extern int udp_sendmsg(struct kiocb iocb, struct sock sk,
	143	struct msghdr *msg, size_t len);
36d926b9	144	extern void udp_flush_pending_frames(struct sock *sk);
1da177e4 LT	145
	146	extern int udp_rcv(struct sk_buff *skb);
	147	extern int udp_ioctl(struct sock *sk, int cmd, unsigned long arg);
	148	extern int udp_disconnect(struct sock *sk, int flags);
	149	extern unsigned int udp_poll(struct file file, struct socket sock,
	150	poll_table *wait);
4c0a6cb0 GR	151	extern int udp_lib_getsockopt(struct sock *sk, int level, int optname,
	152	char __user optval, int __user optlen);
	153	extern int udp_lib_setsockopt(struct sock *sk, int level, int optname,
b7058842	154	char __user *optval, unsigned int optlen,
4c0a6cb0	155	int (push_pending_frames)(struct sock ));
1da177e4	156
bcd41303 KK	157	extern struct sock udp4_lib_lookup(struct net net, __be32 saddr, __be16 sport,
	158	__be32 daddr, __be16 dport,
	159	int dif);
	160
ba4e58ec GR	161	/*
	162	* SNMP statistics for UDP and UDP-Lite
	163	*/
2f275f91	164	#define UDP_INC_STATS_USER(net, field, is_udplite) do { \
386019d3	165	if (is_udplite) SNMP_INC_STATS_USER((net)->mib.udplite_statistics, field); \
2f275f91 PE	166	else SNMP_INC_STATS_USER((net)->mib.udp_statistics, field); } while(0)
2f275f91 PE	167	#define UDP_INC_STATS_BH(net, field, is_udplite) do { \
386019d3	168	if (is_udplite) SNMP_INC_STATS_BH((net)->mib.udplite_statistics, field); \
2f275f91	169	else SNMP_INC_STATS_BH((net)->mib.udp_statistics, field); } while(0)
1da177e4	170
0c7ed677	171	#define UDP6_INC_STATS_BH(net, field, is_udplite) do { \
be713a44	172	if (is_udplite) SNMP_INC_STATS_BH((net)->mib.udplite_stats_in6, field);\
0c7ed677 DL	173	else SNMP_INC_STATS_BH((net)->mib.udp_stats_in6, field); \
0c7ed677 DL	174	} while(0)
be713a44 DL	175	#define UDP6_INC_STATS_USER(net, field, __lite) do { \
	176	if (__lite) SNMP_INC_STATS_USER((net)->mib.udplite_stats_in6, field); \
	177	else SNMP_INC_STATS_USER((net)->mib.udp_stats_in6, field); \
0c7ed677	178	} while(0)
1781f7f5 HX	179
	180	#if defined(CONFIG_IPV6) \|\| defined(CONFIG_IPV6_MODULE)
	181	#define UDPX_INC_STATS_BH(sk, field) \
	182	do { \
	183	if ((sk)->sk_family == AF_INET) \
0283328e	184	UDP_INC_STATS_BH(sock_net(sk), field, 0); \
1781f7f5	185	else \
ef28d1a2	186	UDP6_INC_STATS_BH(sock_net(sk), field, 0); \
1781f7f5 HX	187	} while (0);
1781f7f5 HX	188	#else
0283328e	189	#define UDPX_INC_STATS_BH(sk, field) UDP_INC_STATS_BH(sock_net(sk), field, 0)
1781f7f5 HX	190	#endif
1781f7f5 HX	191
1da177e4 LT	192	/* /proc */
1da177e4 LT	193	struct udp_seq_afinfo {
1da177e4 LT	194	char *name;
1da177e4 LT	195	sa_family_t family;
645ca708	196	struct udp_table *udp_table;
3ba9441b	197	struct file_operations seq_fops;
dda61925	198	struct seq_operations seq_ops;
1da177e4 LT	199	};
	200
	201	struct udp_iter_state {
6f191efe	202	struct seq_net_private p;
1da177e4 LT	203	sa_family_t family;
1da177e4 LT	204	int bucket;
645ca708	205	struct udp_table *udp_table;
1da177e4 LT	206	};
1da177e4 LT	207
20380731	208	#ifdef CONFIG_PROC_FS
0c96d8c5 DL	209	extern int udp_proc_register(struct net net, struct udp_seq_afinfo afinfo);
0c96d8c5 DL	210	extern void udp_proc_unregister(struct net net, struct udp_seq_afinfo afinfo);
20380731 ACM	211
	212	extern int udp4_proc_init(void);
	213	extern void udp4_proc_exit(void);
	214	#endif
95766fff HA	215
95766fff HA	216	extern void udp_init(void);
d7ca4cc0 SS	217
	218	extern int udp4_ufo_send_check(struct sk_buff *skb);
	219	extern struct sk_buff udp4_ufo_fragment(struct sk_buff skb, int features);
1da177e4	220	#endif /* _UDP_H */