[net-next-2.6.git] / include / net / inet_connection_sock.h

/*
 * NET		Generic infrastructure for INET connection oriented protocols.
 *
 *		Definitions for inet_connection_sock 
 *
 * Authors:	Many people, see the TCP sources
 *
 * 		From code originally in TCP
 *
 *		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 _INET_CONNECTION_SOCK_H
#define _INET_CONNECTION_SOCK_H

#include <linux/ip.h>
#include <linux/string.h>
#include <linux/timer.h>
#include <net/request_sock.h>

#define INET_CSK_DEBUG 1

/* Cancel timers, when they are not required. */
#undef INET_CSK_CLEAR_TIMERS

struct inet_bind_bucket;
struct inet_hashinfo;
struct tcp_congestion_ops;

/** inet_connection_sock - INET connection oriented sock
 *
 * @icsk_accept_queue:	   FIFO of established children 
 * @icsk_bind_hash:	   Bind node
 * @icsk_timeout:	   Timeout
 * @icsk_retransmit_timer: Resend (no ack)
 * @icsk_rto:		   Retransmit timeout
 * @icsk_ca_ops		   Pluggable congestion control hook
 * @icsk_ca_state:	   Congestion control state
 * @icsk_retransmits:	   Number of unrecovered [RTO] timeouts
 * @icsk_pending:	   Scheduled timer event
 * @icsk_backoff:	   Backoff
 * @icsk_syn_retries:      Number of allowed SYN (or equivalent) retries
 * @icsk_probes_out:	   unanswered 0 window probes
 * @icsk_ack:		   Delayed ACK control data
 */
struct inet_connection_sock {
	/* inet_sock has to be the first member! */
	struct inet_sock	  icsk_inet;
	struct request_sock_queue icsk_accept_queue;
	struct inet_bind_bucket	  *icsk_bind_hash;
	unsigned long		  icsk_timeout;
 	struct timer_list	  icsk_retransmit_timer;
 	struct timer_list	  icsk_delack_timer;
	__u32			  icsk_rto;
	struct tcp_congestion_ops *icsk_ca_ops;
	__u8			  icsk_ca_state;
	__u8			  icsk_retransmits;
	__u8			  icsk_pending;
	__u8			  icsk_backoff;
	__u8			  icsk_syn_retries;
	__u8			  icsk_probes_out;
	/* 2 BYTES HOLE, TRY TO PACK! */
	struct {
		__u8		  pending;	 /* ACK is pending			   */
		__u8		  quick;	 /* Scheduled number of quick acks	   */
		__u8		  pingpong;	 /* The session is interactive		   */
		__u8		  blocked;	 /* Delayed ACK was blocked by socket lock */
		__u32		  ato;		 /* Predicted tick of soft clock	   */
		unsigned long	  timeout;	 /* Currently scheduled timeout		   */
		__u32		  lrcvtime;	 /* timestamp of last received data packet */
		__u16		  last_seg_size; /* Size of last incoming segment	   */
		__u16		  rcv_mss;	 /* MSS used for delayed ACK decisions	   */ 
	} icsk_ack;
	u32			  icsk_ca_priv[16];
#define ICSK_CA_PRIV_SIZE	(16 * sizeof(u32))
};

#define ICSK_TIME_RETRANS	1	/* Retransmit timer */
#define ICSK_TIME_DACK		2	/* Delayed ack timer */
#define ICSK_TIME_PROBE0	3	/* Zero window probe timer */
#define ICSK_TIME_KEEPOPEN	4	/* Keepalive timer */

static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
{
	return (struct inet_connection_sock *)sk;
}

static inline void *inet_csk_ca(const struct sock *sk)
{
	return (void *)inet_csk(sk)->icsk_ca_priv;
}

extern struct sock *inet_csk_clone(struct sock *sk,
				   const struct request_sock *req,
				   const gfp_t priority);

enum inet_csk_ack_state_t {
	ICSK_ACK_SCHED	= 1,
	ICSK_ACK_TIMER  = 2,
	ICSK_ACK_PUSHED = 4
};

extern void inet_csk_init_xmit_timers(struct sock *sk,
				      void (*retransmit_handler)(unsigned long),
				      void (*delack_handler)(unsigned long),
				      void (*keepalive_handler)(unsigned long));
