[net-next-2.6.git] / net / dccp / ccid.h

#ifndef _CCID_H
#define _CCID_H
/*
 *  net/dccp/ccid.h
 *
 *  An implementation of the DCCP protocol
 *  Arnaldo Carvalho de Melo <acme@conectiva.com.br>
 *
 *  CCID infrastructure
 *
 *	This program is free software; you can redistribute it and/or modify it
 *	under the terms of the GNU General Public License version 2 as
 *	published by the Free Software Foundation.
 */

#include <net/sock.h>
#include <linux/compiler.h>
#include <linux/dccp.h>
#include <linux/list.h>
#include <linux/module.h>

/* maximum value for a CCID (RFC 4340, 19.5) */
#define CCID_MAX		255
#define CCID_SLAB_NAME_LENGTH	32

struct tcp_info;

/**
 *  struct ccid_operations  -  Interface to Congestion-Control Infrastructure
 *
 *  @ccid_id: numerical CCID ID (up to %CCID_MAX, cf. table 5 in RFC 4340, 10.)
 *  @ccid_ccmps: the CCMPS including network/transport headers (0 when disabled)
 *  @ccid_name: alphabetical identifier string for @ccid_id
 *  @ccid_hc_{r,t}x_slab: memory pool for the receiver/sender half-connection
 *  @ccid_hc_{r,t}x_obj_size: size of the receiver/sender half-connection socket
 *
 *  @ccid_hc_{r,t}x_init: CCID-specific initialisation routine (before startup)
 *  @ccid_hc_{r,t}x_exit: CCID-specific cleanup routine (before destruction)
 *  @ccid_hc_rx_packet_recv: implements the HC-receiver side
 *  @ccid_hc_{r,t}x_parse_options: parsing routine for CCID/HC-specific options
 *  @ccid_hc_{r,t}x_insert_options: insert routine for CCID/HC-specific options
 *  @ccid_hc_tx_packet_recv: implements feedback processing for the HC-sender
 *  @ccid_hc_tx_send_packet: implements the sending part of the HC-sender
 *  @ccid_hc_tx_packet_sent: does accounting for packets in flight by HC-sender
 *  @ccid_hc_{r,t}x_get_info: INET_DIAG information for HC-receiver/sender
 *  @ccid_hc_{r,t}x_getsockopt: socket options specific to HC-receiver/sender
 */
struct ccid_operations {
	unsigned char		ccid_id;
	__u32			ccid_ccmps;
	const char		*ccid_name;
	struct kmem_cache	*ccid_hc_rx_slab,
				*ccid_hc_tx_slab;
	char			ccid_hc_rx_slab_name[CCID_SLAB_NAME_LENGTH];
	char			ccid_hc_tx_slab_name[CCID_SLAB_NAME_LENGTH];
	__u32			ccid_hc_rx_obj_size,
				ccid_hc_tx_obj_size;
	/* Interface Routines */
	int		(*ccid_hc_rx_init)(struct ccid *ccid, struct sock *sk);
	int		(*ccid_hc_tx_init)(struct ccid *ccid, struct sock *sk);
	void		(*ccid_hc_rx_exit)(struct sock *sk);
	void		(*ccid_hc_tx_exit)(struct sock *sk);
	void		(*ccid_hc_rx_packet_recv)(struct sock *sk,
						  struct sk_buff *skb);
	int		(*ccid_hc_rx_parse_options)(struct sock *sk,
						    unsigned char option,
						    unsigned char len, u16 idx,
						    unsigned char* value);
	int		(*ccid_hc_rx_insert_options)(struct sock *sk,
						     struct sk_buff *skb);
	void		(*ccid_hc_tx_packet_recv)(struct sock *sk,
						  struct sk_buff *skb);
	int		(*ccid_hc_tx_parse_options)(struct sock *sk,
						    unsigned char option,
						    unsigned char len, u16 idx,
						    unsigned char* value);
	int		(*ccid_hc_tx_send_packet)(struct sock *sk,
						  struct sk_buff *skb);
	void		(*ccid_hc_tx_packet_sent)(struct sock *sk,
						  int more, unsigned int len);
	void		(*ccid_hc_rx_get_info)(struct sock *sk,
					       struct tcp_info *info);
	void		(*ccid_hc_tx_get_info)(struct sock *sk,
					       struct tcp_info *info);
	int		(*ccid_hc_rx_getsockopt)(struct sock *sk,
						 const int optname, int len,
						 u32 __user *optval,
						 int __user *optlen);
	int		(*ccid_hc_tx_getsockopt)(struct sock *sk,
						 const int optname, int len,
						 u32 __user *optval,
						 int __user *optlen);
};

