blob: e4f494b42e060e1d4309acce8532aaa7f4b036eb [file] [log] [blame]
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -07001/*
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
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080018#include <linux/compiler.h>
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -070019#include <linux/string.h>
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070020#include <linux/timer.h>
Al Virobd01f842006-10-19 17:23:57 -040021#include <linux/poll.h>
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020022
23#include <net/inet_sock.h>
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070024#include <net/request_sock.h>
25
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -070026#define INET_CSK_DEBUG 1
27
28/* Cancel timers, when they are not required. */
29#undef INET_CSK_CLEAR_TIMERS
30
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070031struct inet_bind_bucket;
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030032struct tcp_congestion_ops;
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070033
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080034/*
35 * Pointers to address related TCP functions
36 * (i.e. things that depend on the address family)
37 */
38struct inet_connection_sock_af_ops {
Shan Wei4e15ed42010-04-15 16:43:08 +000039 int (*queue_xmit)(struct sk_buff *skb);
Herbert Xubb296242010-04-11 02:15:55 +000040 void (*send_check)(struct sock *sk, struct sk_buff *skb);
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080041 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 int (*remember_stamp)(struct sock *sk);
Arnaldo Carvalho de Melo850db6b2006-11-27 17:56:43 -020047 u16 net_header_len;
48 u16 sockaddr_len;
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080049 int (*setsockopt)(struct sock *sk, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -070050 char __user *optval, unsigned int optlen);
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080051 int (*getsockopt)(struct sock *sk, int level, int optname,
52 char __user *optval, int __user *optlen);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -070053#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -080054 int (*compat_setsockopt)(struct sock *sk,
55 int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -070056 char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -080057 int (*compat_getsockopt)(struct sock *sk,
58 int level, int optname,
59 char __user *optval, int __user *optlen);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -070060#endif
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080061 void (*addr2sockaddr)(struct sock *sk, struct sockaddr *);
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -080062 int (*bind_conflict)(const struct sock *sk,
63 const struct inet_bind_bucket *tb);
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080064};
65
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070066/** inet_connection_sock - INET connection oriented sock
67 *
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
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080073 * @icsk_pmtu_cookie Last pmtu seen by socket
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030074 * @icsk_ca_ops Pluggable congestion control hook
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080075 * @icsk_af_ops Operations which are AF_INET{4,6} specific
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030076 * @icsk_ca_state: Congestion control state
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070077 * @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
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030081 * @icsk_probes_out: unanswered 0 window probes
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080082 * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options)
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070083 * @icsk_ack: Delayed ACK control data
John Heffner5d424d52006-03-20 17:53:41 -080084 * @icsk_mtup; MTU probing control data
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070085 */
86struct 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;
94 __u32 icsk_rto;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080095 __u32 icsk_pmtu_cookie;
Stephen Hemminger770cfbc2006-01-09 15:56:09 -080096 const struct tcp_congestion_ops *icsk_ca_ops;
97 const struct inet_connection_sock_af_ops *icsk_af_ops;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080098 unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu);
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030099 __u8 icsk_ca_state;
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700100 __u8 icsk_retransmits;
101 __u8 icsk_pending;
102 __u8 icsk_backoff;
103 __u8 icsk_syn_retries;
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300104 __u8 icsk_probes_out;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -0800105 __u16 icsk_ext_hdr_len;
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700106 struct {
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 */
116 } icsk_ack;
John Heffner5d424d52006-03-20 17:53:41 -0800117 struct {
118 int enabled;
119
120 /* Range of MTUs to search */
121 int search_high;
122 int search_low;
123
124 /* Information on the current probe. */
125 int probe_size;
John Heffner5d424d52006-03-20 17:53:41 -0800126 } icsk_mtup;
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300127 u32 icsk_ca_priv[16];
Jerry Chudca43c72010-08-27 19:13:28 +0000128 u32 icsk_user_timeout;
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300129#define ICSK_CA_PRIV_SIZE (16 * sizeof(u32))
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700130};
131
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700132#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 */
135#define ICSK_TIME_KEEPOPEN 4 /* Keepalive timer */
136
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700137static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
138{
139 return (struct inet_connection_sock *)sk;
140}
141
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300142static inline void *inet_csk_ca(const struct sock *sk)
143{
144 return (void *)inet_csk(sk)->icsk_ca_priv;
145}
146
Arnaldo Carvalho de Melo9f1d2602005-08-09 20:11:24 -0700147extern struct sock *inet_csk_clone(struct sock *sk,
148 const struct request_sock *req,
Al Virodd0fc662005-10-07 07:46:04 +0100149 const gfp_t priority);
Arnaldo Carvalho de Melo9f1d2602005-08-09 20:11:24 -0700150
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700151enum inet_csk_ack_state_t {
152 ICSK_ACK_SCHED = 1,
153 ICSK_ACK_TIMER = 2,
Alexey Kuznetsov1ef96962006-09-19 12:52:50 -0700154 ICSK_ACK_PUSHED = 4,
155 ICSK_ACK_PUSHED2 = 8
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700156};
157
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700158extern void inet_csk_init_xmit_timers(struct sock *sk,
159 void (*retransmit_handler)(unsigned long),
160 void (*delack_handler)(unsigned long),
161 void (*keepalive_handler)(unsigned long));
162extern void inet_csk_clear_xmit_timers(struct sock *sk);
163
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700164static inline void inet_csk_schedule_ack(struct sock *sk)
165{
166 inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
167}
168
169static inline int inet_csk_ack_scheduled(const struct sock *sk)
170{
171 return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
172}
173
174static inline void inet_csk_delack_init(struct sock *sk)
175{
176 memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
177}
178
179extern void inet_csk_delete_keepalive_timer(struct sock *sk);
180extern void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
181
182#ifdef INET_CSK_DEBUG
183extern const char inet_csk_timer_bug_msg[];
184#endif
185
186static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
187{
188 struct inet_connection_sock *icsk = inet_csk(sk);
189
190 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
191 icsk->icsk_pending = 0;
192#ifdef INET_CSK_CLEAR_TIMERS
193 sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
194#endif
195 } else if (what == ICSK_TIME_DACK) {
196 icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
197#ifdef INET_CSK_CLEAR_TIMERS
198 sk_stop_timer(sk, &icsk->icsk_delack_timer);
199#endif
200 }
201#ifdef INET_CSK_DEBUG
202 else {
Stephen Hemmingerd8971fc2005-08-29 22:51:28 -0700203 pr_debug("%s", inet_csk_timer_bug_msg);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700204 }
205#endif
206}
207
208/*
209 * Reset the retransmission timer
210 */
211static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
212 unsigned long when,
213 const unsigned long max_when)
214{
215 struct inet_connection_sock *icsk = inet_csk(sk);
216
217 if (when > max_when) {
218#ifdef INET_CSK_DEBUG
219 pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
220 sk, what, when, current_text_addr());
221#endif
222 when = max_when;
223 }
224
225 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
226 icsk->icsk_pending = what;
227 icsk->icsk_timeout = jiffies + when;
228 sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
229 } else if (what == ICSK_TIME_DACK) {
230 icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
231 icsk->icsk_ack.timeout = jiffies + when;
232 sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
233 }
234#ifdef INET_CSK_DEBUG
235 else {
Stephen Hemmingerd8971fc2005-08-29 22:51:28 -0700236 pr_debug("%s", inet_csk_timer_bug_msg);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700237 }
238#endif
239}
240
241extern struct sock *inet_csk_accept(struct sock *sk, int flags, int *err);
242
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700243extern struct request_sock *inet_csk_search_req(const struct sock *sk,
244 struct request_sock ***prevp,
Al Viro6b729772006-09-27 18:36:59 -0700245 const __be16 rport,
Al Viro7f25afb2006-09-27 18:27:47 -0700246 const __be32 raddr,
247 const __be32 laddr);
Arnaldo Carvalho de Melo971af182005-12-13 23:14:47 -0800248extern int inet_csk_bind_conflict(const struct sock *sk,
249 const struct inet_bind_bucket *tb);
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -0800250extern int inet_csk_get_port(struct sock *sk, unsigned short snum);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700251
252extern struct dst_entry* inet_csk_route_req(struct sock *sk,
253 const struct request_sock *req);
254
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700255static inline void inet_csk_reqsk_queue_add(struct sock *sk,
256 struct request_sock *req,
257 struct sock *child)
258{
259 reqsk_queue_add(&inet_csk(sk)->icsk_accept_queue, req, sk, child);
260}
261
262extern void inet_csk_reqsk_queue_hash_add(struct sock *sk,
263 struct request_sock *req,
Arnaldo Carvalho de Meloc2977c22005-12-13 23:15:12 -0800264 unsigned long timeout);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700265
266static inline void inet_csk_reqsk_queue_removed(struct sock *sk,
267 struct request_sock *req)
268{
269 if (reqsk_queue_removed(&inet_csk(sk)->icsk_accept_queue, req) == 0)
270 inet_csk_delete_keepalive_timer(sk);
271}
272
273static inline void inet_csk_reqsk_queue_added(struct sock *sk,
274 const unsigned long timeout)
275{
276 if (reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue) == 0)
277 inet_csk_reset_keepalive_timer(sk, timeout);
278}
279
280static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
281{
282 return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
283}
284
285static inline int inet_csk_reqsk_queue_young(const struct sock *sk)
286{
287 return reqsk_queue_len_young(&inet_csk(sk)->icsk_accept_queue);
288}
289
290static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
291{
292 return reqsk_queue_is_full(&inet_csk(sk)->icsk_accept_queue);
293}
294
295static inline void inet_csk_reqsk_queue_unlink(struct sock *sk,
296 struct request_sock *req,
297 struct request_sock **prev)
298{
299 reqsk_queue_unlink(&inet_csk(sk)->icsk_accept_queue, req, prev);
300}
301
302static inline void inet_csk_reqsk_queue_drop(struct sock *sk,
303 struct request_sock *req,
304 struct request_sock **prev)
305{
306 inet_csk_reqsk_queue_unlink(sk, req, prev);
307 inet_csk_reqsk_queue_removed(sk, req);
308 reqsk_free(req);
309}
310
Arnaldo Carvalho de Meloa019d6f2005-08-09 20:15:09 -0700311extern void inet_csk_reqsk_queue_prune(struct sock *parent,
312 const unsigned long interval,
313 const unsigned long timeout,
314 const unsigned long max_rto);
315
316extern void inet_csk_destroy_sock(struct sock *sk);
Arnaldo Carvalho de Melodc40c7b2005-08-23 21:52:58 -0700317
318/*
319 * LISTEN is a special case for poll..
320 */
321static inline unsigned int inet_csk_listen_poll(const struct sock *sk)
322{
323 return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
324 (POLLIN | POLLRDNORM) : 0;
325}
326
Arnaldo Carvalho de Meloa019d6f2005-08-09 20:15:09 -0700327extern int inet_csk_listen_start(struct sock *sk, const int nr_table_entries);
Arnaldo Carvalho de Melo295f7322005-08-09 20:11:56 -0700328extern void inet_csk_listen_stop(struct sock *sk);
329
Arnaldo Carvalho de Meloaf05dc92005-12-13 23:16:04 -0800330extern void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr);
331
Arnaldo Carvalho de Melodec73ff2006-03-20 22:46:16 -0800332extern int inet_csk_compat_getsockopt(struct sock *sk, int level, int optname,
333 char __user *optval, int __user *optlen);
334extern int inet_csk_compat_setsockopt(struct sock *sk, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -0700335 char __user *optval, unsigned int optlen);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700336#endif /* _INET_CONNECTION_SOCK_H */