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>
21 #include <linux/poll.h>
23 #include <net/inet_sock.h>
24 #include <net/request_sock.h>
26 #define INET_CSK_DEBUG 1
28 /* Cancel timers, when they are not required. */
29 #undef INET_CSK_CLEAR_TIMERS
31 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
);
40 void (*send_check
)(struct sock
*sk
, struct sk_buff
*skb
);
41 int (*rebuild_header
)(struct sock
*sk
);
42 int (*conn_request
)(struct sock
*sk
, struct sk_buff
*skb
);
43 struct sock
*(*syn_recv_sock
)(struct sock
*sk
, struct sk_buff
*skb
,
44 struct request_sock
*req
,
45 struct dst_entry
*dst
);
46 struct inet_peer
*(*get_peer
)(struct sock
*sk
, bool *release_it
);
49 int (*setsockopt
)(struct sock
*sk
, int level
, int optname
,
50 char __user
*optval
, unsigned int optlen
);
51 int (*getsockopt
)(struct sock
*sk
, int level
, int optname
,
52 char __user
*optval
, int __user
*optlen
);
54 int (*compat_setsockopt
)(struct sock
*sk
,
55 int level
, int optname
,
56 char __user
*optval
, unsigned int optlen
);
57 int (*compat_getsockopt
)(struct sock
*sk
,
58 int level
, int optname
,
59 char __user
*optval
, int __user
*optlen
);
61 void (*addr2sockaddr
)(struct sock
*sk
, struct sockaddr
*);
62 int (*bind_conflict
)(const struct sock
*sk
,
63 const struct inet_bind_bucket
*tb
);
66 /** inet_connection_sock - INET connection oriented sock
68 * @icsk_accept_queue: FIFO of established children
69 * @icsk_bind_hash: Bind node
70 * @icsk_timeout: Timeout
71 * @icsk_retransmit_timer: Resend (no ack)
72 * @icsk_rto: Retransmit timeout
73 * @icsk_pmtu_cookie Last pmtu seen by socket
74 * @icsk_ca_ops Pluggable congestion control hook
75 * @icsk_af_ops Operations which are AF_INET{4,6} specific
76 * @icsk_ca_state: Congestion control state
77 * @icsk_retransmits: Number of unrecovered [RTO] timeouts
78 * @icsk_pending: Scheduled timer event
79 * @icsk_backoff: Backoff
80 * @icsk_syn_retries: Number of allowed SYN (or equivalent) retries
81 * @icsk_probes_out: unanswered 0 window probes
82 * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options)
83 * @icsk_ack: Delayed ACK control data
84 * @icsk_mtup; MTU probing control data
86 struct inet_connection_sock
{
87 /* inet_sock has to be the first member! */
88 struct inet_sock icsk_inet
;
89 struct request_sock_queue icsk_accept_queue
;
90 struct inet_bind_bucket
*icsk_bind_hash
;
91 unsigned long icsk_timeout
;
92 struct timer_list icsk_retransmit_timer
;
93 struct timer_list icsk_delack_timer
;
95 __u32 icsk_pmtu_cookie
;
96 const struct tcp_congestion_ops
*icsk_ca_ops
;
97 const struct inet_connection_sock_af_ops
*icsk_af_ops
;
98 unsigned int (*icsk_sync_mss
)(struct sock
*sk
, u32 pmtu
);
100 __u8 icsk_retransmits
;
103 __u8 icsk_syn_retries
;
104 __u8 icsk_probes_out
;
105 __u16 icsk_ext_hdr_len
;
107 __u8 pending
; /* ACK is pending */
108 __u8 quick
; /* Scheduled number of quick acks */
109 __u8 pingpong
; /* The session is interactive */
110 __u8 blocked
; /* Delayed ACK was blocked by socket lock */
111 __u32 ato
; /* Predicted tick of soft clock */
112 unsigned long timeout
; /* Currently scheduled timeout */
113 __u32 lrcvtime
; /* timestamp of last received data packet */
114 __u16 last_seg_size
; /* Size of last incoming segment */
115 __u16 rcv_mss
; /* MSS used for delayed ACK decisions */
120 /* Range of MTUs to search */
124 /* Information on the current probe. */
127 u32 icsk_ca_priv
[16];
128 u32 icsk_user_timeout
;
129 #define ICSK_CA_PRIV_SIZE (16 * sizeof(u32))
132 #define ICSK_TIME_RETRANS 1 /* Retransmit timer */
133 #define ICSK_TIME_DACK 2 /* Delayed ack timer */
134 #define ICSK_TIME_PROBE0 3 /* Zero window probe timer */
136 static inline struct inet_connection_sock
*inet_csk(const struct sock
*sk
)
138 return (struct inet_connection_sock
*)sk
;
141 static inline void *inet_csk_ca(const struct sock
*sk
)
143 return (void *)inet_csk(sk
)->icsk_ca_priv
;
146 extern struct sock
*inet_csk_clone(struct sock
*sk
,
147 const struct request_sock
*req
,
148 const gfp_t priority
);
150 enum inet_csk_ack_state_t
{
157 extern void inet_csk_init_xmit_timers(struct sock
*sk
,
158 void (*retransmit_handler
)(unsigned long),
159 void (*delack_handler
)(unsigned long),
160 void (*keepalive_handler
)(unsigned long));
161 extern void inet_csk_clear_xmit_timers(struct sock
*sk
);
163 static inline void inet_csk_schedule_ack(struct sock
*sk
)
165 inet_csk(sk
)->icsk_ack
.pending
|= ICSK_ACK_SCHED
;
168 static inline int inet_csk_ack_scheduled(const struct sock
*sk
)
170 return inet_csk(sk
)->icsk_ack
.pending
& ICSK_ACK_SCHED
;
173 static inline void inet_csk_delack_init(struct sock
*sk
)
175 memset(&inet_csk(sk
)->icsk_ack
, 0, sizeof(inet_csk(sk
)->icsk_ack
));
178 extern void inet_csk_delete_keepalive_timer(struct sock
*sk
);
179 extern void inet_csk_reset_keepalive_timer(struct sock
*sk
, unsigned long timeout
);
181 #ifdef INET_CSK_DEBUG
182 extern const char inet_csk_timer_bug_msg
[];
185 static inline void inet_csk_clear_xmit_timer(struct sock
*sk
, const int what
)
187 struct inet_connection_sock
*icsk
= inet_csk(sk
);
189 if (what
== ICSK_TIME_RETRANS
|| what
== ICSK_TIME_PROBE0
) {
190 icsk
->icsk_pending
= 0;
191 #ifdef INET_CSK_CLEAR_TIMERS
192 sk_stop_timer(sk
, &icsk
->icsk_retransmit_timer
);
194 } else if (what
== ICSK_TIME_DACK
) {
195 icsk
->icsk_ack
.blocked
= icsk
->icsk_ack
.pending
= 0;
196 #ifdef INET_CSK_CLEAR_TIMERS
197 sk_stop_timer(sk
, &icsk
->icsk_delack_timer
);
200 #ifdef INET_CSK_DEBUG
202 pr_debug("%s", inet_csk_timer_bug_msg
);
208 * Reset the retransmission timer
210 static inline void inet_csk_reset_xmit_timer(struct sock
*sk
, const int what
,
212 const unsigned long max_when
)
214 struct inet_connection_sock
*icsk
= inet_csk(sk
);
216 if (when
> max_when
) {
217 #ifdef INET_CSK_DEBUG
218 pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
219 sk
, what
, when
, current_text_addr());
224 if (what
== ICSK_TIME_RETRANS
|| what
== ICSK_TIME_PROBE0
) {
225 icsk
->icsk_pending
= what
;
226 icsk
->icsk_timeout
= jiffies
+ when
;
227 sk_reset_timer(sk
, &icsk
->icsk_retransmit_timer
, icsk
->icsk_timeout
);
228 } else if (what
== ICSK_TIME_DACK
) {
229 icsk
->icsk_ack
.pending
|= ICSK_ACK_TIMER
;
230 icsk
->icsk_ack
.timeout
= jiffies
+ when
;
231 sk_reset_timer(sk
, &icsk
->icsk_delack_timer
, icsk
->icsk_ack
.timeout
);
233 #ifdef INET_CSK_DEBUG
235 pr_debug("%s", inet_csk_timer_bug_msg
);
240 extern struct sock
*inet_csk_accept(struct sock
*sk
, int flags
, int *err
);
242 extern struct request_sock
*inet_csk_search_req(const struct sock
*sk
,
243 struct request_sock
***prevp
,
247 extern int inet_csk_bind_conflict(const struct sock
*sk
,
248 const struct inet_bind_bucket
*tb
);
249 extern int inet_csk_get_port(struct sock
*sk
, unsigned short snum
);
251 extern struct dst_entry
* inet_csk_route_req(struct sock
*sk
,
252 const struct request_sock
*req
);
254 static inline void inet_csk_reqsk_queue_add(struct sock
*sk
,
255 struct request_sock
*req
,
258 reqsk_queue_add(&inet_csk(sk
)->icsk_accept_queue
, req
, sk
, child
);
261 extern void inet_csk_reqsk_queue_hash_add(struct sock
*sk
,
262 struct request_sock
*req
,
263 unsigned long timeout
);
265 static inline void inet_csk_reqsk_queue_removed(struct sock
*sk
,
266 struct request_sock
*req
)
268 if (reqsk_queue_removed(&inet_csk(sk
)->icsk_accept_queue
, req
) == 0)
269 inet_csk_delete_keepalive_timer(sk
);
272 static inline void inet_csk_reqsk_queue_added(struct sock
*sk
,
273 const unsigned long timeout
)
275 if (reqsk_queue_added(&inet_csk(sk
)->icsk_accept_queue
) == 0)
276 inet_csk_reset_keepalive_timer(sk
, timeout
);
279 static inline int inet_csk_reqsk_queue_len(const struct sock
*sk
)
281 return reqsk_queue_len(&inet_csk(sk
)->icsk_accept_queue
);
284 static inline int inet_csk_reqsk_queue_young(const struct sock
*sk
)
286 return reqsk_queue_len_young(&inet_csk(sk
)->icsk_accept_queue
);
289 static inline int inet_csk_reqsk_queue_is_full(const struct sock
*sk
)
291 return reqsk_queue_is_full(&inet_csk(sk
)->icsk_accept_queue
);
294 static inline void inet_csk_reqsk_queue_unlink(struct sock
*sk
,
295 struct request_sock
*req
,
296 struct request_sock
**prev
)
298 reqsk_queue_unlink(&inet_csk(sk
)->icsk_accept_queue
, req
, prev
);
301 static inline void inet_csk_reqsk_queue_drop(struct sock
*sk
,
302 struct request_sock
*req
,
303 struct request_sock
**prev
)
305 inet_csk_reqsk_queue_unlink(sk
, req
, prev
);
306 inet_csk_reqsk_queue_removed(sk
, req
);
310 extern void inet_csk_reqsk_queue_prune(struct sock
*parent
,
311 const unsigned long interval
,
312 const unsigned long timeout
,
313 const unsigned long max_rto
);
315 extern void inet_csk_destroy_sock(struct sock
*sk
);
318 * LISTEN is a special case for poll..
320 static inline unsigned int inet_csk_listen_poll(const struct sock
*sk
)
322 return !reqsk_queue_empty(&inet_csk(sk
)->icsk_accept_queue
) ?
323 (POLLIN
| POLLRDNORM
) : 0;
326 extern int inet_csk_listen_start(struct sock
*sk
, const int nr_table_entries
);
327 extern void inet_csk_listen_stop(struct sock
*sk
);
329 extern void inet_csk_addr2sockaddr(struct sock
*sk
, struct sockaddr
*uaddr
);
331 extern int inet_csk_compat_getsockopt(struct sock
*sk
, int level
, int optname
,
332 char __user
*optval
, int __user
*optlen
);
333 extern int inet_csk_compat_setsockopt(struct sock
*sk
, int level
, int optname
,
334 char __user
*optval
, unsigned int optlen
);
335 #endif /* _INET_CONNECTION_SOCK_H */