[deliverable/linux.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>

#define CCID_MAX 255

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_owner: module which implements/owns this CCID
 *  @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 module		*ccid_owner;
	struct kmem_cache	*ccid_hc_rx_slab,
				*ccid_hc_tx_slab;
	__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 int ccid_register(struct ccid_operations *ccid_ops);
extern int ccid_unregister(struct ccid_operations *ccid_ops);

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(unsigned char id, struct sock *sk, int rx,
			     gfp_t gfp);

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