extern void inet_csk_clear_xmit_timers(struct sock *sk);

static inline void inet_csk_schedule_ack(struct sock *sk)
{
	inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
}

static inline int inet_csk_ack_scheduled(const struct sock *sk)
{
	return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
}

static inline void inet_csk_delack_init(struct sock *sk)
{
	memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
}

extern void inet_csk_delete_keepalive_timer(struct sock *sk);
extern void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);

#ifdef INET_CSK_DEBUG
extern const char inet_csk_timer_bug_msg[];
#endif

static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
{
	struct inet_connection_sock *icsk = inet_csk(sk);
	
	if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
		icsk->icsk_pending = 0;
#ifdef INET_CSK_CLEAR_TIMERS
		sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
#endif
	} else if (what == ICSK_TIME_DACK) {
		icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
#ifdef INET_CSK_CLEAR_TIMERS
		sk_stop_timer(sk, &icsk->icsk_delack_timer);
#endif
	}
#ifdef INET_CSK_DEBUG
	else {
		pr_debug("%s", inet_csk_timer_bug_msg);
	}
#endif
}

/*
 *	Reset the retransmission timer
 */
static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
					     unsigned long when,
					     const unsigned long max_when)
{
	struct inet_connection_sock *icsk = inet_csk(sk);

	if (when > max_when) {
#ifdef INET_CSK_DEBUG
		pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
			 sk, what, when, current_text_addr());
#endif
		when = max_when;
	}

	if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
		icsk->icsk_pending = what;
		icsk->icsk_timeout = jiffies + when;
		sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
	} else if (what == ICSK_TIME_DACK) {
		icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
		icsk->icsk_ack.timeout = jiffies + when;
		sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
	}
#ifdef INET_CSK_DEBUG
	else {
		pr_debug("%s", inet_csk_timer_bug_msg);
	}
#endif
}

extern struct sock *inet_csk_accept(struct sock *sk, int flags, int *err);

extern struct request_sock *inet_csk_search_req(const struct sock *sk,
						struct request_sock ***prevp,
						const __u16 rport,
						const __u32 raddr,
						const __u32 laddr);
extern int inet_csk_bind_conflict(const struct sock *sk,
				  const struct inet_bind_bucket *tb);
extern int inet_csk_get_port(struct inet_hashinfo *hashinfo,
			     struct sock *sk, unsigned short snum,
			     int (*bind_conflict)(const struct sock *sk,
						  const struct inet_bind_bucket *tb));

extern struct dst_entry* inet_csk_route_req(struct sock *sk,
					    const struct request_sock *req);

static inline void inet_csk_reqsk_queue_add(struct sock *sk,
					    struct request_sock *req,
					    struct sock *child)
{
	reqsk_queue_add(&inet_csk(sk)->icsk_accept_queue, req, sk, child);
}

extern void inet_csk_reqsk_queue_hash_add(struct sock *sk,
					  struct request_sock *req,
					  unsigned long timeout);

static inline void inet_csk_reqsk_queue_removed(struct sock *sk,
						struct request_sock *req)
{
	if (reqsk_queue_removed(&inet_csk(sk)->icsk_accept_queue, req) == 0)
		inet_csk_delete_keepalive_timer(sk);
}

static inline void inet_csk_reqsk_queue_added(struct sock *sk,
					      const unsigned long timeout)
{
	if (reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue) == 0)
		inet_csk_reset_keepalive_timer(sk, timeout);
}

static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
{
	return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
}

static inline int inet_csk_reqsk_queue_young(const struct sock *sk)
{
	return reqsk_queue_len_young(&inet_csk(sk)->icsk_accept_queue);
}

static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
{
	return reqsk_queue_is_full(&inet_csk(sk)->icsk_accept_queue);
}

static inline void inet_csk_reqsk_queue_unlink(struct sock *sk,
					       struct request_sock *req,
					       struct request_sock **prev)
{
	reqsk_queue_unlink(&inet_csk(sk)->icsk_accept_queue, req, prev);
}

static inline void inet_csk_reqsk_queue_drop(struct sock *sk,
					     struct request_sock *req,
					     struct request_sock **prev)
{
	inet_csk_reqsk_queue_unlink(sk, req, prev);
	inet_csk_reqsk_queue_removed(sk, req);
	reqsk_free(req);
}