extern struct ccid_operations ccid2_ops;
#ifdef CONFIG_IP_DCCP_CCID3
extern struct ccid_operations ccid3_ops;
#endif

extern int  ccid_initialize_builtins(void);
extern void ccid_cleanup_builtins(void);

struct ccid {
	struct ccid_operations *ccid_ops;
	char		       ccid_priv[0];
};

static inline void *ccid_priv(const struct ccid *ccid)
{
	return (void *)ccid->ccid_priv;
}

extern bool ccid_support_check(u8 const *ccid_array, u8 array_len);
extern int  ccid_get_builtin_ccids(u8 **ccid_array, u8 *array_len);
extern int  ccid_getsockopt_builtin_ccids(struct sock *sk, int len,
					  char __user *, int __user *);

extern struct ccid *ccid_new(const u8 id, struct sock *sk, bool rx);

static inline int ccid_get_current_rx_ccid(struct dccp_sock *dp)
{
	struct ccid *ccid = dp->dccps_hc_rx_ccid;

	if (ccid == NULL || ccid->ccid_ops == NULL)
		return -1;
	return ccid->ccid_ops->ccid_id;
}

static inline int ccid_get_current_tx_ccid(struct dccp_sock *dp)
{
	struct ccid *ccid = dp->dccps_hc_tx_ccid;

	if (ccid == NULL || ccid->ccid_ops == NULL)
		return -1;
	return ccid->ccid_ops->ccid_id;
}

extern void ccid_hc_rx_delete(struct ccid *ccid, struct sock *sk);
extern void ccid_hc_tx_delete(struct ccid *ccid, struct sock *sk);

static inline int ccid_hc_tx_send_packet(struct ccid *ccid, struct sock *sk,
					 struct sk_buff *skb)
{
	int rc = 0;
	if (ccid->ccid_ops->ccid_hc_tx_send_packet != NULL)
		rc = ccid->ccid_ops->ccid_hc_tx_send_packet(sk, skb);
	return rc;
}

static inline void ccid_hc_tx_packet_sent(struct ccid *ccid, struct sock *sk,
					  int more, unsigned int len)
{
	if (ccid->ccid_ops->ccid_hc_tx_packet_sent != NULL)
		ccid->ccid_ops->ccid_hc_tx_packet_sent(sk, more, len);
}

static inline void ccid_hc_rx_packet_recv(struct ccid *ccid, struct sock *sk,
					  struct sk_buff *skb)
{
	if (ccid->ccid_ops->ccid_hc_rx_packet_recv != NULL)
		ccid->ccid_ops->ccid_hc_rx_packet_recv(sk, skb);
}

static inline void ccid_hc_tx_packet_recv(struct ccid *ccid, struct sock *sk,
					  struct sk_buff *skb)
{
	if (ccid->ccid_ops->ccid_hc_tx_packet_recv != NULL)
		ccid->ccid_ops->ccid_hc_tx_packet_recv(sk, skb);
}

static inline int ccid_hc_tx_parse_options(struct ccid *ccid, struct sock *sk,
					   unsigned char option,
					   unsigned char len, u16 idx,
					   unsigned char* value)
{
	int rc = 0;
	if (ccid->ccid_ops->ccid_hc_tx_parse_options != NULL)
		rc = ccid->ccid_ops->ccid_hc_tx_parse_options(sk, option, len, idx,
						    value);
	return rc;
}

