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

#ifndef _DCCP_FEAT_H
#define _DCCP_FEAT_H
/*
 *  net/dccp/feat.h
 *
 *  An implementation of the DCCP protocol
 *  Copyright (c) 2005 Andrea Bittau <a.bittau@cs.ucl.ac.uk>
 *
 *	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 <linux/types.h>
#include "dccp.h"

enum dccp_feat_type {
	FEAT_AT_RX   = 1,	/* located at RX side of half-connection  */
	FEAT_AT_TX   = 2,	/* located at TX side of half-connection  */
	FEAT_SP      = 4,	/* server-priority reconciliation (6.3.1) */
	FEAT_NN	     = 8,	/* non-negotiable reconciliation (6.3.2)  */
	FEAT_UNKNOWN = 0xFF	/* not understood or invalid feature	  */
};

enum dccp_feat_state {
	FEAT_DEFAULT = 0,	/* using default values from 6.4 */
	FEAT_INITIALISING,	/* feature is being initialised  */
	FEAT_CHANGING,		/* Change sent but not confirmed yet */
	FEAT_UNSTABLE,		/* local modification in state CHANGING */
	FEAT_STABLE		/* both ends (think they) agree */
};

/**
 * dccp_feat_val  -  Container for SP or NN feature values
 * @nn:     single NN value
 * @sp.vec: single SP value plus optional preference list
 * @sp.len: length of @sp.vec in bytes
 */
typedef union {
	u64 nn;
	struct {
		u8	*vec;
		u8	len;
	}   sp;
} dccp_feat_val;

/**
 * struct feat_entry  -  Data structure to perform feature negotiation
 * @val: feature's current value (SP features may have preference list)
 * @state: feature's current state
 * @feat_num: one of %dccp_feature_numbers
 * @needs_mandatory: whether Mandatory options should be sent
 * @needs_confirm: whether to send a Confirm instead of a Change
 * @empty_confirm: whether to send an empty Confirm (depends on @needs_confirm)
 * @is_local: feature location (1) or feature-remote (0)
 * @node: list pointers, entries arranged in FIFO order
 */
struct dccp_feat_entry {
	dccp_feat_val           val;
	enum dccp_feat_state    state:8;
	u8                      feat_num;

	bool			needs_mandatory,
				needs_confirm,
				empty_confirm,
				is_local;

	struct list_head	node;
};

static inline u8 dccp_feat_genopt(struct dccp_feat_entry *entry)
{
	if (entry->needs_confirm)
		return entry->is_local ? DCCPO_CONFIRM_L : DCCPO_CONFIRM_R;
	return entry->is_local ? DCCPO_CHANGE_L : DCCPO_CHANGE_R;
}

#ifdef CONFIG_IP_DCCP_DEBUG
extern const char *dccp_feat_typename(const u8 type);
extern const char *dccp_feat_name(const u8 feat);

static inline void dccp_feat_debug(const u8 type, const u8 feat, const u8 val)
{
	dccp_pr_debug("%s(%s (%d), %d)\n", dccp_feat_typename(type),
					   dccp_feat_name(feat), feat, val);
}
#else
#define dccp_feat_debug(type, feat, val)
#endif /* CONFIG_IP_DCCP_DEBUG */

extern int  dccp_feat_change(struct dccp_minisock *dmsk, u8 type, u8 feature,
			     u8 *val, u8 len, gfp_t gfp);
extern int  dccp_feat_change_recv(struct sock *sk, u8 type, u8 feature,
				  u8 *val, u8 len);
extern int  dccp_feat_confirm_recv(struct sock *sk, u8 type, u8 feature,
				   u8 *val, u8 len);
extern void dccp_feat_clean(struct dccp_minisock *dmsk);
extern int  dccp_feat_clone(struct sock *oldsk, struct sock *newsk);
extern int  dccp_feat_clone_list(struct list_head const *, struct list_head *);
extern int  dccp_feat_init(struct dccp_minisock *dmsk);

#endif /* _DCCP_FEAT_H */
Commit	Line	Data
afe00251 AB	1	#ifndef _DCCP_FEAT_H
	2	#define _DCCP_FEAT_H
	3	/*
	4	* net/dccp/feat.h
	5	*
	6	* An implementation of the DCCP protocol
	7	* Copyright (c) 2005 Andrea Bittau <a.bittau@cs.ucl.ac.uk>
	8	*
	9	* This program is free software; you can redistribute it and/or modify it
	10	* under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*/
	13
	14	#include <linux/types.h>