extern void inet_csk_reqsk_queue_prune(struct sock *parent,
				       const unsigned long interval,
				       const unsigned long timeout,
				       const unsigned long max_rto);

extern void inet_csk_destroy_sock(struct sock *sk);

/*
 * LISTEN is a special case for poll..
 */
static inline unsigned int inet_csk_listen_poll(const struct sock *sk)
{
	return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
			(POLLIN | POLLRDNORM) : 0;
}

extern int  inet_csk_listen_start(struct sock *sk, const int nr_table_entries);
extern void inet_csk_listen_stop(struct sock *sk);

#endif /* _INET_CONNECTION_SOCK_H */
Commit	Line	Data
463c84b9 ACM	1	/*
	2	* NET Generic infrastructure for INET connection oriented protocols.
	3	*
	4	* Definitions for inet_connection_sock
	5	*
	6	* Authors: Many people, see the TCP sources
	7	*
	8	* From code originally in TCP
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public License
	12	* as published by the Free Software Foundation; either version
	13	* 2 of the License, or (at your option) any later version.
	14	*/
	15	#ifndef _INET_CONNECTION_SOCK_H
	16	#define _INET_CONNECTION_SOCK_H
	17
	18	#include <linux/ip.h>
3f421baa	19	#include <linux/string.h>
463c84b9 ACM	20	#include <linux/timer.h>
	21	#include <net/request_sock.h>
	22
3f421baa ACM	23	#define INET_CSK_DEBUG 1
	24
	25	/* Cancel timers, when they are not required. */
	26	#undef INET_CSK_CLEAR_TIMERS
	27
463c84b9 ACM	28	struct inet_bind_bucket;
463c84b9 ACM	29	struct inet_hashinfo;
6687e988	30	struct tcp_congestion_ops;
463c84b9 ACM	31
	32	/** inet_connection_sock - INET connection oriented sock
	33	*
	34	* @icsk_accept_queue: FIFO of established children
	35	* @icsk_bind_hash: Bind node
	36	* @icsk_timeout: Timeout
	37	* @icsk_retransmit_timer: Resend (no ack)
	38	* @icsk_rto: Retransmit timeout
6687e988 ACM	39	* @icsk_ca_ops Pluggable congestion control hook
6687e988 ACM	40	* @icsk_ca_state: Congestion control state
463c84b9 ACM	41	* @icsk_retransmits: Number of unrecovered [RTO] timeouts
	42	* @icsk_pending: Scheduled timer event
	43	* @icsk_backoff: Backoff
	44	* @icsk_syn_retries: Number of allowed SYN (or equivalent) retries
6687e988	45	* @icsk_probes_out: unanswered 0 window probes
463c84b9 ACM	46	* @icsk_ack: Delayed ACK control data
	47	*/
	48	struct inet_connection_sock {
	49	/* inet_sock has to be the first member! */
	50	struct inet_sock icsk_inet;
	51	struct request_sock_queue icsk_accept_queue;
	52	struct inet_bind_bucket *icsk_bind_hash;
	53	unsigned long icsk_timeout;
	54	struct timer_list icsk_retransmit_timer;
	55	struct timer_list icsk_delack_timer;
	56	__u32 icsk_rto;
6687e988 ACM	57	struct tcp_congestion_ops *icsk_ca_ops;
6687e988 ACM	58	__u8 icsk_ca_state;
463c84b9 ACM	59	__u8 icsk_retransmits;
	60	__u8 icsk_pending;
	61	__u8 icsk_backoff;
	62	__u8 icsk_syn_retries;
6687e988 ACM	63	__u8 icsk_probes_out;
6687e988 ACM	64	/* 2 BYTES HOLE, TRY TO PACK! */
463c84b9 ACM	65	struct {
	66	__u8 pending; /* ACK is pending */
	67	__u8 quick; /* Scheduled number of quick acks */
	68	__u8 pingpong; /* The session is interactive */
	69	__u8 blocked; /* Delayed ACK was blocked by socket lock */
	70	__u32 ato; /* Predicted tick of soft clock */
	71	unsigned long timeout; /* Currently scheduled timeout */
	72	__u32 lrcvtime; /* timestamp of last received data packet */
	73	__u16 last_seg_size; /* Size of last incoming segment */
	74	__u16 rcv_mss; /* MSS used for delayed ACK decisions */
	75	} icsk_ack;
6687e988 ACM	76	u32 icsk_ca_priv[16];
6687e988 ACM	77	#define ICSK_CA_PRIV_SIZE (16 * sizeof(u32))
463c84b9 ACM	78	};
463c84b9 ACM	79
3f421baa ACM	80	#define ICSK_TIME_RETRANS 1 /* Retransmit timer */
	81	#define ICSK_TIME_DACK 2 /* Delayed ack timer */
	82	#define ICSK_TIME_PROBE0 3 /* Zero window probe timer */
	83	#define ICSK_TIME_KEEPOPEN 4 /* Keepalive timer */
	84