static inline int ccid_hc_rx_parse_options(struct ccid *ccid, struct sock *sk,
					   unsigned char option,
					   unsigned char len, u16 idx,
					   unsigned char* value)
{
	int rc = 0;
	if (ccid->ccid_ops->ccid_hc_rx_parse_options != NULL)
		rc = ccid->ccid_ops->ccid_hc_rx_parse_options(sk, option, len, idx, value);
	return rc;
}

static inline int ccid_hc_rx_insert_options(struct ccid *ccid, struct sock *sk,
					    struct sk_buff *skb)
{
	if (ccid->ccid_ops->ccid_hc_rx_insert_options != NULL)
		return ccid->ccid_ops->ccid_hc_rx_insert_options(sk, skb);
	return 0;
}

static inline void ccid_hc_rx_get_info(struct ccid *ccid, struct sock *sk,
				       struct tcp_info *info)
{
	if (ccid->ccid_ops->ccid_hc_rx_get_info != NULL)
		ccid->ccid_ops->ccid_hc_rx_get_info(sk, info);
}

static inline void ccid_hc_tx_get_info(struct ccid *ccid, struct sock *sk,
				       struct tcp_info *info)
{
	if (ccid->ccid_ops->ccid_hc_tx_get_info != NULL)
		ccid->ccid_ops->ccid_hc_tx_get_info(sk, info);
}

static inline int ccid_hc_rx_getsockopt(struct ccid *ccid, struct sock *sk,
					const int optname, int len,
					u32 __user *optval, int __user *optlen)
{
	int rc = -ENOPROTOOPT;
	if (ccid->ccid_ops->ccid_hc_rx_getsockopt != NULL)
		rc = ccid->ccid_ops->ccid_hc_rx_getsockopt(sk, optname, len,
						 optval, optlen);
	return rc;
}

static inline int ccid_hc_tx_getsockopt(struct ccid *ccid, struct sock *sk,
					const int optname, int len,
					u32 __user *optval, int __user *optlen)
{
	int rc = -ENOPROTOOPT;
	if (ccid->ccid_ops->ccid_hc_tx_getsockopt != NULL)
		rc = ccid->ccid_ops->ccid_hc_tx_getsockopt(sk, optname, len,
						 optval, optlen);
	return rc;
}
#endif /* _CCID_H */
Commit	Line	Data
7c657876 ACM	1	#ifndef _CCID_H
	2	#define _CCID_H
	3	/*
	4	* net/dccp/ccid.h
	5	*
	6	* An implementation of the DCCP protocol
	7	* Arnaldo Carvalho de Melo <acme@conectiva.com.br>
	8	*
	9	* CCID infrastructure
	10	*
	11	* This program is free software; you can redistribute it and/or modify it
	12	* under the terms of the GNU General Public License version 2 as
	13	* published by the Free Software Foundation.
	14	*/
	15
	16	#include <net/sock.h>
88f964db	17	#include <linux/compiler.h>
7c657876 ACM	18	#include <linux/dccp.h>
	19	#include <linux/list.h>
	20	#include <linux/module.h>
	21
8ed030dd GR	22	/* maximum value for a CCID (RFC 4340, 19.5) */
	23	#define CCID_MAX 255
	24	#define CCID_SLAB_NAME_LENGTH 32
