[mirror_ubuntu-bionic-kernel.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_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;
	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 struct ccid *ccid_new(unsigned char id, struct sock *sk, int rx,
			     gfp_t gfp);

extern struct ccid *ccid_hc_rx_new(unsigned char id, struct sock *sk,
				   gfp_t gfp);
extern struct ccid *ccid_hc_tx_new(unsigned char id, struct sock *sk,
				   gfp_t gfp);

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