463c84b9 ACM	85	static inline struct inet_connection_sock inet_csk(const struct sock sk)
	86	{
	87	return (struct inet_connection_sock *)sk;
	88	}
	89
6687e988 ACM	90	static inline void inet_csk_ca(const struct sock sk)
	91	{
	92	return (void *)inet_csk(sk)->icsk_ca_priv;
	93	}
	94
9f1d2604 ACM	95	extern struct sock inet_csk_clone(struct sock sk,
9f1d2604 ACM	96	const struct request_sock *req,
dd0fc66f	97	const gfp_t priority);
9f1d2604	98
3f421baa ACM	99	enum inet_csk_ack_state_t {
	100	ICSK_ACK_SCHED = 1,
	101	ICSK_ACK_TIMER = 2,
	102	ICSK_ACK_PUSHED = 4
	103	};
	104
463c84b9 ACM	105	extern void inet_csk_init_xmit_timers(struct sock *sk,
	106	void (*retransmit_handler)(unsigned long),
	107	void (*delack_handler)(unsigned long),
	108	void (*keepalive_handler)(unsigned long));
	109	extern void inet_csk_clear_xmit_timers(struct sock *sk);
	110
3f421baa ACM	111	static inline void inet_csk_schedule_ack(struct sock *sk)
	112	{
	113	inet_csk(sk)->icsk_ack.pending \|= ICSK_ACK_SCHED;
	114	}
	115
	116	static inline int inet_csk_ack_scheduled(const struct sock *sk)
	117	{
	118	return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
	119	}
	120
	121	static inline void inet_csk_delack_init(struct sock *sk)
	122	{
	123	memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
	124	}
	125
	126	extern void inet_csk_delete_keepalive_timer(struct sock *sk);
	127	extern void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
	128
	129	#ifdef INET_CSK_DEBUG
	130	extern const char inet_csk_timer_bug_msg[];
	131	#endif
	132
	133	static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
	134	{
	135	struct inet_connection_sock *icsk = inet_csk(sk);
	136
	137	if (what == ICSK_TIME_RETRANS \|\| what == ICSK_TIME_PROBE0) {
	138	icsk->icsk_pending = 0;
	139	#ifdef INET_CSK_CLEAR_TIMERS
	140	sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
	141	#endif
	142	} else if (what == ICSK_TIME_DACK) {
	143	icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
	144	#ifdef INET_CSK_CLEAR_TIMERS
	145	sk_stop_timer(sk, &icsk->icsk_delack_timer);
	146	#endif
	147	}
	148	#ifdef INET_CSK_DEBUG
	149	else {
d8971fcb	150	pr_debug("%s", inet_csk_timer_bug_msg);
3f421baa ACM	151	}
	152	#endif
	153	}
	154
	155	/*
	156	* Reset the retransmission timer
	157	*/
	158	static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
	159	unsigned long when,
	160	const unsigned long max_when)
	161	{
	162	struct inet_connection_sock *icsk = inet_csk(sk);
	163
	164	if (when > max_when) {
	165	#ifdef INET_CSK_DEBUG
	166	pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
	167	sk, what, when, current_text_addr());
	168	#endif
	169	when = max_when;
	170	}
	171
	172	if (what == ICSK_TIME_RETRANS \|\| what == ICSK_TIME_PROBE0) {
	173	icsk->icsk_pending = what;
	174	icsk->icsk_timeout = jiffies + when;
	175	sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
	176	} else if (what == ICSK_TIME_DACK) {
	177	icsk->icsk_ack.pending \|= ICSK_ACK_TIMER;
	178	icsk->icsk_ack.timeout = jiffies + when;
	179	sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
	180	}
	181	#ifdef INET_CSK_DEBUG
	182	else {
d8971fcb	183	pr_debug("%s", inet_csk_timer_bug_msg);
3f421baa ACM	184	}
	185	#endif
	186	}
	187
	188	extern struct sock inet_csk_accept(struct sock sk, int flags, int *err);
	189