7c657876	25
14c85021 ACM	26	struct tcp_info;
14c85021 ACM	27
9cb2345a GR	28	/**
	29	* struct ccid_operations - Interface to Congestion-Control Infrastructure
	30	*
	31	* @ccid_id: numerical CCID ID (up to %CCID_MAX, cf. table 5 in RFC 4340, 10.)
6179983a	32	* @ccid_ccmps: the CCMPS including network/transport headers (0 when disabled)
9cb2345a	33	* @ccid_name: alphabetical identifier string for @ccid_id
9cb2345a GR	34	* @ccid_hc_{r,t}x_slab: memory pool for the receiver/sender half-connection
	35	* @ccid_hc_{r,t}x_obj_size: size of the receiver/sender half-connection socket
	36	*
	37	* @ccid_hc_{r,t}x_init: CCID-specific initialisation routine (before startup)
	38	* @ccid_hc_{r,t}x_exit: CCID-specific cleanup routine (before destruction)
	39	* @ccid_hc_rx_packet_recv: implements the HC-receiver side
	40	* @ccid_hc_{r,t}x_parse_options: parsing routine for CCID/HC-specific options
	41	* @ccid_hc_{r,t}x_insert_options: insert routine for CCID/HC-specific options
	42	* @ccid_hc_tx_packet_recv: implements feedback processing for the HC-sender
	43	* @ccid_hc_tx_send_packet: implements the sending part of the HC-sender
	44	* @ccid_hc_tx_packet_sent: does accounting for packets in flight by HC-sender
	45	* @ccid_hc_{r,t}x_get_info: INET_DIAG information for HC-receiver/sender
	46	* @ccid_hc_{r,t}x_getsockopt: socket options specific to HC-receiver/sender
	47	*/
91f0ebf7	48	struct ccid_operations {
9cb2345a	49	unsigned char ccid_id;
6179983a	50	__u32 ccid_ccmps;
9cb2345a	51	const char *ccid_name;
9cb2345a GR	52	struct kmem_cache *ccid_hc_rx_slab,
9cb2345a GR	53	*ccid_hc_tx_slab;
8ed030dd GR	54	char ccid_hc_rx_slab_name[CCID_SLAB_NAME_LENGTH];
8ed030dd GR	55	char ccid_hc_tx_slab_name[CCID_SLAB_NAME_LENGTH];
9cb2345a GR	56	__u32 ccid_hc_rx_obj_size,
	57	ccid_hc_tx_obj_size;
	58	/* Interface Routines */
91f0ebf7 ACM	59	int (ccid_hc_rx_init)(struct ccid ccid, struct sock *sk);
91f0ebf7 ACM	60	int (ccid_hc_tx_init)(struct ccid ccid, struct sock *sk);
7c657876 ACM	61	void (ccid_hc_rx_exit)(struct sock sk);
7c657876 ACM	62	void (ccid_hc_tx_exit)(struct sock sk);
7690af3f ACM	63	void (ccid_hc_rx_packet_recv)(struct sock sk,
7690af3f ACM	64	struct sk_buff *skb);
7c657876 ACM	65	int (ccid_hc_rx_parse_options)(struct sock sk,
	66	unsigned char option,
	67	unsigned char len, u16 idx,
	68	unsigned char* value);
2d0817d1	69	int (ccid_hc_rx_insert_options)(struct sock sk,
7690af3f	70	struct sk_buff *skb);
7690af3f ACM	71	void (ccid_hc_tx_packet_recv)(struct sock sk,
7690af3f ACM	72	struct sk_buff *skb);
7c657876 ACM	73	int (ccid_hc_tx_parse_options)(struct sock sk,
	74	unsigned char option,
	75	unsigned char len, u16 idx,
	76	unsigned char* value);
	77	int (ccid_hc_tx_send_packet)(struct sock sk,
6b57c93d GR	78	struct sk_buff *skb);
	79	void (ccid_hc_tx_packet_sent)(struct sock sk,
	80	int more, unsigned int len);
2babe1f6 ACM	81	void (ccid_hc_rx_get_info)(struct sock sk,
	82	struct tcp_info *info);
	83	void (ccid_hc_tx_get_info)(struct sock sk,
	84	struct tcp_info *info);
88f964db ACM	85	int (ccid_hc_rx_getsockopt)(struct sock sk,
	86	const int optname, int len,
	87	u32 __user *optval,
	88	int __user *optlen);
	89	int (ccid_hc_tx_getsockopt)(struct sock sk,
	90	const int optname, int len,
	91	u32 __user *optval,
	92	int __user *optlen);
7c657876 ACM	93	};
7c657876 ACM	94
ddebc973 GR	95	extern struct ccid_operations ccid2_ops;
	96	#ifdef CONFIG_IP_DCCP_CCID3
	97	extern struct ccid_operations ccid3_ops;
	98	#endif
	99
	100	extern int ccid_initialize_builtins(void);
	101	extern void ccid_cleanup_builtins(void);
