]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - include/net/inet_connection_sock.h
Merge branches 'pm-sleep' and 'pm-cpufreq'
[mirror_ubuntu-hirsute-kernel.git] / include / net / inet_connection_sock.h
CommitLineData
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>
14c85021
ACM
19
20#include <net/inet_sock.h>
463c84b9
ACM
21#include <net/request_sock.h>
22
3f421baa
ACM
23/* Cancel timers, when they are not required. */
24#undef INET_CSK_CLEAR_TIMERS
25
463c84b9 26struct inet_bind_bucket;
6687e988 27struct tcp_congestion_ops;
463c84b9 28
8292a17a
ACM
29/*
30 * Pointers to address related TCP functions
31 * (i.e. things that depend on the address family)
32 */
33struct inet_connection_sock_af_ops {
b0270e91 34 int (*queue_xmit)(struct sock *sk, struct sk_buff *skb, struct flowi *fl);
bb296246 35 void (*send_check)(struct sock *sk, struct sk_buff *skb);
8292a17a 36 int (*rebuild_header)(struct sock *sk);
5d299f3d 37 void (*sk_rx_dst_set)(struct sock *sk, const struct sk_buff *skb);
8292a17a 38 int (*conn_request)(struct sock *sk, struct sk_buff *skb);
0c27171e 39 struct sock *(*syn_recv_sock)(const struct sock *sk, struct sk_buff *skb,
8292a17a 40 struct request_sock *req,
5e0724d0
ED
41 struct dst_entry *dst,
42 struct request_sock *req_unhash,
43 bool *own_req);
850db6b8 44 u16 net_header_len;
67469601 45 u16 net_frag_header_len;
850db6b8 46 u16 sockaddr_len;
82695b30 47 int (*setsockopt)(struct sock *sk, int level, int optname,
b7058842 48 char __user *optval, unsigned int optlen);
82695b30 49 int (*getsockopt)(struct sock *sk, int level, int optname,
8292a17a 50 char __user *optval, int __user *optlen);
af01d537 51#ifdef CONFIG_COMPAT
3fdadf7d
DM
52 int (*compat_setsockopt)(struct sock *sk,
53 int level, int optname,
b7058842 54 char __user *optval, unsigned int optlen);
3fdadf7d
DM
55 int (*compat_getsockopt)(struct sock *sk,
56 int level, int optname,
57 char __user *optval, int __user *optlen);
af01d537 58#endif
8292a17a 59 void (*addr2sockaddr)(struct sock *sk, struct sockaddr *);
4fab9071 60 void (*mtu_reduced)(struct sock *sk);
8292a17a
ACM
61};
62
463c84b9
ACM
63/** inet_connection_sock - INET connection oriented sock
64 *
82695b30 65 * @icsk_accept_queue: FIFO of established children
463c84b9
ACM
66 * @icsk_bind_hash: Bind node
67 * @icsk_timeout: Timeout
68 * @icsk_retransmit_timer: Resend (no ack)
69 * @icsk_rto: Retransmit timeout
d83d8461 70 * @icsk_pmtu_cookie Last pmtu seen by socket
6687e988 71 * @icsk_ca_ops Pluggable congestion control hook
8292a17a 72 * @icsk_af_ops Operations which are AF_INET{4,6} specific
734942cc
DW
73 * @icsk_ulp_ops Pluggable ULP control hook
74 * @icsk_ulp_data ULP private data
6dac1523 75 * @icsk_clean_acked Clean acked data hook
61b7c691 76 * @icsk_listen_portaddr_node hash to the portaddr listener hashtable
6687e988 77 * @icsk_ca_state: Congestion control state
463c84b9
ACM
78 * @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
6687e988 82 * @icsk_probes_out: unanswered 0 window probes
d83d8461 83 * @icsk_ext_hdr_len: Network protocol overhead (IP/IPv6 options)
463c84b9 84 * @icsk_ack: Delayed ACK control data
5d424d5a 85 * @icsk_mtup; MTU probing control data
463c84b9
ACM
86 */
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;
d83d8461 96 __u32 icsk_pmtu_cookie;
770cfbcf
SH
97 const struct tcp_congestion_ops *icsk_ca_ops;
98 const struct inet_connection_sock_af_ops *icsk_af_ops;
734942cc 99 const struct tcp_ulp_ops *icsk_ulp_ops;
15a7dea7 100 void __rcu *icsk_ulp_data;
6dac1523 101 void (*icsk_clean_acked)(struct sock *sk, u32 acked_seq);
61b7c691 102 struct hlist_node icsk_listen_portaddr_node;
d83d8461 103 unsigned int (*icsk_sync_mss)(struct sock *sk, u32 pmtu);
9f950415
NC
104 __u8 icsk_ca_state:6,
105 icsk_ca_setsockopt:1,
c5c6a8ab 106 icsk_ca_dst_locked:1;
463c84b9
ACM
107 __u8 icsk_retransmits;
108 __u8 icsk_pending;
109 __u8 icsk_backoff;
110 __u8 icsk_syn_retries;
6687e988 111 __u8 icsk_probes_out;
d83d8461 112 __u16 icsk_ext_hdr_len;
463c84b9
ACM
113 struct {
114 __u8 pending; /* ACK is pending */
115 __u8 quick; /* Scheduled number of quick acks */
116 __u8 pingpong; /* The session is interactive */
117 __u8 blocked; /* Delayed ACK was blocked by socket lock */
118 __u32 ato; /* Predicted tick of soft clock */
119 unsigned long timeout; /* Currently scheduled timeout */
120 __u32 lrcvtime; /* timestamp of last received data packet */
121 __u16 last_seg_size; /* Size of last incoming segment */
82695b30 122 __u16 rcv_mss; /* MSS used for delayed ACK decisions */
463c84b9 123 } icsk_ack;
5d424d5a
JH
124 struct {
125 int enabled;
126
127 /* Range of MTUs to search */
128 int search_high;
129 int search_low;
130
131 /* Information on the current probe. */
132 int probe_size;
05cbc0db
FD
133
134 u32 probe_timestamp;
5d424d5a 135 } icsk_mtup;
dca43c75 136 u32 icsk_user_timeout;
b5d721d7 137
78dc70eb
PJ
138 u64 icsk_ca_priv[104 / sizeof(u64)];
139#define ICSK_CA_PRIV_SIZE (13 * sizeof(u64))
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
ND
145#define ICSK_TIME_EARLY_RETRANS 4 /* Early retransmit timer */
146#define ICSK_TIME_LOSS_PROBE 5 /* Tail loss probe timer */
57dde7f7 147#define ICSK_TIME_REO_TIMEOUT 6 /* Reordering timer */
3f421baa 148
463c84b9
ACM
149static inline struct inet_connection_sock *inet_csk(const struct sock *sk)
150{
151 return (struct inet_connection_sock *)sk;
152}
153
6687e988
ACM
154static inline void *inet_csk_ca(const struct sock *sk)
155{
156 return (void *)inet_csk(sk)->icsk_ca_priv;
157}
158
1fd51155
JP
159struct sock *inet_csk_clone_lock(const struct sock *sk,
160 const struct request_sock *req,
161 const gfp_t priority);
9f1d2604 162
3f421baa
ACM
163enum inet_csk_ack_state_t {
164 ICSK_ACK_SCHED = 1,
165 ICSK_ACK_TIMER = 2,
1ef9696c 166 ICSK_ACK_PUSHED = 4,
466466dc
YC
167 ICSK_ACK_PUSHED2 = 8,
168 ICSK_ACK_NOW = 16 /* Send the next ACK immediately (once) */
3f421baa
ACM
169};
170
1fd51155 171void inet_csk_init_xmit_timers(struct sock *sk,
59f379f9
KC
172 void (*retransmit_handler)(struct timer_list *),
173 void (*delack_handler)(struct timer_list *),
174 void (*keepalive_handler)(struct timer_list *));
1fd51155 175void inet_csk_clear_xmit_timers(struct sock *sk);
463c84b9 176
3f421baa
ACM
177static inline void inet_csk_schedule_ack(struct sock *sk)
178{
179 inet_csk(sk)->icsk_ack.pending |= ICSK_ACK_SCHED;
180}
181
182static inline int inet_csk_ack_scheduled(const struct sock *sk)
183{
184 return inet_csk(sk)->icsk_ack.pending & ICSK_ACK_SCHED;
185}
186
187static inline void inet_csk_delack_init(struct sock *sk)
188{
189 memset(&inet_csk(sk)->icsk_ack, 0, sizeof(inet_csk(sk)->icsk_ack));
190}
191
1fd51155
JP
192void inet_csk_delete_keepalive_timer(struct sock *sk);
193void inet_csk_reset_keepalive_timer(struct sock *sk, unsigned long timeout);
3f421baa 194
3f421baa
ACM
195static inline void inet_csk_clear_xmit_timer(struct sock *sk, const int what)
196{
197 struct inet_connection_sock *icsk = inet_csk(sk);
82695b30 198
3f421baa
ACM
199 if (what == ICSK_TIME_RETRANS || what == ICSK_TIME_PROBE0) {
200 icsk->icsk_pending = 0;
201#ifdef INET_CSK_CLEAR_TIMERS
202 sk_stop_timer(sk, &icsk->icsk_retransmit_timer);
203#endif
204 } else if (what == ICSK_TIME_DACK) {
205 icsk->icsk_ack.blocked = icsk->icsk_ack.pending = 0;
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 */
217static 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 ||
57dde7f7
YC
230 what == ICSK_TIME_EARLY_RETRANS || what == ICSK_TIME_LOSS_PROBE ||
231 what == ICSK_TIME_REO_TIMEOUT) {
3f421baa
ACM
232 icsk->icsk_pending = what;
233 icsk->icsk_timeout = jiffies + when;
234 sk_reset_timer(sk, &icsk->icsk_retransmit_timer, icsk->icsk_timeout);
235 } else if (what == ICSK_TIME_DACK) {
236 icsk->icsk_ack.pending |= ICSK_ACK_TIMER;
237 icsk->icsk_ack.timeout = jiffies + when;
238 sk_reset_timer(sk, &icsk->icsk_delack_timer, icsk->icsk_ack.timeout);
03bdfc00
JP
239 } else {
240 pr_debug("inet_csk BUG: unknown timer value\n");
3f421baa 241 }
3f421baa
ACM
242}
243
fcdd1cf4
ED
244static inline unsigned long
245inet_csk_rto_backoff(const struct inet_connection_sock *icsk,
246 unsigned long max_when)
247{
248 u64 when = (u64)icsk->icsk_rto << icsk->icsk_backoff;
249
250 return (unsigned long)min_t(u64, when, max_when);
251}
252
cdfbabfb 253struct sock *inet_csk_accept(struct sock *sk, int flags, int *err, bool kern);
3f421baa 254
1fd51155 255int inet_csk_get_port(struct sock *sk, unsigned short snum);
463c84b9 256
e5895bc6 257struct dst_entry *inet_csk_route_req(const struct sock *sk, struct flowi4 *fl4,
1fd51155 258 const struct request_sock *req);
a2432c4f
ED
259struct dst_entry *inet_csk_route_child_sock(const struct sock *sk,
260 struct sock *newsk,
ba3f7f04 261 const struct request_sock *req);
463c84b9 262
7716682c
ED
263struct sock *inet_csk_reqsk_queue_add(struct sock *sk,
264 struct request_sock *req,
265 struct sock *child);
1fd51155
JP
266void inet_csk_reqsk_queue_hash_add(struct sock *sk, struct request_sock *req,
267 unsigned long timeout);
5e0724d0
ED
268struct sock *inet_csk_complete_hashdance(struct sock *sk, struct sock *child,
269 struct request_sock *req,
270 bool own_req);
3f421baa 271
2feda341 272static inline void inet_csk_reqsk_queue_added(struct sock *sk)
3f421baa 273{
fa76ce73 274 reqsk_queue_added(&inet_csk(sk)->icsk_accept_queue);
3f421baa
ACM
275}
276
277static inline int inet_csk_reqsk_queue_len(const struct sock *sk)
278{
279 return reqsk_queue_len(&inet_csk(sk)->icsk_accept_queue);
280}
281
3f421baa
ACM
282static inline int inet_csk_reqsk_queue_is_full(const struct sock *sk)
283{
ef547f2a 284 return inet_csk_reqsk_queue_len(sk) >= sk->sk_max_ack_backlog;
3f421baa
ACM
285}
286
b357a364 287void inet_csk_reqsk_queue_drop(struct sock *sk, struct request_sock *req);
f03f2e15 288void inet_csk_reqsk_queue_drop_and_put(struct sock *sk, struct request_sock *req);
3f421baa 289
1fd51155
JP
290void inet_csk_destroy_sock(struct sock *sk);
291void inet_csk_prepare_forced_close(struct sock *sk);
dc40c7bc
ACM
292
293/*
294 * LISTEN is a special case for poll..
295 */
ade994f4 296static inline __poll_t inet_csk_listen_poll(const struct sock *sk)
dc40c7bc
ACM
297{
298 return !reqsk_queue_empty(&inet_csk(sk)->icsk_accept_queue) ?
a9a08845 299 (EPOLLIN | EPOLLRDNORM) : 0;
dc40c7bc
ACM
300}
301
f985c65c 302int inet_csk_listen_start(struct sock *sk, int backlog);
1fd51155 303void inet_csk_listen_stop(struct sock *sk);
295f7324 304
1fd51155 305void inet_csk_addr2sockaddr(struct sock *sk, struct sockaddr *uaddr);
af05dc93 306
1fd51155
JP
307int inet_csk_compat_getsockopt(struct sock *sk, int level, int optname,
308 char __user *optval, int __user *optlen);
309int inet_csk_compat_setsockopt(struct sock *sk, int level, int optname,
310 char __user *optval, unsigned int optlen);
80d0a69f 311
1fd51155 312struct dst_entry *inet_csk_update_pmtu(struct sock *sk, u32 mtu);
31954cd8 313
4a41f453 314#define TCP_PINGPONG_THRESH 3
31954cd8
WW
315
316static inline void inet_csk_enter_pingpong_mode(struct sock *sk)
317{
318 inet_csk(sk)->icsk_ack.pingpong = TCP_PINGPONG_THRESH;
319}
320
321static inline void inet_csk_exit_pingpong_mode(struct sock *sk)
322{
323 inet_csk(sk)->icsk_ack.pingpong = 0;
324}
325
326static inline bool inet_csk_in_pingpong_mode(struct sock *sk)
327{
328 return inet_csk(sk)->icsk_ack.pingpong >= TCP_PINGPONG_THRESH;
329}
4a41f453
WW
330
331static inline void inet_csk_inc_pingpong_cnt(struct sock *sk)
332{
333 struct inet_connection_sock *icsk = inet_csk(sk);
334
335 if (icsk->icsk_ack.pingpong < U8_MAX)
336 icsk->icsk_ack.pingpong++;
337}
463c84b9 338#endif /* _INET_CONNECTION_SOCK_H */