463c84b9 ACM	190	extern struct request_sock inet_csk_search_req(const struct sock sk,
	191	struct request_sock ***prevp,
	192	const __u16 rport,
	193	const __u32 raddr,
	194	const __u32 laddr);
971af18b ACM	195	extern int inet_csk_bind_conflict(const struct sock *sk,
971af18b ACM	196	const struct inet_bind_bucket *tb);
463c84b9	197	extern int inet_csk_get_port(struct inet_hashinfo *hashinfo,
971af18b ACM	198	struct sock *sk, unsigned short snum,
	199	int (bind_conflict)(const struct sock sk,
	200	const struct inet_bind_bucket *tb));
463c84b9 ACM	201
	202	extern struct dst_entry* inet_csk_route_req(struct sock *sk,
	203	const struct request_sock *req);
	204
3f421baa ACM	205	static inline void inet_csk_reqsk_queue_add(struct sock *sk,
	206	struct request_sock *req,
	207	struct sock *child)
	208	{
	209	reqsk_queue_add(&inet_csk(sk)->icsk_accept_queue, req, sk, child);
	210	}
	211
	212	extern void inet_csk_reqsk_queue_hash_add(struct sock *sk,
	213	struct request_sock *req,
c2977c22	214	unsigned long timeout);
3f421baa ACM	215
	216	static inline void inet_csk_reqsk_queue_removed(struct sock *sk,
	217	struct request_sock *req)
	218	{
	219	if (reqsk_queue_removed(&inet_csk(sk)->icsk_accept_queue, req) == 0)
	220	inet_csk_delete_keepalive_timer(sk);
	221	}
	222
	223	static inline void inet_csk_reqsk_queue_added(struct sock *sk,
	224	const unsigned long timeout)
	225	{
	226	if (reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue) == 0)
	227	inet_csk_reset_keepalive_timer(sk, timeout);
	228	}
	229
	230	static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
	231	{
	232	return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
	233	}
	234
	235	static inline int inet_csk_reqsk_queue_young(const struct sock *sk)
	236	{
	237	return reqsk_queue_len_young(&inet_csk(sk)->icsk_accept_queue);
	238	}
	239
	240	static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
	241	{
	242	return reqsk_queue_is_full(&inet_csk(sk)->icsk_accept_queue);
	243	}
	244
	245	static inline void inet_csk_reqsk_queue_unlink(struct sock *sk,
	246	struct request_sock *req,
	247	struct request_sock **prev)
	248	{
	249	reqsk_queue_unlink(&inet_csk(sk)->icsk_accept_queue, req, prev);
	250	}
	251
	252	static inline void inet_csk_reqsk_queue_drop(struct sock *sk,
	253	struct request_sock *req,
	254	struct request_sock **prev)
	255	{
	256	inet_csk_reqsk_queue_unlink(sk, req, prev);
	257	inet_csk_reqsk_queue_removed(sk, req);
	258	reqsk_free(req);
	259	}
	260
a019d6fe ACM	261	extern void inet_csk_reqsk_queue_prune(struct sock *parent,
	262	const unsigned long interval,
	263	const unsigned long timeout,
	264	const unsigned long max_rto);
	265
	266	extern void inet_csk_destroy_sock(struct sock *sk);
dc40c7bc ACM	267
	268	/*
	269	* LISTEN is a special case for poll..
	270	*/
	271	static inline unsigned int inet_csk_listen_poll(const struct sock *sk)
	272	{
	273	return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
	274	(POLLIN \| POLLRDNORM) : 0;
	275	}
	276
a019d6fe	277	extern int inet_csk_listen_start(struct sock *sk, const int nr_table_entries);
295f7324 ACM	278	extern void inet_csk_listen_stop(struct sock *sk);
295f7324 ACM	279
463c84b9	280	#endif /* _INET_CONNECTION_SOCK_H */