7c657876	102
91f0ebf7 ACM	103	struct ccid {
	104	struct ccid_operations *ccid_ops;
	105	char ccid_priv[0];
	106	};
7c657876	107
91f0ebf7	108	static inline void ccid_priv(const struct ccid ccid)
7c657876	109	{
91f0ebf7	110	return (void *)ccid->ccid_priv;
7c657876 ACM	111	}
7c657876 ACM	112
d90ebcbf GR	113	extern bool ccid_support_check(u8 const *ccid_array, u8 array_len);
	114	extern int ccid_get_builtin_ccids(u8 *ccid_array, u8 array_len);
	115	extern int ccid_getsockopt_builtin_ccids(struct sock *sk, int len,
	116	char __user , int __user );
	117
e5fd56ca	118	extern struct ccid ccid_new(const u8 id, struct sock sk, bool rx);
91f0ebf7	119
71c262a3 GR	120	static inline int ccid_get_current_rx_ccid(struct dccp_sock *dp)
	121	{
	122	struct ccid *ccid = dp->dccps_hc_rx_ccid;
	123
	124	if (ccid == NULL \|\| ccid->ccid_ops == NULL)
	125	return -1;
	126	return ccid->ccid_ops->ccid_id;
	127	}
	128
	129	static inline int ccid_get_current_tx_ccid(struct dccp_sock *dp)
	130	{
	131	struct ccid *ccid = dp->dccps_hc_tx_ccid;
	132
	133	if (ccid == NULL \|\| ccid->ccid_ops == NULL)
	134	return -1;
	135	return ccid->ccid_ops->ccid_id;
	136	}
	137
91f0ebf7 ACM	138	extern void ccid_hc_rx_delete(struct ccid ccid, struct sock sk);
	139	extern void ccid_hc_tx_delete(struct ccid ccid, struct sock sk);
	140
7c657876	141	static inline int ccid_hc_tx_send_packet(struct ccid ccid, struct sock sk,
6b57c93d	142	struct sk_buff *skb)
7c657876 ACM	143	{
7c657876 ACM	144	int rc = 0;
91f0ebf7	145	if (ccid->ccid_ops->ccid_hc_tx_send_packet != NULL)
6b57c93d	146	rc = ccid->ccid_ops->ccid_hc_tx_send_packet(sk, skb);
7c657876 ACM	147	return rc;
	148	}
	149
	150	static inline void ccid_hc_tx_packet_sent(struct ccid ccid, struct sock sk,
6b57c93d	151	int more, unsigned int len)
7c657876	152	{
91f0ebf7 ACM	153	if (ccid->ccid_ops->ccid_hc_tx_packet_sent != NULL)
91f0ebf7 ACM	154	ccid->ccid_ops->ccid_hc_tx_packet_sent(sk, more, len);
7c657876 ACM	155	}
	156
	157	static inline void ccid_hc_rx_packet_recv(struct ccid ccid, struct sock sk,
	158	struct sk_buff *skb)
	159	{
91f0ebf7 ACM	160	if (ccid->ccid_ops->ccid_hc_rx_packet_recv != NULL)
91f0ebf7 ACM	161	ccid->ccid_ops->ccid_hc_rx_packet_recv(sk, skb);
7c657876 ACM	162	}
	163
	164	static inline void ccid_hc_tx_packet_recv(struct ccid ccid, struct sock sk,
	165	struct sk_buff *skb)
	166	{
91f0ebf7 ACM	167	if (ccid->ccid_ops->ccid_hc_tx_packet_recv != NULL)
91f0ebf7 ACM	168	ccid->ccid_ops->ccid_hc_tx_packet_recv(sk, skb);
7c657876 ACM	169	}
	170
	171	static inline int ccid_hc_tx_parse_options(struct ccid ccid, struct sock sk,
	172	unsigned char option,
	173	unsigned char len, u16 idx,
	174	unsigned char* value)
	175	{
	176	int rc = 0;
91f0ebf7 ACM	177	if (ccid->ccid_ops->ccid_hc_tx_parse_options != NULL)
91f0ebf7 ACM	178	rc = ccid->ccid_ops->ccid_hc_tx_parse_options(sk, option, len, idx,
7690af3f	179	value);
7c657876 ACM	180	return rc;
	181	}
	182
	183	static inline int ccid_hc_rx_parse_options(struct ccid ccid, struct sock sk,
	184	unsigned char option,
	185	unsigned char len, u16 idx,
	186	unsigned char* value)
	187	{
	188	int rc = 0;
91f0ebf7 ACM	189	if (ccid->ccid_ops->ccid_hc_rx_parse_options != NULL)
91f0ebf7 ACM	190	rc = ccid->ccid_ops->ccid_hc_rx_parse_options(sk, option, len, idx, value);
7c657876 ACM	191	return rc;
	192	}
	193
