blob: 7a4313887568796546e5382581fa8bca773c1f27 [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 {
Eric Dumazetb0270e92014-04-15 12:58:34 -040039 int (*queue_xmit)(struct sock *sk, struct sk_buff *skb, struct flowi *fl);
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);
Eric Dumazet5d299f32012-08-06 05:09:33 +000042 void (*sk_rx_dst_set)(struct sock *sk, const struct sk_buff *skb);
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080043 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);
Arnaldo Carvalho de Melo850db6b2006-11-27 17:56:43 -020047 u16 net_header_len;
Eric Dumazet67469602012-04-24 07:37:38 +000048 u16 net_frag_header_len;
Arnaldo Carvalho de Melo850db6b2006-11-27 17:56:43 -020049 u16 sockaddr_len;
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080050 int (*setsockopt)(struct sock *sk, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -070051 char __user *optval, unsigned int optlen);
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080052 int (*getsockopt)(struct sock *sk, int level, int optname,
53 char __user *optval, int __user *optlen);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -070054#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -080055 int (*compat_setsockopt)(struct sock *sk,
56 int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -070057 char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -080058 int (*compat_getsockopt)(struct sock *sk,
59 int level, int optname,
60 char __user *optval, int __user *optlen);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -070061#endif
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080062 void (*addr2sockaddr)(struct sock *sk, struct sockaddr *);
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -080063 int (*bind_conflict)(const struct sock *sk,
Alex Copotaacd9282012-04-12 22:21:45 +000064 const struct inet_bind_bucket *tb, bool relax);
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080065};
66
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070067/** inet_connection_sock - INET connection oriented sock
68 *
69 * @icsk_accept_queue: FIFO of established children
70 * @icsk_bind_hash: Bind node
71 * @icsk_timeout: Timeout
72 * @icsk_retransmit_timer: Resend (no ack)
73 * @icsk_rto: Retransmit timeout
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080074 * @icsk_pmtu_cookie Last pmtu seen by socket
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030075 * @icsk_ca_ops Pluggable congestion control hook
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080076 * @icsk_af_ops Operations which are AF_INET{4,6} specific
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030077 * @icsk_ca_state: Congestion control state
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070078 * @icsk_retransmits: Number of unrecovered [RTO] timeouts
79 * @icsk_pending: Scheduled timer event
80 * @icsk_backoff: Backoff
81 * @icsk_syn_retries: Number of allowed SYN (or equivalent) retries
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030082 * @icsk_probes_out: unanswered 0 window probes
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080083 * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options)
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070084 * @icsk_ack: Delayed ACK control data
John Heffner5d424d52006-03-20 17:53:41 -080085 * @icsk_mtup; MTU probing control data
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070086 */
87struct inet_connection_sock {
88 /* inet_sock has to be the first member! */
89 struct inet_sock icsk_inet;
90 struct request_sock_queue icsk_accept_queue;
91 struct inet_bind_bucket *icsk_bind_hash;
92 unsigned long icsk_timeout;
93 struct timer_list icsk_retransmit_timer;
94 struct timer_list icsk_delack_timer;
95 __u32 icsk_rto;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080096 __u32 icsk_pmtu_cookie;
Stephen Hemminger770cfbc2006-01-09 15:56:09 -080097 const struct tcp_congestion_ops *icsk_ca_ops;
98 const struct inet_connection_sock_af_ops *icsk_af_ops;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080099 unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu);
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300100 __u8 icsk_ca_state;
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700101 __u8 icsk_retransmits;
102 __u8 icsk_pending;
103 __u8 icsk_backoff;
104 __u8 icsk_syn_retries;
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300105 __u8 icsk_probes_out;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -0800106 __u16 icsk_ext_hdr_len;
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700107 struct {
108 __u8 pending; /* ACK is pending */
109 __u8 quick; /* Scheduled number of quick acks */
110 __u8 pingpong; /* The session is interactive */
111 __u8 blocked; /* Delayed ACK was blocked by socket lock */
112 __u32 ato; /* Predicted tick of soft clock */
113 unsigned long timeout; /* Currently scheduled timeout */
114 __u32 lrcvtime; /* timestamp of last received data packet */
115 __u16 last_seg_size; /* Size of last incoming segment */
116 __u16 rcv_mss; /* MSS used for delayed ACK decisions */
117 } icsk_ack;
John Heffner5d424d52006-03-20 17:53:41 -0800118 struct {
119 int enabled;
120
121 /* Range of MTUs to search */
122 int search_high;
123 int search_low;
124
125 /* Information on the current probe. */
126 int probe_size;
John Heffner5d424d52006-03-20 17:53:41 -0800127 } icsk_mtup;
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300128 u32 icsk_ca_priv[16];
Jerry Chudca43c72010-08-27 19:13:28 +0000129 u32 icsk_user_timeout;
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300130#define ICSK_CA_PRIV_SIZE (16 * sizeof(u32))
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700131};
132
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700133#define ICSK_TIME_RETRANS 1 /* Retransmit timer */
134#define ICSK_TIME_DACK 2 /* Delayed ack timer */
135#define ICSK_TIME_PROBE0 3 /* Zero window probe timer */
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000136#define ICSK_TIME_EARLY_RETRANS 4 /* Early retransmit timer */
137#define ICSK_TIME_LOSS_PROBE 5 /* Tail loss probe timer */
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700138
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700139static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
140{
141 return (struct inet_connection_sock *)sk;
142}
143
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300144static inline void *inet_csk_ca(const struct sock *sk)
145{
146 return (void *)inet_csk(sk)->icsk_ca_priv;
147}
148
Joe Perches1fd51152013-09-21 10:22:41 -0700149struct sock *inet_csk_clone_lock(const struct sock *sk,
150 const struct request_sock *req,
151 const gfp_t priority);
Arnaldo Carvalho de Melo9f1d2602005-08-09 20:11:24 -0700152
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700153enum inet_csk_ack_state_t {
154 ICSK_ACK_SCHED = 1,
155 ICSK_ACK_TIMER = 2,
Alexey Kuznetsov1ef96962006-09-19 12:52:50 -0700156 ICSK_ACK_PUSHED = 4,
157 ICSK_ACK_PUSHED2 = 8
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700158};
159
Joe Perches1fd51152013-09-21 10:22:41 -0700160void inet_csk_init_xmit_timers(struct sock *sk,
161 void (*retransmit_handler)(unsigned long),
162 void (*delack_handler)(unsigned long),
163 void (*keepalive_handler)(unsigned long));
164void inet_csk_clear_xmit_timers(struct sock *sk);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700165
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700166static inline void inet_csk_schedule_ack(struct sock *sk)
167{
168 inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
169}
170
171static inline int inet_csk_ack_scheduled(const struct sock *sk)
172{
173 return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
174}
175
176static inline void inet_csk_delack_init(struct sock *sk)
177{
178 memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
179}
180
Joe Perches1fd51152013-09-21 10:22:41 -0700181void inet_csk_delete_keepalive_timer(struct sock *sk);
182void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700183
184#ifdef INET_CSK_DEBUG
185extern const char inet_csk_timer_bug_msg[];
186#endif
187
188static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
189{
190 struct inet_connection_sock *icsk = inet_csk(sk);
191
192 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
193 icsk->icsk_pending = 0;
194#ifdef INET_CSK_CLEAR_TIMERS
195 sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
196#endif
197 } else if (what == ICSK_TIME_DACK) {
198 icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
199#ifdef INET_CSK_CLEAR_TIMERS
200 sk_stop_timer(sk, &icsk->icsk_delack_timer);
201#endif
202 }
203#ifdef INET_CSK_DEBUG
204 else {
Stephen Hemmingerd8971fc2005-08-29 22:51:28 -0700205 pr_debug("%s", inet_csk_timer_bug_msg);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700206 }
207#endif
208}
209
210/*
211 * Reset the retransmission timer
212 */
213static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
214 unsigned long when,
215 const unsigned long max_when)
216{
217 struct inet_connection_sock *icsk = inet_csk(sk);
218
219 if (when > max_when) {
220#ifdef INET_CSK_DEBUG
221 pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
222 sk, what, when, current_text_addr());
223#endif
224 when = max_when;
225 }
226
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000227 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0 ||
228 what == ICSK_TIME_EARLY_RETRANS || what == ICSK_TIME_LOSS_PROBE) {
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700229 icsk->icsk_pending = what;
230 icsk->icsk_timeout = jiffies + when;
231 sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
232 } else if (what == ICSK_TIME_DACK) {
233 icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
234 icsk->icsk_ack.timeout = jiffies + when;
235 sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
236 }
237#ifdef INET_CSK_DEBUG
238 else {
Stephen Hemmingerd8971fc2005-08-29 22:51:28 -0700239 pr_debug("%s", inet_csk_timer_bug_msg);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700240 }
241#endif
242}
243
Joe Perches1fd51152013-09-21 10:22:41 -0700244struct sock *inet_csk_accept(struct sock *sk, int flags, int *err);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700245
Joe Perches1fd51152013-09-21 10:22:41 -0700246struct request_sock *inet_csk_search_req(const struct sock *sk,
247 struct request_sock ***prevp,
248 const __be16 rport,
249 const __be32 raddr,
250 const __be32 laddr);
251int inet_csk_bind_conflict(const struct sock *sk,
252 const struct inet_bind_bucket *tb, bool relax);
253int inet_csk_get_port(struct sock *sk, unsigned short snum);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700254
Joe Perches1fd51152013-09-21 10:22:41 -0700255struct dst_entry *inet_csk_route_req(struct sock *sk, struct flowi4 *fl4,
256 const struct request_sock *req);
257struct dst_entry *inet_csk_route_child_sock(struct sock *sk, struct sock *newsk,
David S. Millerba3f7f02012-07-17 14:02:46 -0700258 const struct request_sock *req);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700259
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700260static inline void inet_csk_reqsk_queue_add(struct sock *sk,
261 struct request_sock *req,
262 struct sock *child)
263{
264 reqsk_queue_add(&inet_csk(sk)->icsk_accept_queue, req, sk, child);
265}
266
Joe Perches1fd51152013-09-21 10:22:41 -0700267void inet_csk_reqsk_queue_hash_add(struct sock *sk, struct request_sock *req,
268 unsigned long timeout);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700269
270static inline void inet_csk_reqsk_queue_removed(struct sock *sk,
271 struct request_sock *req)
272{
273 if (reqsk_queue_removed(&inet_csk(sk)->icsk_accept_queue, req) == 0)
274 inet_csk_delete_keepalive_timer(sk);
275}
276
277static inline void inet_csk_reqsk_queue_added(struct sock *sk,
278 const unsigned long timeout)
279{
280 if (reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue) == 0)
281 inet_csk_reset_keepalive_timer(sk, timeout);
282}
283
284static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
285{
286 return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
287}
288
289static inline int inet_csk_reqsk_queue_young(const struct sock *sk)
290{
291 return reqsk_queue_len_young(&inet_csk(sk)->icsk_accept_queue);
292}
293
294static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
295{
296 return reqsk_queue_is_full(&inet_csk(sk)->icsk_accept_queue);
297}
298
299static inline void inet_csk_reqsk_queue_unlink(struct sock *sk,
300 struct request_sock *req,
301 struct request_sock **prev)
302{
303 reqsk_queue_unlink(&inet_csk(sk)->icsk_accept_queue, req, prev);
304}
305
306static inline void inet_csk_reqsk_queue_drop(struct sock *sk,
307 struct request_sock *req,
308 struct request_sock **prev)
309{
310 inet_csk_reqsk_queue_unlink(sk, req, prev);
311 inet_csk_reqsk_queue_removed(sk, req);
312 reqsk_free(req);
313}
314
Joe Perches1fd51152013-09-21 10:22:41 -0700315void inet_csk_reqsk_queue_prune(struct sock *parent,
316 const unsigned long interval,
317 const unsigned long timeout,
318 const unsigned long max_rto);
Arnaldo Carvalho de Meloa019d6f2005-08-09 20:15:09 -0700319
Joe Perches1fd51152013-09-21 10:22:41 -0700320void inet_csk_destroy_sock(struct sock *sk);
321void inet_csk_prepare_forced_close(struct sock *sk);
Arnaldo Carvalho de Melodc40c7b2005-08-23 21:52:58 -0700322
323/*
324 * LISTEN is a special case for poll..
325 */
326static inline unsigned int inet_csk_listen_poll(const struct sock *sk)
327{
328 return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
329 (POLLIN | POLLRDNORM) : 0;
330}
331
Joe Perches1fd51152013-09-21 10:22:41 -0700332int inet_csk_listen_start(struct sock *sk, const int nr_table_entries);
333void inet_csk_listen_stop(struct sock *sk);
Arnaldo Carvalho de Melo295f7322005-08-09 20:11:56 -0700334
Joe Perches1fd51152013-09-21 10:22:41 -0700335void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr);
Arnaldo Carvalho de Meloaf05dc92005-12-13 23:16:04 -0800336
Joe Perches1fd51152013-09-21 10:22:41 -0700337int inet_csk_compat_getsockopt(struct sock *sk, int level, int optname,
338 char __user *optval, int __user *optlen);
339int inet_csk_compat_setsockopt(struct sock *sk, int level, int optname,
340 char __user *optval, unsigned int optlen);
David S. Miller80d0a692012-07-16 03:28:06 -0700341
Joe Perches1fd51152013-09-21 10:22:41 -0700342struct dst_entry *inet_csk_update_pmtu(struct sock *sk, u32 mtu);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700343#endif /* _INET_CONNECTION_SOCK_H */