2 * NET Generic infrastructure for INET connection oriented protocols.
4 * Definitions for inet_connection_sock
6 * Authors: Many people, see the TCP sources
8 * From code originally in TCP
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.
15 #ifndef _INET_CONNECTION_SOCK_H
16 #define _INET_CONNECTION_SOCK_H
18 #include <linux/compiler.h>
19 #include <linux/string.h>
20 #include <linux/timer.h>
22 #include <net/inet_sock.h>
23 #include <net/request_sock.h>
25 #define INET_CSK_DEBUG 1
27 /* Cancel timers, when they are not required. */
28 #undef INET_CSK_CLEAR_TIMERS
30 struct inet_bind_bucket;
32 struct tcp_congestion_ops;
35 * Pointers to address related TCP functions
36 * (i.e. things that depend on the address family)
38 struct inet_connection_sock_af_ops {
39 int (*queue_xmit)(struct sk_buff *skb, int ipfragok);
40 void (*send_check)(struct sock *sk, int len,
42 int (*rebuild_header)(struct sock *sk);
43 int (*conn_request)(struct sock *sk, struct sk_buff *skb);
44 struct sock *(*syn_recv_sock)(struct sock *sk, struct sk_buff *skb,
45 struct request_sock *req,
46 struct dst_entry *dst);
47 int (*remember_stamp)(struct sock *sk);
49 int (*setsockopt)(struct sock *sk, int level, int optname,
50 char __user *optval, int optlen);
51 int (*getsockopt)(struct sock *sk, int level, int optname,
52 char __user *optval, int __user *optlen);
53 void (*addr2sockaddr)(struct sock *sk, struct sockaddr *);
57 /** inet_connection_sock - INET connection oriented sock
59 * @icsk_accept_queue: FIFO of established children
60 * @icsk_bind_hash: Bind node
61 * @icsk_timeout: Timeout
62 * @icsk_retransmit_timer: Resend (no ack)
63 * @icsk_rto: Retransmit timeout
64 * @icsk_pmtu_cookie Last pmtu seen by socket
65 * @icsk_ca_ops Pluggable congestion control hook
66 * @icsk_af_ops Operations which are AF_INET{4,6} specific
67 * @icsk_ca_state: Congestion control state
68 * @icsk_retransmits: Number of unrecovered [RTO] timeouts
69 * @icsk_pending: Scheduled timer event
70 * @icsk_backoff: Backoff
71 * @icsk_syn_retries: Number of allowed SYN (or equivalent) retries
72 * @icsk_probes_out: unanswered 0 window probes
73 * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options)
74 * @icsk_ack: Delayed ACK control data
75 * @icsk_mtup; MTU probing control data
77 struct inet_connection_sock {
78 /* inet_sock has to be the first member! */
79 struct inet_sock icsk_inet;
80 struct request_sock_queue icsk_accept_queue;
81 struct inet_bind_bucket *icsk_bind_hash;
82 unsigned long icsk_timeout;
83 struct timer_list icsk_retransmit_timer;
84 struct timer_list icsk_delack_timer;
86 __u32 icsk_pmtu_cookie;
87 const struct tcp_congestion_ops *icsk_ca_ops;
88 const struct inet_connection_sock_af_ops *icsk_af_ops;
89 unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu);
91 __u8 icsk_retransmits;
94 __u8 icsk_syn_retries;
96 __u16 icsk_ext_hdr_len;
98 __u8 pending; /* ACK is pending */
99 __u8 quick; /* Scheduled number of quick acks */
100 __u8 pingpong; /* The session is interactive */
101 __u8 blocked; /* Delayed ACK was blocked by socket lock */
102 __u32 ato; /* Predicted tick of soft clock */
103 unsigned long timeout; /* Currently scheduled timeout */
104 __u32 lrcvtime; /* timestamp of last received data packet */
105 __u16 last_seg_size; /* Size of last incoming segment */
106 __u16 rcv_mss; /* MSS used for delayed ACK decisions */
111 /* Range of MTUs to search */
115 /* Information on the current probe. */
118 u32 icsk_ca_priv[16];
119 #define ICSK_CA_PRIV_SIZE (16 * sizeof(u32))
122 #define ICSK_TIME_RETRANS 1 /* Retransmit timer */
123 #define ICSK_TIME_DACK 2 /* Delayed ack timer */
124 #define ICSK_TIME_PROBE0 3 /* Zero window probe timer */
125 #define ICSK_TIME_KEEPOPEN 4 /* Keepalive timer */
127 static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
129 return (struct inet_connection_sock *)sk;
132 static inline void *inet_csk_ca(const struct sock *sk)
134 return (void *)inet_csk(sk)->icsk_ca_priv;
137 extern struct sock *inet_csk_clone(struct sock *sk,
138 const struct request_sock *req,
139 const gfp_t priority);
141 enum inet_csk_ack_state_t {
147 extern void inet_csk_init_xmit_timers(struct sock *sk,
148 void (*retransmit_handler)(unsigned long),
149 void (*delack_handler)(unsigned long),
150 void (*keepalive_handler)(unsigned long));
151 extern void inet_csk_clear_xmit_timers(struct sock *sk);
153 static inline void inet_csk_schedule_ack(struct sock *sk)
155 inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
158 static inline int inet_csk_ack_scheduled(const struct sock *sk)
160 return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
163 static inline void inet_csk_delack_init(struct sock *sk)
165 memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
168 extern void inet_csk_delete_keepalive_timer(struct sock *sk);
169 extern void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
171 #ifdef INET_CSK_DEBUG
172 extern const char inet_csk_timer_bug_msg[];
175 static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
177 struct inet_connection_sock *icsk = inet_csk(sk);
179 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
180 icsk->icsk_pending = 0;
181 #ifdef INET_CSK_CLEAR_TIMERS
182 sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
184 } else if (what == ICSK_TIME_DACK) {
185 icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
186 #ifdef INET_CSK_CLEAR_TIMERS
187 sk_stop_timer(sk, &icsk->icsk_delack_timer);
190 #ifdef INET_CSK_DEBUG
192 pr_debug("%s", inet_csk_timer_bug_msg);
198 * Reset the retransmission timer
200 static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
202 const unsigned long max_when)
204 struct inet_connection_sock *icsk = inet_csk(sk);
206 if (when > max_when) {
207 #ifdef INET_CSK_DEBUG
208 pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
209 sk, what, when, current_text_addr());
214 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
215 icsk->icsk_pending = what;
216 icsk->icsk_timeout = jiffies + when;
217 sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
218 } else if (what == ICSK_TIME_DACK) {
219 icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
220 icsk->icsk_ack.timeout = jiffies + when;
221 sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
223 #ifdef INET_CSK_DEBUG
225 pr_debug("%s", inet_csk_timer_bug_msg);
230 extern struct sock *inet_csk_accept(struct sock *sk, int flags, int *err);
232 extern struct request_sock *inet_csk_search_req(const struct sock *sk,
233 struct request_sock ***prevp,
237 extern int inet_csk_bind_conflict(const struct sock *sk,
238 const struct inet_bind_bucket *tb);
239 extern int inet_csk_get_port(struct inet_hashinfo *hashinfo,
240 struct sock *sk, unsigned short snum,
241 int (*bind_conflict)(const struct sock *sk,
242 const struct inet_bind_bucket *tb));
244 extern struct dst_entry* inet_csk_route_req(struct sock *sk,
245 const struct request_sock *req);
247 static inline void inet_csk_reqsk_queue_add(struct sock *sk,
248 struct request_sock *req,
251 reqsk_queue_add(&inet_csk(sk)->icsk_accept_queue, req, sk, child);
254 extern void inet_csk_reqsk_queue_hash_add(struct sock *sk,
255 struct request_sock *req,
256 unsigned long timeout);
258 static inline void inet_csk_reqsk_queue_removed(struct sock *sk,
259 struct request_sock *req)
261 if (reqsk_queue_removed(&inet_csk(sk)->icsk_accept_queue, req) == 0)
262 inet_csk_delete_keepalive_timer(sk);
265 static inline void inet_csk_reqsk_queue_added(struct sock *sk,
266 const unsigned long timeout)
268 if (reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue) == 0)
269 inet_csk_reset_keepalive_timer(sk, timeout);
272 static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
274 return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
277 static inline int inet_csk_reqsk_queue_young(const struct sock *sk)
279 return reqsk_queue_len_young(&inet_csk(sk)->icsk_accept_queue);
282 static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
284 return reqsk_queue_is_full(&inet_csk(sk)->icsk_accept_queue);
287 static inline void inet_csk_reqsk_queue_unlink(struct sock *sk,
288 struct request_sock *req,
289 struct request_sock **prev)
291 reqsk_queue_unlink(&inet_csk(sk)->icsk_accept_queue, req, prev);
294 static inline void inet_csk_reqsk_queue_drop(struct sock *sk,
295 struct request_sock *req,
296 struct request_sock **prev)
298 inet_csk_reqsk_queue_unlink(sk, req, prev);
299 inet_csk_reqsk_queue_removed(sk, req);
303 extern void inet_csk_reqsk_queue_prune(struct sock *parent,
304 const unsigned long interval,
305 const unsigned long timeout,
306 const unsigned long max_rto);
308 extern void inet_csk_destroy_sock(struct sock *sk);
311 * LISTEN is a special case for poll..
313 static inline unsigned int inet_csk_listen_poll(const struct sock *sk)
315 return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
316 (POLLIN | POLLRDNORM) : 0;
319 extern int inet_csk_listen_start(struct sock *sk, const int nr_table_entries);
320 extern void inet_csk_listen_stop(struct sock *sk);
322 extern void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr);
324 #endif /* _INET_CONNECTION_SOCK_H */