Commit | Line | Data |
---|---|---|
2874c5fd | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
463c84b9 ACM |
2 | /* |
3 | * NET Generic infrastructure for INET connection oriented protocols. | |
4 | * | |
5 | * Definitions for inet_connection_sock | |
6 | * | |
7 | * Authors: Many people, see the TCP sources | |
8 | * | |
9 | * From code originally in TCP | |
463c84b9 ACM |
10 | */ |
11 | #ifndef _INET_CONNECTION_SOCK_H | |
12 | #define _INET_CONNECTION_SOCK_H | |
13 | ||
8292a17a | 14 | #include <linux/compiler.h> |
3f421baa | 15 | #include <linux/string.h> |
463c84b9 | 16 | #include <linux/timer.h> |
bd01f843 | 17 | #include <linux/poll.h> |
96d18d82 | 18 | #include <linux/kernel.h> |
a7b75c5a | 19 | #include <linux/sockptr.h> |
14c85021 ACM |
20 | |
21 | #include <net/inet_sock.h> | |
463c84b9 ACM |
22 | #include <net/request_sock.h> |
23 | ||
3f421baa ACM |
24 | /* Cancel timers, when they are not required. */ |
25 | #undef INET_CSK_CLEAR_TIMERS | |
26 | ||
463c84b9 | 27 | struct inet_bind_bucket; |
28044fc1 | 28 | struct inet_bind2_bucket; |
6687e988 | 29 | struct tcp_congestion_ops; |
463c84b9 | 30 | |
8292a17a ACM |
31 | /* |
32 | * Pointers to address related TCP functions | |
33 | * (i.e. things that depend on the address family) | |
34 | */ | |
35 | struct inet_connection_sock_af_ops { | |
b0270e91 | 36 | int (*queue_xmit)(struct sock *sk, struct sk_buff *skb, struct flowi *fl); |
bb296246 | 37 | void (*send_check)(struct sock *sk, struct sk_buff *skb); |
8292a17a | 38 | int (*rebuild_header)(struct sock *sk); |
5d299f3d | 39 | void (*sk_rx_dst_set)(struct sock *sk, const struct sk_buff *skb); |
8292a17a | 40 | int (*conn_request)(struct sock *sk, struct sk_buff *skb); |
0c27171e | 41 | struct sock *(*syn_recv_sock)(const struct sock *sk, struct sk_buff *skb, |
8292a17a | 42 | struct request_sock *req, |
5e0724d0 ED |
43 | struct dst_entry *dst, |
44 | struct request_sock *req_unhash, | |
45 | bool *own_req); | |
850db6b8 | 46 | u16 net_header_len; |
67469601 | 47 | u16 net_frag_header_len; |
850db6b8 | 48 | u16 sockaddr_len; |
82695b30 | 49 | int (*setsockopt)(struct sock *sk, int level, int optname, |
a7b75c5a | 50 | sockptr_t optval, unsigned int optlen); |
82695b30 | 51 | int (*getsockopt)(struct sock *sk, int level, int optname, |
8292a17a ACM |
52 | char __user *optval, int __user *optlen); |
53 | void (*addr2sockaddr)(struct sock *sk, struct sockaddr *); | |
4fab9071 | 54 | void (*mtu_reduced)(struct sock *sk); |
8292a17a ACM |
55 | }; |
56 | ||
463c84b9 ACM |
57 | /** inet_connection_sock - INET connection oriented sock |
58 | * | |
82695b30 | 59 | * @icsk_accept_queue: FIFO of established children |
463c84b9 | 60 | * @icsk_bind_hash: Bind node |
28044fc1 | 61 | * @icsk_bind2_hash: Bind node in the bhash2 table |
463c84b9 ACM |
62 | * @icsk_timeout: Timeout |
63 | * @icsk_retransmit_timer: Resend (no ack) | |
64 | * @icsk_rto: Retransmit timeout | |
d83d8461 | 65 | * @icsk_pmtu_cookie Last pmtu seen by socket |
6687e988 | 66 | * @icsk_ca_ops Pluggable congestion control hook |
8292a17a | 67 | * @icsk_af_ops Operations which are AF_INET{4,6} specific |
734942cc DW |
68 | * @icsk_ulp_ops Pluggable ULP control hook |
69 | * @icsk_ulp_data ULP private data | |
6dac1523 | 70 | * @icsk_clean_acked Clean acked data hook |
6687e988 | 71 | * @icsk_ca_state: Congestion control state |
463c84b9 ACM |
72 | * @icsk_retransmits: Number of unrecovered [RTO] timeouts |
73 | * @icsk_pending: Scheduled timer event | |
74 | * @icsk_backoff: Backoff | |
75 | * @icsk_syn_retries: Number of allowed SYN (or equivalent) retries | |
6687e988 | 76 | * @icsk_probes_out: unanswered 0 window probes |
d83d8461 | 77 | * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options) |
463c84b9 | 78 | * @icsk_ack: Delayed ACK control data |
5d424d5a | 79 | * @icsk_mtup; MTU probing control data |
9d9b1ee0 EC |
80 | * @icsk_probes_tstamp: Probe timestamp (cleared by non-zero window ack) |
81 | * @icsk_user_timeout: TCP_USER_TIMEOUT value | |
463c84b9 ACM |
82 | */ |
83 | struct inet_connection_sock { | |
84 | /* inet_sock has to be the first member! */ | |
85 | struct inet_sock icsk_inet; | |
86 | struct request_sock_queue icsk_accept_queue; | |
87 | struct inet_bind_bucket *icsk_bind_hash; | |
28044fc1 | 88 | struct inet_bind2_bucket *icsk_bind2_hash; |
463c84b9 ACM |
89 | unsigned long icsk_timeout; |
90 | struct timer_list icsk_retransmit_timer; | |
91 | struct timer_list icsk_delack_timer; | |
92 | __u32 icsk_rto; | |
ca584ba0 | 93 | __u32 icsk_rto_min; |
2b8ee4f0 | 94 | __u32 icsk_delack_max; |
d83d8461 | 95 | __u32 icsk_pmtu_cookie; |
770cfbcf SH |
96 | const struct tcp_congestion_ops *icsk_ca_ops; |
97 | const struct inet_connection_sock_af_ops *icsk_af_ops; | |
734942cc | 98 | const struct tcp_ulp_ops *icsk_ulp_ops; |
15a7dea7 | 99 | void __rcu *icsk_ulp_data; |
6dac1523 | 100 | void (*icsk_clean_acked)(struct sock *sk, u32 acked_seq); |
d83d8461 | 101 | unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu); |
8919a9b3 NC |
102 | __u8 icsk_ca_state:5, |
103 | icsk_ca_initialized:1, | |
9f950415 | 104 | icsk_ca_setsockopt:1, |
c5c6a8ab | 105 | icsk_ca_dst_locked:1; |
463c84b9 ACM |
106 | __u8 icsk_retransmits; |
107 | __u8 icsk_pending; | |
108 | __u8 icsk_backoff; | |
109 | __u8 icsk_syn_retries; | |
6687e988 | 110 | __u8 icsk_probes_out; |
d83d8461 | 111 | __u16 icsk_ext_hdr_len; |
463c84b9 ACM |
112 | struct { |
113 | __u8 pending; /* ACK is pending */ | |
114 | __u8 quick; /* Scheduled number of quick acks */ | |
115 | __u8 pingpong; /* The session is interactive */ | |
a37c2134 | 116 | __u8 retry; /* Number of attempts */ |
463c84b9 ACM |
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 */ | |
82695b30 | 121 | __u16 rcv_mss; /* MSS used for delayed ACK decisions */ |
463c84b9 | 122 | } icsk_ack; |
5d424d5a | 123 | struct { |
5d424d5a JH |
124 | /* Range of MTUs to search */ |
125 | int search_high; | |
126 | int search_low; | |
127 | ||
128 | /* Information on the current probe. */ | |
14e8e0f6 NC |
129 | u32 probe_size:31, |
130 | /* Is the MTUP feature enabled for this connection? */ | |
131 | enabled:1; | |
05cbc0db FD |
132 | |
133 | u32 probe_timestamp; | |
5d424d5a | 134 | } icsk_mtup; |
9d9b1ee0 | 135 | u32 icsk_probes_tstamp; |
dca43c75 | 136 | u32 icsk_user_timeout; |
b5d721d7 | 137 | |
78dc70eb | 138 | u64 icsk_ca_priv[104 / sizeof(u64)]; |
3f8ad50a | 139 | #define ICSK_CA_PRIV_SIZE sizeof_field(struct inet_connection_sock, icsk_ca_priv) |
463c84b9 ACM |
140 | }; |
141 | ||
3f421baa ACM |
142 | #define ICSK_TIME_RETRANS 1 /* Retransmit timer */ |
143 | #define ICSK_TIME_DACK 2 /* Delayed ack timer */ | |
144 | #define ICSK_TIME_PROBE0 3 /* Zero window probe timer */ | |
6ba8a3b1 | 145 | #define ICSK_TIME_LOSS_PROBE 5 /* Tail loss probe timer */ |
57dde7f7 | 146 | #define ICSK_TIME_REO_TIMEOUT 6 /* Reordering timer */ |
3f421baa | 147 | |
463c84b9 ACM |
148 | static inline struct inet_connection_sock *inet_csk(const struct sock *sk) |
149 | { | |
150 | return (struct inet_connection_sock *)sk; | |
151 | } | |
152 | ||
6687e988 ACM |
153 | static inline void *inet_csk_ca(const struct sock *sk) |
154 | { | |
155 | return (void *)inet_csk(sk)->icsk_ca_priv; | |
156 | } | |
157 | ||
1fd51155 JP |
158 | struct sock *inet_csk_clone_lock(const struct sock *sk, |
159 | const struct request_sock *req, | |
160 | const gfp_t priority); | |
9f1d2604 | 161 | |
3f421baa ACM |
162 | enum inet_csk_ack_state_t { |
163 | ICSK_ACK_SCHED = 1, | |
164 | ICSK_ACK_TIMER = 2, | |
1ef9696c | 165 | ICSK_ACK_PUSHED = 4, |
466466dc YC |
166 | ICSK_ACK_PUSHED2 = 8, |
167 | ICSK_ACK_NOW = 16 /* Send the next ACK immediately (once) */ | |
3f421baa ACM |
168 | }; |
169 | ||
1fd51155 | 170 | void inet_csk_init_xmit_timers(struct sock *sk, |
59f379f9 KC |
171 | void (*retransmit_handler)(struct timer_list *), |
172 | void (*delack_handler)(struct timer_list *), | |
173 | void (*keepalive_handler)(struct timer_list *)); | |
1fd51155 | 174 | void inet_csk_clear_xmit_timers(struct sock *sk); |
463c84b9 | 175 | |
3f421baa ACM |
176 | static inline void inet_csk_schedule_ack(struct sock *sk) |
177 | { | |
178 | inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED; | |
179 | } | |
180 | ||
181 | static inline int inet_csk_ack_scheduled(const struct sock *sk) | |
182 | { | |
183 | return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED; | |
184 | } | |
185 | ||
186 | static inline void inet_csk_delack_init(struct sock *sk) | |
187 | { | |
188 | memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack)); | |
189 | } | |
190 | ||
1fd51155 JP |
191 | void inet_csk_delete_keepalive_timer(struct sock *sk); |
192 | void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout); | |
3f421baa | 193 | |
3f421baa ACM |
194 | static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what) |
195 | { | |
196 | struct inet_connection_sock *icsk = inet_csk(sk); | |
82695b30 | 197 | |
3f421baa ACM |
198 | if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) { |
199 | icsk->icsk_pending = 0; | |
200 | #ifdef INET_CSK_CLEAR_TIMERS | |
201 | sk_stop_timer(sk, &icsk->icsk_retransmit_timer); | |
202 | #endif | |
203 | } else if (what == ICSK_TIME_DACK) { | |
b6b6d653 | 204 | icsk->icsk_ack.pending = 0; |
a37c2134 | 205 | icsk->icsk_ack.retry = 0; |
3f421baa ACM |
206 | #ifdef INET_CSK_CLEAR_TIMERS |
207 | sk_stop_timer(sk, &icsk->icsk_delack_timer); | |
208 | #endif | |
03bdfc00 JP |
209 | } else { |
210 | pr_debug("inet_csk BUG: unknown timer value\n"); | |
3f421baa | 211 | } |
3f421baa ACM |
212 | } |
213 | ||
214 | /* | |
215 | * Reset the retransmission timer | |
216 | */ | |
217 | static inline void inet_csk_reset_xmit_timer(struct sock *sk, const int what, | |
218 | unsigned long when, | |
219 | const unsigned long max_when) | |
220 | { | |
221 | struct inet_connection_sock *icsk = inet_csk(sk); | |
222 | ||
223 | if (when > max_when) { | |
3f421baa | 224 | pr_debug("reset_xmit_timer: sk=%p %d when=0x%lx, caller=%p\n", |
96d18d82 | 225 | sk, what, when, (void *)_THIS_IP_); |
3f421baa ACM |
226 | when = max_when; |
227 | } | |
228 | ||
6ba8a3b1 | 229 | if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0 || |
a05a7280 | 230 | what == ICSK_TIME_LOSS_PROBE || what == ICSK_TIME_REO_TIMEOUT) { |
3f421baa ACM |
231 | icsk->icsk_pending = what; |
232 | icsk->icsk_timeout = jiffies + when; | |
233 | sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout); | |
234 | } else if (what == ICSK_TIME_DACK) { | |
235 | icsk->icsk_ack.pending |= ICSK_ACK_TIMER; | |
236 | icsk->icsk_ack.timeout = jiffies + when; | |
237 | sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout); | |
03bdfc00 JP |
238 | } else { |
239 | pr_debug("inet_csk BUG: unknown timer value\n"); | |
3f421baa | 240 | } |
3f421baa ACM |
241 | } |
242 | ||
fcdd1cf4 ED |
243 | static inline unsigned long |
244 | inet_csk_rto_backoff(const struct inet_connection_sock *icsk, | |
245 | unsigned long max_when) | |
246 | { | |
247 | u64 when = (u64)icsk->icsk_rto << icsk->icsk_backoff; | |
248 | ||
249 | return (unsigned long)min_t(u64, when, max_when); | |
250 | } | |
251 | ||
cdfbabfb | 252 | struct sock *inet_csk_accept(struct sock *sk, int flags, int *err, bool kern); |
3f421baa | 253 | |
1fd51155 | 254 | int inet_csk_get_port(struct sock *sk, unsigned short snum); |
463c84b9 | 255 | |
e5895bc6 | 256 | struct dst_entry *inet_csk_route_req(const struct sock *sk, struct flowi4 *fl4, |
1fd51155 | 257 | const struct request_sock *req); |
a2432c4f ED |
258 | struct dst_entry *inet_csk_route_child_sock(const struct sock *sk, |
259 | struct sock *newsk, | |
ba3f7f04 | 260 | const struct request_sock *req); |
463c84b9 | 261 | |
7716682c ED |
262 | struct sock *inet_csk_reqsk_queue_add(struct sock *sk, |
263 | struct request_sock *req, | |
264 | struct sock *child); | |
1fd51155 JP |
265 | void inet_csk_reqsk_queue_hash_add(struct sock *sk, struct request_sock *req, |
266 | unsigned long timeout); | |
5e0724d0 ED |
267 | struct sock *inet_csk_complete_hashdance(struct sock *sk, struct sock *child, |
268 | struct request_sock *req, | |
269 | bool own_req); | |
3f421baa | 270 | |
2feda341 | 271 | static inline void inet_csk_reqsk_queue_added(struct sock *sk) |
3f421baa | 272 | { |
fa76ce73 | 273 | reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue); |
3f421baa ACM |
274 | } |
275 | ||
276 | static inline int inet_csk_reqsk_queue_len(const struct sock *sk) | |
277 | { | |
278 | return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue); | |
279 | } | |
280 | ||
3f421baa ACM |
281 | static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk) |
282 | { | |
ef547f2a | 283 | return inet_csk_reqsk_queue_len(sk) >= sk->sk_max_ack_backlog; |
3f421baa ACM |
284 | } |
285 | ||
7233da86 | 286 | bool inet_csk_reqsk_queue_drop(struct sock *sk, struct request_sock *req); |
f03f2e15 | 287 | void inet_csk_reqsk_queue_drop_and_put(struct sock *sk, struct request_sock *req); |
3f421baa | 288 | |
5903123f AK |
289 | static inline unsigned long |
290 | reqsk_timeout(struct request_sock *req, unsigned long max_timeout) | |
291 | { | |
292 | u64 timeout = (u64)req->timeout << req->num_timeout; | |
293 | ||
294 | return (unsigned long)min_t(u64, timeout, max_timeout); | |
295 | } | |
296 | ||
2f8a397d PA |
297 | static inline void inet_csk_prepare_for_destroy_sock(struct sock *sk) |
298 | { | |
299 | /* The below has to be done to allow calling inet_csk_destroy_sock */ | |
300 | sock_set_flag(sk, SOCK_DEAD); | |
19757ceb | 301 | this_cpu_inc(*sk->sk_prot->orphan_count); |
2f8a397d PA |
302 | } |
303 | ||
1fd51155 JP |
304 | void inet_csk_destroy_sock(struct sock *sk); |
305 | void inet_csk_prepare_forced_close(struct sock *sk); | |
dc40c7bc ACM |
306 | |
307 | /* | |
308 | * LISTEN is a special case for poll.. | |
309 | */ | |
ade994f4 | 310 | static inline __poll_t inet_csk_listen_poll(const struct sock *sk) |
dc40c7bc ACM |
311 | { |
312 | return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ? | |
a9a08845 | 313 | (EPOLLIN | EPOLLRDNORM) : 0; |
dc40c7bc ACM |
314 | } |
315 | ||
e7049395 | 316 | int inet_csk_listen_start(struct sock *sk); |
1fd51155 | 317 | void inet_csk_listen_stop(struct sock *sk); |
295f7324 | 318 | |
1fd51155 | 319 | void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr); |
af05dc93 | 320 | |
62ffc589 TF |
321 | /* update the fast reuse flag when adding a socket */ |
322 | void inet_csk_update_fastreuse(struct inet_bind_bucket *tb, | |
323 | struct sock *sk); | |
324 | ||
1fd51155 | 325 | struct dst_entry *inet_csk_update_pmtu(struct sock *sk, u32 mtu); |
31954cd8 | 326 | |
4d8f24ee | 327 | #define TCP_PINGPONG_THRESH 1 |
31954cd8 WW |
328 | |
329 | static inline void inet_csk_enter_pingpong_mode(struct sock *sk) | |
330 | { | |
331 | inet_csk(sk)->icsk_ack.pingpong = TCP_PINGPONG_THRESH; | |
332 | } | |
333 | ||
334 | static inline void inet_csk_exit_pingpong_mode(struct sock *sk) | |
335 | { | |
336 | inet_csk(sk)->icsk_ack.pingpong = 0; | |
337 | } | |
338 | ||
339 | static inline bool inet_csk_in_pingpong_mode(struct sock *sk) | |
340 | { | |
341 | return inet_csk(sk)->icsk_ack.pingpong >= TCP_PINGPONG_THRESH; | |
342 | } | |
4a41f453 | 343 | |
7b70973d LB |
344 | static inline bool inet_csk_has_ulp(struct sock *sk) |
345 | { | |
346 | return inet_sk(sk)->is_icsk && !!inet_csk(sk)->icsk_ulp_ops; | |
347 | } | |
348 | ||
463c84b9 | 349 | #endif /* _INET_CONNECTION_SOCK_H */ |