c02fdc0e	15	#include "dccp.h"
afe00251	16
bd012f2e GR	17	enum dccp_feat_type {
	18	FEAT_AT_RX = 1, /* located at RX side of half-connection */
	19	FEAT_AT_TX = 2, /* located at TX side of half-connection */
	20	FEAT_SP = 4, /* server-priority reconciliation (6.3.1) */
	21	FEAT_NN = 8, /* non-negotiable reconciliation (6.3.2) */
	22	FEAT_UNKNOWN = 0xFF /* not understood or invalid feature */
	23	};
	24
	25	enum dccp_feat_state {
	26	FEAT_DEFAULT = 0, /* using default values from 6.4 */
	27	FEAT_INITIALISING, /* feature is being initialised */
	28	FEAT_CHANGING, /* Change sent but not confirmed yet */
	29	FEAT_UNSTABLE, /* local modification in state CHANGING */
	30	FEAT_STABLE /* both ends (think they) agree */
	31	};
	32
	33	/**
	34	* dccp_feat_val - Container for SP or NN feature values
	35	* @nn: single NN value
	36	* @sp.vec: single SP value plus optional preference list
	37	* @sp.len: length of @sp.vec in bytes
	38	*/
	39	typedef union {
	40	u64 nn;
	41	struct {
	42	u8 *vec;
	43	u8 len;
	44	} sp;
	45	} dccp_feat_val;
	46
	47	/**
	48	* struct feat_entry - Data structure to perform feature negotiation
	49	* @val: feature's current value (SP features may have preference list)
	50	* @state: feature's current state
	51	* @feat_num: one of %dccp_feature_numbers
	52	* @needs_mandatory: whether Mandatory options should be sent
	53	* @needs_confirm: whether to send a Confirm instead of a Change
	54	* @empty_confirm: whether to send an empty Confirm (depends on @needs_confirm)
	55	* @is_local: feature location (1) or feature-remote (0)
	56	* @node: list pointers, entries arranged in FIFO order
	57	*/
	58	struct dccp_feat_entry {
	59	dccp_feat_val val;
	60	enum dccp_feat_state state:8;
	61	u8 feat_num;
	62
	63	bool needs_mandatory,
	64	needs_confirm,
	65	empty_confirm,
	66	is_local;
	67
	68	struct list_head node;
	69	};
	70
	71	static inline u8 dccp_feat_genopt(struct dccp_feat_entry *entry)
	72	{
	73	if (entry->needs_confirm)
	74	return entry->is_local ? DCCPO_CONFIRM_L : DCCPO_CONFIRM_R;
	75	return entry->is_local ? DCCPO_CHANGE_L : DCCPO_CHANGE_R;
	76	}
	77
c02fdc0e GR	78	#ifdef CONFIG_IP_DCCP_DEBUG
	79	extern const char *dccp_feat_typename(const u8 type);
	80	extern const char *dccp_feat_name(const u8 feat);
	81
	82	static inline void dccp_feat_debug(const u8 type, const u8 feat, const u8 val)
	83	{
	84	dccp_pr_debug("%s(%s (%d), %d)\n", dccp_feat_typename(type),
	85	dccp_feat_name(feat), feat, val);
	86	}
	87	#else
	88	#define dccp_feat_debug(type, feat, val)
	89	#endif /* CONFIG_IP_DCCP_DEBUG */
afe00251	90
8ca0d17b	91	extern int dccp_feat_change(struct dccp_minisock *dmsk, u8 type, u8 feature,
afe00251 AB	92	u8 *val, u8 len, gfp_t gfp);
	93	extern int dccp_feat_change_recv(struct sock *sk, u8 type, u8 feature,
	94	u8 *val, u8 len);
	95	extern int dccp_feat_confirm_recv(struct sock *sk, u8 type, u8 feature,
	96	u8 *val, u8 len);
8ca0d17b	97	extern void dccp_feat_clean(struct dccp_minisock *dmsk);
afe00251	98	extern int dccp_feat_clone(struct sock oldsk, struct sock newsk);
ac75773c	99	extern int dccp_feat_clone_list(struct list_head const , struct list_head );
8ca0d17b	100	extern int dccp_feat_init(struct dccp_minisock *dmsk);
afe00251 AB	101
afe00251 AB	102	#endif /* _DCCP_FEAT_H */