2d0817d1 ACM	194	static inline int ccid_hc_rx_insert_options(struct ccid ccid, struct sock sk,
2d0817d1 ACM	195	struct sk_buff *skb)
7c657876	196	{
91f0ebf7	197	if (ccid->ccid_ops->ccid_hc_rx_insert_options != NULL)
2d0817d1 ACM	198	return ccid->ccid_ops->ccid_hc_rx_insert_options(sk, skb);
2d0817d1 ACM	199	return 0;
7c657876	200	}
2babe1f6 ACM	201
	202	static inline void ccid_hc_rx_get_info(struct ccid ccid, struct sock sk,
	203	struct tcp_info *info)
	204	{
91f0ebf7 ACM	205	if (ccid->ccid_ops->ccid_hc_rx_get_info != NULL)
91f0ebf7 ACM	206	ccid->ccid_ops->ccid_hc_rx_get_info(sk, info);
2babe1f6 ACM	207	}
	208
	209	static inline void ccid_hc_tx_get_info(struct ccid ccid, struct sock sk,
	210	struct tcp_info *info)
	211	{
91f0ebf7 ACM	212	if (ccid->ccid_ops->ccid_hc_tx_get_info != NULL)
91f0ebf7 ACM	213	ccid->ccid_ops->ccid_hc_tx_get_info(sk, info);
2babe1f6	214	}
88f964db ACM	215
	216	static inline int ccid_hc_rx_getsockopt(struct ccid ccid, struct sock sk,
	217	const int optname, int len,
	218	u32 __user optval, int __user optlen)
	219	{
	220	int rc = -ENOPROTOOPT;
91f0ebf7 ACM	221	if (ccid->ccid_ops->ccid_hc_rx_getsockopt != NULL)
91f0ebf7 ACM	222	rc = ccid->ccid_ops->ccid_hc_rx_getsockopt(sk, optname, len,
88f964db ACM	223	optval, optlen);
	224	return rc;
	225	}
	226
	227	static inline int ccid_hc_tx_getsockopt(struct ccid ccid, struct sock sk,
	228	const int optname, int len,
	229	u32 __user optval, int __user optlen)
	230	{
	231	int rc = -ENOPROTOOPT;
91f0ebf7 ACM	232	if (ccid->ccid_ops->ccid_hc_tx_getsockopt != NULL)
91f0ebf7 ACM	233	rc = ccid->ccid_ops->ccid_hc_tx_getsockopt(sk, optname, len,
88f964db ACM	234	optval, optlen);
	235	return rc;
	236	}
7c657876	237	#endif /* _CCID_H */