blob: 49dcad4fe99e0ad5de491ef0e0675a3b516aabca [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);
Eric Dumazet0c271712015-09-29 07:42:48 -070044 struct sock *(*syn_recv_sock)(const struct sock *sk, struct sk_buff *skb,
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080045 struct request_sock *req,
Eric Dumazet5e0724d2015-10-22 08:20:46 -070046 struct dst_entry *dst,
47 struct request_sock *req_unhash,
48 bool *own_req);
Arnaldo Carvalho de Melo850db6b2006-11-27 17:56:43 -020049 u16 net_header_len;
Eric Dumazet67469602012-04-24 07:37:38 +000050 u16 net_frag_header_len;
Arnaldo Carvalho de Melo850db6b2006-11-27 17:56:43 -020051 u16 sockaddr_len;
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080052 int (*setsockopt)(struct sock *sk, int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -070053 char __user *optval, unsigned int optlen);
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080054 int (*getsockopt)(struct sock *sk, int level, int optname,
55 char __user *optval, int __user *optlen);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -070056#ifdef CONFIG_COMPAT
Dmitry Mishin3fdadf72006-03-20 22:45:21 -080057 int (*compat_setsockopt)(struct sock *sk,
58 int level, int optname,
David S. Millerb7058842009-09-30 16:12:20 -070059 char __user *optval, unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -080060 int (*compat_getsockopt)(struct sock *sk,
61 int level, int optname,
62 char __user *optval, int __user *optlen);
Alexey Dobriyanaf01d532008-08-28 02:53:51 -070063#endif
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080064 void (*addr2sockaddr)(struct sock *sk, struct sockaddr *);
Arnaldo Carvalho de Meloab1e0a12008-02-03 04:06:04 -080065 int (*bind_conflict)(const struct sock *sk,
Alex Copotaacd9282012-04-12 22:21:45 +000066 const struct inet_bind_bucket *tb, bool relax);
Neal Cardwell4fab9072014-08-14 12:40:05 -040067 void (*mtu_reduced)(struct sock *sk);
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080068};
69
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070070/** inet_connection_sock - INET connection oriented sock
71 *
72 * @icsk_accept_queue: FIFO of established children
73 * @icsk_bind_hash: Bind node
74 * @icsk_timeout: Timeout
75 * @icsk_retransmit_timer: Resend (no ack)
76 * @icsk_rto: Retransmit timeout
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080077 * @icsk_pmtu_cookie Last pmtu seen by socket
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030078 * @icsk_ca_ops Pluggable congestion control hook
Arnaldo Carvalho de Melo8292a172005-12-13 23:15:52 -080079 * @icsk_af_ops Operations which are AF_INET{4,6} specific
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030080 * @icsk_ca_state: Congestion control state
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070081 * @icsk_retransmits: Number of unrecovered [RTO] timeouts
82 * @icsk_pending: Scheduled timer event
83 * @icsk_backoff: Backoff
84 * @icsk_syn_retries: Number of allowed SYN (or equivalent) retries
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -030085 * @icsk_probes_out: unanswered 0 window probes
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080086 * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options)
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070087 * @icsk_ack: Delayed ACK control data
John Heffner5d424d52006-03-20 17:53:41 -080088 * @icsk_mtup; MTU probing control data
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -070089 */
90struct inet_connection_sock {
91 /* inet_sock has to be the first member! */
92 struct inet_sock icsk_inet;
93 struct request_sock_queue icsk_accept_queue;
94 struct inet_bind_bucket *icsk_bind_hash;
95 unsigned long icsk_timeout;
96 struct timer_list icsk_retransmit_timer;
97 struct timer_list icsk_delack_timer;
98 __u32 icsk_rto;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -080099 __u32 icsk_pmtu_cookie;
Stephen Hemminger770cfbc2006-01-09 15:56:09 -0800100 const struct tcp_congestion_ops *icsk_ca_ops;
101 const struct inet_connection_sock_af_ops *icsk_af_ops;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -0800102 unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu);
Neal Cardwell9f950412015-05-29 13:47:07 -0400103 __u8 icsk_ca_state:6,
104 icsk_ca_setsockopt:1,
Daniel Borkmannc5c6a8a2015-01-05 23:57:46 +0100105 icsk_ca_dst_locked:1;
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700106 __u8 icsk_retransmits;
107 __u8 icsk_pending;
108 __u8 icsk_backoff;
109 __u8 icsk_syn_retries;
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300110 __u8 icsk_probes_out;
Arnaldo Carvalho de Melod83d8462005-12-13 23:26:10 -0800111 __u16 icsk_ext_hdr_len;
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700112 struct {
113 __u8 pending; /* ACK is pending */
114 __u8 quick; /* Scheduled number of quick acks */
115 __u8 pingpong; /* The session is interactive */
116 __u8 blocked; /* Delayed ACK was blocked by socket lock */
117 __u32 ato; /* Predicted tick of soft clock */
118 unsigned long timeout; /* Currently scheduled timeout */
119 __u32 lrcvtime; /* timestamp of last received data packet */
120 __u16 last_seg_size; /* Size of last incoming segment */
121 __u16 rcv_mss; /* MSS used for delayed ACK decisions */
122 } icsk_ack;
John Heffner5d424d52006-03-20 17:53:41 -0800123 struct {
124 int enabled;
125
126 /* Range of MTUs to search */
127 int search_high;
128 int search_low;
129
130 /* Information on the current probe. */
131 int probe_size;
Fan Du05cbc0d2015-03-06 11:18:24 +0800132
133 u32 probe_timestamp;
John Heffner5d424d52006-03-20 17:53:41 -0800134 } icsk_mtup;
Jerry Chudca43c72010-08-27 19:13:28 +0000135 u32 icsk_user_timeout;
Eric Dumazetb5d721d2015-05-18 17:06:14 -0700136
137 u64 icsk_ca_priv[64 / sizeof(u64)];
138#define ICSK_CA_PRIV_SIZE (8 * sizeof(u64))
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700139};
140
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700141#define ICSK_TIME_RETRANS 1 /* Retransmit timer */
142#define ICSK_TIME_DACK 2 /* Delayed ack timer */
143#define ICSK_TIME_PROBE0 3 /* Zero window probe timer */
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000144#define ICSK_TIME_EARLY_RETRANS 4 /* Early retransmit timer */
145#define ICSK_TIME_LOSS_PROBE 5 /* Tail loss probe timer */
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700146
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700147static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
148{
149 return (struct inet_connection_sock *)sk;
150}
151
Arnaldo Carvalho de Melo6687e982005-08-10 04:03:31 -0300152static inline void *inet_csk_ca(const struct sock *sk)
153{
154 return (void *)inet_csk(sk)->icsk_ca_priv;
155}
156
Joe Perches1fd51152013-09-21 10:22:41 -0700157struct sock *inet_csk_clone_lock(const struct sock *sk,
158 const struct request_sock *req,
159 const gfp_t priority);
Arnaldo Carvalho de Melo9f1d2602005-08-09 20:11:24 -0700160
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700161enum inet_csk_ack_state_t {
162 ICSK_ACK_SCHED = 1,
163 ICSK_ACK_TIMER = 2,
Alexey Kuznetsov1ef96962006-09-19 12:52:50 -0700164 ICSK_ACK_PUSHED = 4,
165 ICSK_ACK_PUSHED2 = 8
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700166};
167
Joe Perches1fd51152013-09-21 10:22:41 -0700168void inet_csk_init_xmit_timers(struct sock *sk,
169 void (*retransmit_handler)(unsigned long),
170 void (*delack_handler)(unsigned long),
171 void (*keepalive_handler)(unsigned long));
172void inet_csk_clear_xmit_timers(struct sock *sk);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700173
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700174static inline void inet_csk_schedule_ack(struct sock *sk)
175{
176 inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
177}
178
179static inline int inet_csk_ack_scheduled(const struct sock *sk)
180{
181 return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
182}
183
184static inline void inet_csk_delack_init(struct sock *sk)
185{
186 memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
187}
188
Joe Perches1fd51152013-09-21 10:22:41 -0700189void inet_csk_delete_keepalive_timer(struct sock *sk);
190void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700191
192#ifdef INET_CSK_DEBUG
193extern const char inet_csk_timer_bug_msg[];
194#endif
195
196static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
197{
198 struct inet_connection_sock *icsk = inet_csk(sk);
199
200 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
201 icsk->icsk_pending = 0;
202#ifdef INET_CSK_CLEAR_TIMERS
203 sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
204#endif
205 } else if (what == ICSK_TIME_DACK) {
206 icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
207#ifdef INET_CSK_CLEAR_TIMERS
208 sk_stop_timer(sk, &icsk->icsk_delack_timer);
209#endif
210 }
211#ifdef INET_CSK_DEBUG
212 else {
Stephen Hemmingerd8971fc2005-08-29 22:51:28 -0700213 pr_debug("%s", inet_csk_timer_bug_msg);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700214 }
215#endif
216}
217
218/*
219 * Reset the retransmission timer
220 */
221static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what,
222 unsigned long when,
223 const unsigned long max_when)
224{
225 struct inet_connection_sock *icsk = inet_csk(sk);
226
227 if (when > max_when) {
228#ifdef INET_CSK_DEBUG
229 pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n",
230 sk, what, when, current_text_addr());
231#endif
232 when = max_when;
233 }
234
Nandita Dukkipati6ba8a3b2013-03-11 10:00:43 +0000235 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0 ||
236 what == ICSK_TIME_EARLY_RETRANS || what == ICSK_TIME_LOSS_PROBE) {
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700237 icsk->icsk_pending = what;
238 icsk->icsk_timeout = jiffies + when;
239 sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
240 } else if (what == ICSK_TIME_DACK) {
241 icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
242 icsk->icsk_ack.timeout = jiffies + when;
243 sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
244 }
245#ifdef INET_CSK_DEBUG
246 else {
Stephen Hemmingerd8971fc2005-08-29 22:51:28 -0700247 pr_debug("%s", inet_csk_timer_bug_msg);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700248 }
249#endif
250}
251
Eric Dumazetfcdd1cf2014-09-22 13:19:44 -0700252static inline unsigned long
253inet_csk_rto_backoff(const struct inet_connection_sock *icsk,
254 unsigned long max_when)
255{
256 u64 when = (u64)icsk->icsk_rto << icsk->icsk_backoff;
257
258 return (unsigned long)min_t(u64, when, max_when);
259}
260
Joe Perches1fd51152013-09-21 10:22:41 -0700261struct sock *inet_csk_accept(struct sock *sk, int flags, int *err);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700262
Joe Perches1fd51152013-09-21 10:22:41 -0700263int inet_csk_bind_conflict(const struct sock *sk,
264 const struct inet_bind_bucket *tb, bool relax);
265int inet_csk_get_port(struct sock *sk, unsigned short snum);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700266
Eric Dumazete5895bc2015-09-25 07:39:11 -0700267struct dst_entry *inet_csk_route_req(const struct sock *sk, struct flowi4 *fl4,
Joe Perches1fd51152013-09-21 10:22:41 -0700268 const struct request_sock *req);
Eric Dumazeta2432c42015-09-29 07:42:43 -0700269struct dst_entry *inet_csk_route_child_sock(const struct sock *sk,
270 struct sock *newsk,
David S. Millerba3f7f02012-07-17 14:02:46 -0700271 const struct request_sock *req);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700272
Eric Dumazet77166822016-02-18 05:39:18 -0800273struct sock *inet_csk_reqsk_queue_add(struct sock *sk,
274 struct request_sock *req,
275 struct sock *child);
Joe Perches1fd51152013-09-21 10:22:41 -0700276void inet_csk_reqsk_queue_hash_add(struct sock *sk, struct request_sock *req,
277 unsigned long timeout);
Eric Dumazet5e0724d2015-10-22 08:20:46 -0700278struct sock *inet_csk_complete_hashdance(struct sock *sk, struct sock *child,
279 struct request_sock *req,
280 bool own_req);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700281
Eric Dumazet2feda342015-10-02 11:43:31 -0700282static inline void inet_csk_reqsk_queue_added(struct sock *sk)
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700283{
Eric Dumazetfa76ce732015-03-19 19:04:20 -0700284 reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700285}
286
287static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
288{
289 return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
290}
291
292static inline int inet_csk_reqsk_queue_young(const struct sock *sk)
293{
294 return reqsk_queue_len_young(&inet_csk(sk)->icsk_accept_queue);
295}
296
297static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
298{
Eric Dumazetef547f22015-10-02 11:43:37 -0700299 return inet_csk_reqsk_queue_len(sk) >= sk->sk_max_ack_backlog;
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700300}
301
Eric Dumazetb357a362015-04-23 18:03:44 -0700302void inet_csk_reqsk_queue_drop(struct sock *sk, struct request_sock *req);
Eric Dumazetf03f2e12015-10-14 11:16:27 -0700303void inet_csk_reqsk_queue_drop_and_put(struct sock *sk, struct request_sock *req);
Arnaldo Carvalho de Melo3f421ba2005-08-09 20:11:08 -0700304
Joe Perches1fd51152013-09-21 10:22:41 -0700305void inet_csk_destroy_sock(struct sock *sk);
306void inet_csk_prepare_forced_close(struct sock *sk);
Arnaldo Carvalho de Melodc40c7b2005-08-23 21:52:58 -0700307
308/*
309 * LISTEN is a special case for poll..
310 */
311static inline unsigned int inet_csk_listen_poll(const struct sock *sk)
312{
313 return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
314 (POLLIN | POLLRDNORM) : 0;
315}
316
Eric Dumazetf985c652015-10-14 06:16:49 -0700317int inet_csk_listen_start(struct sock *sk, int backlog);
Joe Perches1fd51152013-09-21 10:22:41 -0700318void inet_csk_listen_stop(struct sock *sk);
Arnaldo Carvalho de Melo295f7322005-08-09 20:11:56 -0700319
Joe Perches1fd51152013-09-21 10:22:41 -0700320void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr);
Arnaldo Carvalho de Meloaf05dc92005-12-13 23:16:04 -0800321
Joe Perches1fd51152013-09-21 10:22:41 -0700322int inet_csk_compat_getsockopt(struct sock *sk, int level, int optname,
323 char __user *optval, int __user *optlen);
324int inet_csk_compat_setsockopt(struct sock *sk, int level, int optname,
325 char __user *optval, unsigned int optlen);
David S. Miller80d0a692012-07-16 03:28:06 -0700326
Joe Perches1fd51152013-09-21 10:22:41 -0700327struct dst_entry *inet_csk_update_pmtu(struct sock *sk, u32 mtu);
Arnaldo Carvalho de Melo463c84b2005-08-09 20:10:42 -0700328#endif /* _INET_CONNECTION_SOCK_H */